README

概要

这是一个从Markdown生成测试项检查列表的工具。

以下是如何将Markdown编写的测试项转换为Excel格式检查列表的示例。

# テスト項目１

## 試験項目

### 試験1

アプリが正常に起動することを確認する

#### 手順

- アプリを起動する
- 「始める」ボタンを押下する。

#### 確認

- [ ] ホーム画面が表示されること
- [ ] ホーム画面にウェルカムメッセージが表示されること

安装方法

可以通过以下三种方式使用。

除了使用Docker的方法外，还需要事先准备php和composer的执行环境。

克隆此存储库以使用

$ git clone https://github.com/kojiro526/php-checklist.git
$ cd php-checklist
$ composer install --no-dev
$ php -q ./bin/checklist-php.php --help

使用composer全局安装以使用

添加路径

在Linux, OSX等情况下，请将以下路径设置到.bash_profile等文件中。

export PATH=$HOME/.composer/vendor/bin:$PATH

在Windows中，请将以下文件夹设置到环境变量PATH中。

%USERPROFILE%\AppData\Roaming\Composer\vendor\bin

安装

$ composer global require kojiro526/php-checklist
$ checklist-php --help

使用Docker

即使没有php的执行环境，也可以通过构建包含在此存储库中的Dockerfile来使用。

$ git clone https://github.com/kojiro526/php-checklist.git
$ cd php-checklist
$ docker build -t kojiro526/php-checklist .
$ docker run --rm kojiro526/php-checklist checklist-php --help

使用方法

基本的使用方法如下。

$ php -q ./bin/checklist-php -i SOURCE_DIR_PATH -o OUTPUT_FILE

如果使用docker，请将包含目标Markdown文档的目录挂载并执行。

$ cd (Markdonドキュメントのあるディレクトリ)
$ docker run --rm -v $(pwd):/work kojiro526/php-checklist checklist-php -i /work -o /work/output.xlsx

在上面的示例中，当前目录被挂载到docker容器内的/work目录，因此命令的参数也指定了容器内的路径。

许可证

本软件是在MIT许可证下发布的。

kojiro526 / php-checklist

维护者

详情