fix(cli) Adjusts CLI options and update README

jeromesimeon · jeromesimeon · commit ed7f7c36d733 · 2019-10-29T11:09:22.000-04:00
Signed-off-by: Jerome Simeon &lt;jeromesimeon@me.com&gt;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "devDependencies": {
-    "@accordproject/concerto-core": "^0.82.3",
+    "@accordproject/concerto-core": "^0.82.4",
     "colors": "1.3.3",
     "concurrently": "4.1.1",
     "coveralls": "3.0.4",
diff --git a/packages/markdown-cicero/package.json b/packages/markdown-cicero/package.json
@@ -79,7 +79,7 @@
     "webpack-cli": "^3.3.5"
   },
   "dependencies": {
-    "@accordproject/concerto-core": "^0.82.3",
+    "@accordproject/concerto-core": "^0.82.4",
     "@accordproject/markdown-common": "0.7.2",
     "commonmark": "^0.29.0",
     "jsome": "2.5.0",
diff --git a/packages/markdown-cli/README.md b/packages/markdown-cli/README.md
@@ -16,9 +16,9 @@ The command-line is called `markus` and offers the following commands:
 markus <cmd> [args]
 
 Commands:
-  markus parse    parse and transform sample markdown
-  markus draft    create markdown text from data
-  markus normalize  parse a sample markdown and re-create it
+  markus parse      parse and transform a sample markdown
+  markus draft      create markdown text from data
+  markus normalize  normalize a sample markdown (parse & redraft)
 
 Options:
   --version      Show version number                                   [boolean]
@@ -33,23 +33,20 @@ The `parse` command lets you parse markdown and create a document object model f
 ```
 markus parse
 
-parse and transform sample markdown
+parse and transform a sample markdown
 
 Options:
   --version      Show version number                                   [boolean]
   --verbose, -v  verbose output                       [boolean] [default: false]
   --help         Show help                                             [boolean]
   --sample       path to the markdown text                              [string]
   --output       path to the output file                                [string]
-  --roundtrip    roundtrip                            [boolean] [default: false]
   --cicero       further transform to CiceroMark      [boolean] [default: false]
   --slate        further transform to Slate DOM       [boolean] [default: false]
   --html         further transform to HTML            [boolean] [default: false]
-  --noWrap       do not wrap variables as XML tags    [boolean] [default: false]
-  --noIndex      do not index ordered lists           [boolean] [default: false]
 ```
 
-### Generate text from data
+### Generate markdown from data
 
 The `draft` command lets you take a document object model and generate markdown text from it.
 
@@ -64,20 +61,21 @@ Options:
   --help         Show help                                             [boolean]
   --data         path to the data                                       [string]
   --output       path to the output file                                [string]
-  --cicero       further transform to CiceroMark      [boolean] [default: false]
-  --slate        further transform to Slate DOM       [boolean] [default: false]
-  --noWrap       do not wrap variables as XML tags    [boolean] [default: false]
+  --cicero       input data is a CiceroMark DOM       [boolean] [default: false]
+  --slate        input data is a Slate DOM            [boolean] [default: false]
+  --noWrap       do not wrap CiceroMark variables as XML tags
+                                                      [boolean] [default: false]
   --noIndex      do not index ordered lists           [boolean] [default: false]
 ```
 
-### Re-generate text
+### Normalize the markdown
 
-The `normalize` command lets you parse markdown and re-generate it after parsing.
+The `normalize` command lets you parse markdown and re-draft it from its document object model.
 
 ```
 markus normalize
 
-parse a sample markdown and re-create it
+normalize a sample markdown (parse & redraft)
 
 Options:
   --version      Show version number                                   [boolean]
diff --git a/packages/markdown-cli/index.js b/packages/markdown-cli/index.js
@@ -24,7 +24,7 @@ require('yargs')
     .demandCommand(1, '# Please specify a command')
     .recommendCommands()
     .strict()
-    .command('parse', 'parse and transform sample markdown', (yargs) => {
+    .command('parse', 'parse and transform a sample markdown', (yargs) => {
         yargs.option('sample', {
             describe: 'path to the markdown text',
             type: 'string'
@@ -33,11 +33,6 @@ require('yargs')
             describe: 'path to the output file',
             type: 'string'
         });
-        yargs.option('roundtrip', {
-            describe: 'roundtrip',
-            type: 'boolean',
-            default: false
-        });
         yargs.option('cicero', {
             describe: 'further transform to CiceroMark',
             type: 'boolean',
@@ -53,16 +48,6 @@ require('yargs')
             type: 'boolean',
             default: false
         });
-        yargs.option('noWrap', {
-            describe: 'do not wrap variables as XML tags',
-            type: 'boolean',
-            default: false
-        });
-        yargs.option('noIndex', {
-            describe: 'do not index ordered lists',
-            type: 'boolean',
-            default: false
-        });
         yargs.option('verbose', {
             describe: 'verbose output',
             type: 'boolean',
@@ -76,12 +61,9 @@ require('yargs')
         try {
             argv = Commands.validateParseArgs(argv);
             const options = {};
-            options.roundtrip = argv.roundtrip;
             options.cicero = argv.cicero;
             options.slate = argv.slate;
             options.html = argv.html;
-            options.noWrap = argv.noWrap;
-            options.noIndex = argv.noIndex;
             options.verbose = argv.verbose;
             return Commands.parse(argv.sample, argv.output, options)
                 .then((result) => {
@@ -105,17 +87,17 @@ require('yargs')
             type: 'string'
         });
         yargs.option('cicero', {
-            describe: 'further transform to CiceroMark',
+            describe: 'input data is a CiceroMark DOM',
             type: 'boolean',
             default: false
         });
         yargs.option('slate', {
-            describe: 'further transform to Slate DOM',
+            describe: 'input data is a Slate DOM',
             type: 'boolean',
             default: false
         });
         yargs.option('noWrap', {
-            describe: 'do not wrap variables as XML tags',
+            describe: 'do not wrap CiceroMark variables as XML tags',
             type: 'boolean',
             default: false
         });
@@ -154,7 +136,7 @@ require('yargs')
             return;
         }
     })
-    .command('normalize', 'normalize markdown in a sample (parse & draft)', (yargs) => {
+    .command('normalize', 'normalize a sample markdown (parse & redraft)', (yargs) => {
         yargs.option('sample', {
             describe: 'path to the markdown text',
             type: 'string'
@@ -190,7 +172,7 @@ require('yargs')
         });
     }, (argv) => {
         if (argv.verbose) {
-            Logger.info(`parse and re-create sample ${argv.sample} markdown`);
+            Logger.info(`normalize ${argv.sample} markdown`);
         }
 
         try {
diff --git a/packages/markdown-cli/lib/Commands.js b/packages/markdown-cli/lib/Commands.js
@@ -77,16 +77,13 @@ class Commands {
      * @param {boolean} [options.cicero] whether to further transform for Cicero
      * @param {boolean} [options.slate] whether to further transform for Slate
      * @param {boolean} [options.html] whether to further transform for HTML
-     * @param {boolean} [options.noWrap] whether to avoid wrapping Cicero variables in XML tags
-     * @param {boolean} [options.noIndex] do not index ordered list (i.e., use 1. everywhere)
      * @param {boolean} [options.verbose] verbose output
      * @returns {object} Promise to the result of parsing
      */
     static parse(samplePath, outputPath, options) {
-        const { cicero, slate, html, noWrap, noIndex, verbose } = options;
+        const { cicero, slate, html, verbose } = options;
         const commonOptions = {};
         commonOptions.tagInfo = true;
-        commonOptions.noIndex = noIndex ? true : false;
 
         const commonMark = new CommonMarkTransformer(commonOptions);
         const ciceroMark = new CiceroMarkTransformer();
@@ -166,15 +163,14 @@ class Commands {
      * @returns {object} Promise to the result of parsing
      */
     static draft(dataPath, outputPath, options) {
-        const { roundtrip, cicero, slate, html, noWrap, noIndex, verbose } = options;
+        const { cicero, slate, noWrap, noIndex, verbose } = options;
         const commonOptions = {};
         commonOptions.tagInfo = true;
         commonOptions.noIndex = noIndex ? true : false;
 
         const commonMark = new CommonMarkTransformer(commonOptions);
         const ciceroMark = new CiceroMarkTransformer();
         const slateMark = new SlateTransformer();
-        const htmlMark = new HtmlTransformer();
 
         let result = JSON.parse(Fs.readFileSync(dataPath, 'utf8'));
         if (cicero) {
@@ -198,8 +194,6 @@ class Commands {
                 Logger.info('=== CommonMark ===');
                 Logger.info(JSON.stringify(result, null, 4));
             }
-        } else if (html) {
-            throw new Error('Cannot roundtrip from HTML');
         }
         result = commonMark.toMarkdown(result);
         if (outputPath) {
@@ -239,15 +233,14 @@ class Commands {
      * @returns {object} Promise to the result of parsing
      */
     static normalize(samplePath, outputPath, options) {
-        const { roundtrip, cicero, slate, html, noWrap, noIndex, verbose } = options;
+        const { cicero, slate, noWrap, noIndex, verbose } = options;
         const commonOptions = {};
         commonOptions.tagInfo = true;
         commonOptions.noIndex = noIndex ? true : false;
 
         const commonMark = new CommonMarkTransformer(commonOptions);
         const ciceroMark = new CiceroMarkTransformer();
         const slateMark = new SlateTransformer();
-        const htmlMark = new HtmlTransformer();
 
         const markdownText = Fs.readFileSync(samplePath, 'utf8');
         let result = commonMark.fromMarkdown(markdownText, 'json');
@@ -297,8 +290,6 @@ class Commands {
                 Logger.info('=== CommonMark ===');
                 Logger.info(JSON.stringify(result, null, 4));
             }
-        } else if (html) {
-            throw new Error('Cannot roundtrip from HTML');
         }
         result = commonMark.toMarkdown(result);
         if (outputPath) {
diff --git a/packages/markdown-cli/package.json b/packages/markdown-cli/package.json
@@ -52,7 +52,7 @@
     "tsd-jsdoc": "^2.3.0"
   },
   "dependencies": {
-    "@accordproject/concerto-core": "^0.82.3",
+    "@accordproject/concerto-core": "^0.82.4",
     "@accordproject/markdown-common": "0.7.2",
     "@accordproject/markdown-cicero": "0.7.2",
     "@accordproject/markdown-slate": "0.7.2",
diff --git a/packages/markdown-common/package.json b/packages/markdown-common/package.json
@@ -79,7 +79,7 @@
     "webpack-cli": "^3.3.5"
   },
   "dependencies": {
-    "@accordproject/concerto-core": "^0.82.3",
+    "@accordproject/concerto-core": "^0.82.4",
     "commonmark": "^0.29.0",
     "jsome": "2.5.0",
     "sax": "^1.2.4",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"devDependencies": {`
`3`		`- "@accordproject/concerto-core": "^0.82.3",`
	`3`	`+ "@accordproject/concerto-core": "^0.82.4",`
`4`	`4`	`"colors": "1.3.3",`
`5`	`5`	`"concurrently": "4.1.1",`
`6`	`6`	`"coveralls": "3.0.4",`