feat(stories2csv): expose cli interface for csv generation

README.md

@@ -6,4 +6,26 @@ A checker and code generation tool for our markdown formatted materials.
 
 ### If you have NodeJS and NPM
 
-`npm install -g https://github.com/green-fox-academy/markdown-tools`
+```shell
+npm install -g https://github.com/green-fox-academy/markdown-tools
+```
+
+or
+
+```shell
+git clone https://github.com/green-fox-academy/markdown-tools
+cd markdown-tools
+npm link
+```
+
+
+## Usage
+
+### Generate Jira compatible `csv` from markdown
+
+```
+markdown-tools stories2csv -i stories.md -o stories.csv
+```
+
+For further details see the `--help` flag on the cli tool or read the `features`.
+

features/cli.feature

@@ -7,7 +7,7 @@ Feature: Show the features if no command is specified
     Given the package installed
     Given a bash prompt in "test/" as working directory
     When the "markdown-tools" command is executed
-    Then it should print to the standard out:
+    Then it should print to the standard error:
       """
       markdown-tools <command>
 

features/steps/steps.ts

@@ -35,6 +35,11 @@ Then('it should print to the standard out:', async function (content: string) {
   assert.equal(stdOut, content);
 });
 
+Then('it should print to the standard error:', async function (content: string) {
+  const stdErr: string = await this.cli.getStdErr();
+  assert.equal(stdErr, content);
+});
+
 Then('the last exit code should be {int}', async function (exitCode: number) {
   const lastExitCode: number = await this.cli.getLastExitCode();
   assert.equal(lastExitCode, exitCode);

features/stories2csv.feature

@@ -35,3 +35,58 @@ Feature: Generate Jira importable CSV file from markdown story list
       - Something"
       Task one,2,1,Sub-task,Do something unexpected
       """
+    Then the last exit code should be 0
+
+ Scenario:
+    Given the package installed
+    Given a bash prompt in "test/" as working directory
+    When the "markdown-tools stories2csv" command is executed
+    Then it should print to the standard error:
+      """
+      markdown-tools stories2csv
+
+      Creates csv file for Jira from markdown story definitions
+
+      Options:
+        --help             Show help                                         [boolean]
+        --version          Show version number                               [boolean]
+        -i, --input_file                                           [string] [required]
+        -o, --output_file                                          [string] [required]
+
+      Missing required arguments: i, o
+
+      """
+    Then the last exit code should be 1
+
+ Scenario:
+    Given the package installed
+    Given a bash prompt in "test/" as working directory
+    When the "markdown-tools stories2csv -i stories.md" command is executed
+    Then it should print to the standard error:
+      """
+      markdown-tools stories2csv
+
+      Creates csv file for Jira from markdown story definitions
+
+      Options:
+        --help             Show help                                         [boolean]
+        --version          Show version number                               [boolean]
+        -i, --input_file                                           [string] [required]
+        -o, --output_file                                          [string] [required]
+
+      Missing required argument: o
+
+      """
+    Then the last exit code should be 1
+
+ Scenario:
+    Given the package installed
+    Given a bash prompt in "test/" as working directory
+    When the "markdown-tools stories2csv -i stories.md -o stories.csv" command is executed
+    Then it should print to the standard error:
+      """
+      Unable to open file: "stories.md"
+
+      """
+    Then the last exit code should be 1
+

features/world/realCli.ts

@@ -21,7 +21,7 @@ const runCliLine = (line: string): Promise<CommandResult> =>
     });
 
     spawned.stderr.on('data', data => {
-      stdout += data;
+      stderr += data;
     });
 
     spawned.on('close', exitCode => {