fix(CLI) yargs was wrongly listed in devDependencies

Signed-off-by: Jerome Simeon <[email protected]>
accordproject · Oct 3, 2019 · c497494 · c497494
1 parent 13daf6f
commit c497494
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 7 deletions.
diff --git a/packages/markdown-cli/README.md b/packages/markdown-cli/README.md
@@ -5,25 +5,26 @@ Command line tool to debug and use markdown transformations.
 ## Installation
 
 ```
-npm install @accordproject/markdown-cli --save
+npm install -g @accordproject/markdown-cli
 ```
 
 ## Usage
 
 ```
-markus parse --help
+markus parse
 
-parse sample markdown to Concerto instance
+parse and transform sample markdown
 
 Options:
-  --help         Show help                                             [boolean]
   --version      Show version number                                   [boolean]
   --verbose, -v                                                 [default: false]
+  --help         Show help                                             [boolean]
   --sample       path to the clause text                                [string]
   --out          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]
 ```

diff --git a/packages/markdown-cli/package.json b/packages/markdown-cli/package.json
@@ -49,16 +49,16 @@
     "license-check": "1.1.5",
     "mocha": "6.1.4",
     "nyc": "14.1.1",
-    "tsd-jsdoc": "^2.3.0",
-    "yargs": "13.2.4"
+    "tsd-jsdoc": "^2.3.0"
   },
   "dependencies": {
     "@accordproject/markdown-common": "0.4.1",
     "@accordproject/markdown-cicero": "0.4.1",
     "@accordproject/markdown-slate": "0.4.1",
     "@accordproject/markdown-html": "0.4.1",
     "jsome": "2.5.0",
-    "winston": "3.2.1"
+    "winston": "3.2.1",
+    "yargs": "13.2.4"
   },
   "license-check-config": {
     "src": [

diff --git a/packages/markdown-common/src/__snapshots__/CommonMarkTransformer.test.js.snap b/packages/markdown-common/src/__snapshots__/CommonMarkTransformer.test.js.snap
@@ -732,6 +732,90 @@ Object {
 }
 `;
 
+exports[`markdown converts fixed.md to concerto JSON 1`] = `
+Object {
+  "$class": "org.accordproject.commonmark.Document",
+  "nodes": Array [
+    Object {
+      "$class": "org.accordproject.commonmark.Heading",
+      "level": "2",
+      "nodes": Array [
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "Fixed",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Softbreak",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "rate",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Softbreak",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "loan",
+        },
+      ],
+    },
+    Object {
+      "$class": "org.accordproject.commonmark.Paragraph",
+      "nodes": Array [
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "This is a ",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Emph",
+          "nodes": Array [
+            Object {
+              "$class": "org.accordproject.commonmark.Text",
+              "text": "fixed interest",
+            },
+          ],
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": " loan to the amount of 100000",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Softbreak",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "at the yearly interest rate of 2.5%",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Softbreak",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "with a loan term of 15,",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Softbreak",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "and monthly payments of {{I",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "'",
+        },
+        Object {
+          "$class": "org.accordproject.commonmark.Text",
+          "text": "m not sure which amount right now}}",
+        },
+      ],
+    },
+  ],
+  "xmlns": "http://commonmark.org/xml/1.0",
+}
+`;
+
 exports[`markdown converts h1.md to concerto JSON 1`] = `
 Object {
   "$class": "org.accordproject.commonmark.Document",

diff --git a/packages/markdown-common/test/data/fixed.md b/packages/markdown-common/test/data/fixed.md
@@ -0,0 +1,9 @@
+Fixed
+rate
+loan
+----
+
+This is a _fixed interest_ loan to the amount of 100000
+at the yearly interest rate of 2.5%
+with a loan term of 15,
+and monthly payments of {{I'm not sure which amount right now}}