Merge branch 'master' of github.com:j-tester/json-diff-cli

Author: nahtnam

README.md

@@ -3,6 +3,7 @@
 json-diff-cli allows you to diff the JSON of two urls and see what the differences are. This tool can be used for testing purposes or to simply check that things are working.
 
 # Usage
+
 ```
 Commands:
 
@@ -13,15 +14,19 @@ Commands:
 ```
 
 ## DIFF
+
 ### diff the json between two urls and print to the console.
+
 ```
 jsondiff diff <leftURL> <rightURL> [options]
 ```
+
 **`leftURL`**: The base URL you would like to compare to.
 
 **`rightURL`**: The new/updated URL. The JSON from `rightURL` will be compared with the `leftURL` and changes will be printed out to the console.
 
 ### Options
+
 ```
 Usage: diff [options] <leftURL> <rightURL>
 
@@ -31,6 +36,7 @@ Options:
 
   --help                        output usage information
   -o, --output <file>           print the output to a CSV file
+  -f, --failOnDiff              return exit code 1 if there is a difference
   -x, --diffheaders             diff the headers as well as the body
   -H, --headers <string>        attach a header to the request. You may string multipe headers together by passing along more -H or --header options
   -i, --ignore <key>            ignore the provided key. You may string multipe ignore keys together by passing along more -i or --ignore options
@@ -43,7 +49,9 @@ Options:
 ### Example
 
 #### Input
+
 ##### leftJSON
+
 ```json
 {
   "foo": {
@@ -54,7 +62,9 @@ Options:
   }
 }
 ```
+
 ##### rightJSON
+
 ```json
 {
   "foo": {
@@ -67,6 +77,7 @@ Options:
 ```
 
 #### Output
+
 ```
 key        left          right         diff
 ---------  ------------  ------------  -------
@@ -76,6 +87,7 @@ foo.bar.a  true          false         updated
 ```
 
 ## CSV
+
 ### diff the json between urls in a csv file, print to the console, and output into a csv file.
 
 ```
@@ -85,6 +97,7 @@ jsondiff csv <input> [options]
 **`input`**: Path to the input file (CSV format).
 
 ### Options
+
 ```
 Usage: csv [options] <path>
 
@@ -100,8 +113,11 @@ Options:
 ```
 
 ### Example
+
 #### Input
+
 **The first line in the CSV file must have the following headers. You may chose to omit any of them except for `ur1`, and `url2`**
+
 ```
 url1, url2, method, headers, body, sortKey, ignore
 ```
@@ -130,7 +146,9 @@ https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/
 ```
 
 #### Output
+
 ##### csv
+
 ```
 id,left url,left response time,right url,right response time,key,left value,right value,difference,status
 0,https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/a.json,1197,https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/b.json,675,foo.bar.c,undefined,now you dont,added,fail
@@ -143,7 +161,9 @@ id,left url,left response time,right url,right response time,key,left value,righ
 2,https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/a.json,396,https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/b.json,386,foo.bar.b,now u see me,undefined,deleted,fail
 2,https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/a.json,396,https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/b.json,386,foo.bar.a,true,none,updated,fail
 ```
+
 ##### console
+
 ```
 https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/a.json vs https://gist.githubusercontent.com/nahtnam/920171eeef10e911a6ee7698d9c226ae/raw/bdd86427b8c807e149251d4737d2886620f7fcdc/b.json
 key        left          right         diff

index.js

@@ -7,13 +7,35 @@ const csvScript = require('./scripts/csv');
 
 yargs.usage('$0 <cmd> [args]');
 
-yargs
-  .command('diff <leftURL> <rightURL> [options]', 'diffs the json response of two URLs.', {
+yargs.command(
+  'diff <leftURL> <rightURL> [options]',
+  'diffs the json response of two URLs.',
+  {
     output: {
       alias: 'o',
       describe: 'print the output to a CSV file',
       type: 'string',
     },
+    quiet: {
+      alias: 'q',
+      describe: 'silences the console output',
+      type: 'boolean',
+      default: false,
+    },
+    failOnDiff: {
+      alias: 'f',
+      default: false,
+      describe: 'return exit code 1 if there is a difference',
+      type: 'boolean',
+    },
+    expectedStatusCode: {
+      describe: 'expected status codes of the requests',
+      type: 'string',
+    },
+    customCompare: {
+      describe: 'custom compare json as string',
+      type: 'string',
+    },
     method: {
       alias: 'm',
       default: 'GET',
@@ -49,7 +71,8 @@ yargs
     },
     headers: {
       alias: 'H',
-      describe: 'attach a header to the request. separate multiple headers with a space: -H "Accept: text/plain" "Accept-Charset: utf-8"',
+      describe:
+        'attach a header to the request. separate multiple headers with a space: -H "Accept: text/plain" "Accept-Charset: utf-8"',
       type: 'array',
     },
     ignore: {
@@ -59,18 +82,23 @@ yargs
     },
     body: {
       alias: 'b',
-      describe: 'request body (only for POST) separate multiple body parts with a space: -b "username: testing" "password: 123"',
+      describe:
+        'request body (only for POST) separate multiple body parts with a space: -b "username: testing" "password: 123"',
       type: 'array',
     },
     arraysortkey: {
       alias: 'a',
       describe: 'sort nested arrays by the sort key, defaults to id',
       type: 'string',
     },
-  }, diffScript);
+  },
+  diffScript,
+);
 
-yargs
-  .command('csv <path> [options]', 'diffs all urls in a csv file', {
+yargs.command(
+  'csv <path> [options]',
+  'diffs all urls in a csv file',
+  {
     output: {
       alias: 'o',
       describe: 'print the output to a CSV file',
@@ -94,7 +122,9 @@ yargs
       default: 5000,
       type: 'number',
     },
-  }, csvScript);
+  },
+  csvScript,
+);
 
 yargs.help();