Update README and version

glibas · glibas · commit 4677b85f80b2 · 2024-02-13T23:05:29.000Z
diff --git a/README.md b/README.md
@@ -20,29 +20,31 @@ $ assertthat-bdd -i PROJECT_ID -a ASSERTTHAT_ACCESS_KEY -s ASSERTTHAT_SECRET_KEY
 
 Available parameters:
 ```
-  -V, --version                             output the version number
-  -a, --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
-  -s, --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
-  -t, --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
-  -u, --jiraServerUrl [URL]                 Jira server URL e.g https://mycompanyjira.com
-  -f, --features                            Download features
-  -r, --report                              Upload report
-  -i, --projectId <ID>                      Jira project id
-  -j, --jsonReportFolder [FOLDER PATH]      Cucumber json files folder
-  -m, --mode <mode>                         Features to download (default: "automated")
-  -l, --tags <tag-expression>               Cucumber tag expression for scenarios filtering
-  -n, --runName [NAME]                      Test run name
-  -d, --metadata [FILE PATH]                Metadata json file path
-  -o, --outputFolder [FOLDER PATH]          Features output folder
-  -q, --jql [JQL]                           JQL filter for features download or Jira issues to update with test results
-  -t, --jsonReportIncludePattern [PATTERN]  Pattern for json file names
-  -x, --proxyURI [URI]                      Proxy URI
-  -b, --numbered [true|false]               Append number to feature name on download
-  -h, --help                                output usage information
-
-```
-
-Mandatory parameters are -i, -a, -s (if -a or -s is missing the plugin will attempt to read them from ASSERTTHAT_ACCESS_KEY and ASSERTTHAT_SECRET_KEY environment variables respectively.
+  Options:
+  -V, --version                         output the version number
+  --projectId <ID>                      Jira project id
+  --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
+  --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
+  --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
+  --jiraServerUrl [URL]                 Jira server URL e.g https://mycompanyjira.com
+  --features                            Download features
+  --report                              Upload report
+  --jsonReportFolder [FOLDER PATH]      Cucumber json files folder
+  --mode <mode>                         Features to download (default: "automated")
+  --tags <tag-expression>               Cucumber tag expression for filtering scenarios (default: "")
+  --runName [NAME]                      Test run name
+  --metadata [FILE PATH]                Metadata json file path
+  --outputFolder [FOLDER PATH]          Jira project id
+  --jql [JQL]                           JQL filter for features download and report upload
+  --jsonReportIncludePattern [PATTERN]  Pattern for json file names
+  --proxyHost [Host]                    Proxy Host
+  --proxyPort [Port]                    Proxy Port
+  --numbered [true|false]               Append number to feature name on download
+  -h, --help                            output usage information
+
+```
+
+Mandatory parameters are --projectId, --accessKey, --secretKey (if --accessKey or --secretKey is missing the plugin will attempt to read them from ASSERTTHAT_ACCESS_KEY and ASSERTTHAT_SECRET_KEY environment variables respectively.
 
 ## Using from within a script
 
@@ -90,17 +92,18 @@ assertThat.downloadFeatures({
 Available parameters:
 
 ```
-  -a, --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
-  -s, --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
-  -t, --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
-  -u, --jiraServerUrl [URL]                 Jira server URL e.g https://mycompanyjira.com
-  -i, --projectId <ID>                      Jira project id
-  -m, --mode <mode>                         Features to download (default: "automated")
-  -l, --tags <tag-expression>               Cucumber tag expression for scenarios filtering
-  -o, --outputFolder [FOLDER PATH]          Jira project id
-  -q, --jql [JQL]                           JQL filter for features
-  -b, --numbered [true|false]               Append number to feature name on download
-  -x, --proxyURI [URI]                      Proxy URI
+  --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
+  --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
+  --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
+  --jiraServerUrl [URL]                 Jira server URL e.g https://mycompanyjira.com
+  --projectId <ID>                      Jira project id
+  --mode <mode>                         Features to download (default: "automated")
+  --tags <tag-expression>               Cucumber tag expression for scenarios filtering
+  --outputFolder [FOLDER PATH]          Jira project id
+  --jql [JQL]                           JQL filter for features
+  --numbered [true|false]               Append number to feature name on download
+  --proxyHost [Host]                    Proxy Host
+  --proxyPort [Port]                    Proxy Port
 ```
 
 * For uploading reports:
@@ -137,16 +140,17 @@ assertThat.uploadReports({
 Available parameters:
 
 ```
-  -a, --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
-  -s, --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
-  -t, --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
-  -i, --projectId <ID>                      Jira project id
-  -j, --jsonReportFolder [FOLDER PATH]      Cucumber json files folder
-  -n, --runName [NAME]                      Test run name
-  -t, --jsonReportIncludePattern [PATTERN]  Pattern for json file names
-  -q, --jql [JQL]                           JQL filter for Jira issues to update with test results
-  -x, --proxyURI [URI]                      Proxy URI
-  -d, --metadata [FILE PATH]                Metadata json file path
+  --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
+  --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
+  --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
+  --projectId <ID>                      Jira project id
+  --jsonReportFolder [FOLDER PATH]      Cucumber json files folder
+  --runName [NAME]                      Test run name
+  --jsonReportIncludePattern [PATTERN]  Pattern for json file names
+  --jql [JQL]                           JQL filter for Jira issues to update with test results
+  --proxyHost [Host]                    Proxy Host
+  --proxyPort [Port]                    Proxy Port
+  --metadata [FILE PATH]                Metadata json file path
 ```
 
 * Metadata file path is the path to a  simple json file (no nesting) with some additional data about the run that can be optionally supplied. 
diff --git a/bin/cli.js b/bin/cli.js
@@ -1,19 +1,19 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 'use strict'
 const program = require('commander');
 const assertThat = require('../lib/assertthat-bdd');
 const colors = require('colors');
 const dateFormat = require('dateformat');
 
 program
-  .version('1.2.0')
+  .version('2.0.0')
+  .option('--projectId <ID>', 'Jira project id')
   .option('--accessKey [ASSERTTHAT_ACCESS_KEY]', 'Access key')
   .option('--secretKey [ASSERTTHAT_SECRET_KEY]', 'Secret key')
   .option('--token [ASSERTTHAT_API_TOKEN]', 'Jira API token (Server and DC only)')
   .option('--jiraServerUrl [URL]', 'Jira server URL e.g https://mycompanyjira.com')
   .option('--features', 'Download features')
   .option('--report', 'Upload report')
-  .option('--projectId <ID>', 'Jira project id')
   .option('--jsonReportFolder [FOLDER PATH]', 'Cucumber json files folder')
   .option('--mode <mode>', 'Features to download', /^(automated|manual|both)$/i, 'automated')
   .option('--tags <tag-expression>', 'Cucumber tag expression for filtering scenarios', '')
@@ -83,12 +83,12 @@ if(program.report){
 if(!settings.projectId || (!settings.token && (!settings.accessKey || !settings.secretKey))){
         if(!program.projectId){
             console.log('');
-            console.log(make_red('projectId (-i) option is required'));
+            console.log(make_red('--projectId option is required'));
             console.log('');
         }
         if(!settings.token && (!settings.accessKey || !settings.secretKey)){
             console.log('');
-            console.log(make_red('accessKey (-a) with secretKey (-s) or Jira API token (-t) option is required'));
+            console.log(make_red('--accessKey with --secretKey or Jira API --token option is required'));
             console.log('');
         }
         program.outputHelp(make_red);
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@assertthat/assertthat-bdd",
-  "version": "1.9.4",
+  "version": "2.0.0",
   "description": "Node.js module for integration with AssertThat BDD Jira plugin",
   "main": "index.js",
   "scripts": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@assertthat/assertthat-bdd",`
`3`		`- "version": "1.9.4",`
	`3`	`+ "version": "2.0.0",`
`4`	`4`	`"description": "Node.js module for integration with AssertThat BDD Jira plugin",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"scripts": {`