@skriptfabrik/json-schema-bundler 0.2.0 → 0.3.0

package/README.md

@@ -27,30 +27,35 @@ Usage:
   json-schema-bundler [options] <input>
 
 Arguments:
-  input  The path or URL of the input schema file
+  input  The path of the input schema file
 
 Options:
-  -h, --help     Display this help message
-  -p, --pretty   Pretty print output
-  -s, --silent   Silent mode
-  -v, --version  Print version number
+  -d, --dereference  Replacing each reference with its resolved value
+  -h, --help         Display this help message
+  -p, --pretty       Pretty print output
+  -s, --silent       Silent mode
+  -v, --version      Print version number
 
 Examples:
-  Bundle all references in schema.json and print output to stdout:
+  Bundle all references in schema.json with internal $ref pointers and print output to stdout:
 
-    json-schema-bundler -ps schema.json
+    json-schema-bundler schema.json
+
+  Dereference all references in schema.json and print output to stdout:
+
+    json-schema-bundler -d schema.json
 ```
 
 ## Docker
 
-Use the following command to bundle (dereference) all references in `schema.json` and print the output to `stdout`:
+Use the following command to bundle all references in `schema.json` and print the output to `stdout`:
 
 ```bash
-docker run --rm -v `pwd`:/work -w /work skriptfabrik/json-schema-bundler -ps schema.json
+docker run --rm -v `pwd`:/work -w /work skriptfabrik/json-schema-bundler schema.json
 ```
 
-It is also possible to print the status logs to `stderr` and redirect `stdout` to a file:
+To dereference all references in `schema.json` and print the output to `stdout` add the `-d` option:
 
 ```bash
-docker run --rm -v `pwd`:/work -w /work skriptfabrik/json-schema-bundler -p schema.json > output.json
+docker run --rm -v `pwd`:/work -w /work skriptfabrik/json-schema-bundler -d schema.json
 ```

package/json-schema-bundler-cli.js

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
 
-const $RefParser = require('json-schema-ref-parser');
+const $RefParser = require('@apidevtools/json-schema-ref-parser');
 const minimist = require('minimist');
 const path = require('path');
 const pkg = require('./package.json');
 
 const argv = minimist(process.argv.slice(2), {
-    boolean: ['h', 'p', 's'],
+    boolean: ['d', 'h', 'p', 's', 'v'],
     alias: {
+        d: 'dereference',
         h: 'help',
         p: 'pretty',
         s: 'silent',
@@ -31,19 +32,24 @@ if (argv.h || argv._.length < 1) {
     console.error(
         `JSON Schema Bundler\n\n${colors.yellow}Usage:${colors.end}\n  %s\n\n${colors.yellow}Arguments:${colors.end}\n  %s\n\n${colors.yellow}Options:${colors.end}\n  %s\n\n${colors.yellow}Examples:${colors.end}\n  %s`,
         `${path.basename(process.argv[1])} [options] <input>`,
-        `${colors.green}input${colors.end}  The path or URL of the input schema file`,
+        `${colors.green}input${colors.end}  The path of the input schema file`,
         [
-            `${colors.green}-h, --help${colors.end}     Display this help message`,
-            `${colors.green}-p, --pretty${colors.end}   Pretty print output`,
-            `${colors.green}-s, --silent${colors.end}   Silent mode`,
-            `${colors.green}-v, --version${colors.end}  Print version number`,
+            `${colors.green}-d, --dereference${colors.end}  Replacing each reference with its resolved value`,
+            `${colors.green}-h, --help${colors.end}         Display this help message`,
+            `${colors.green}-p, --pretty${colors.end}       Pretty print output`,
+            `${colors.green}-s, --silent${colors.end}       Silent mode`,
+            `${colors.green}-v, --version${colors.end}      Print version number`,
         ].join('\n  '),
         [
             [
-                `Bundle all references in ${colors.magenta}schema.json${colors.end} and print output to ${colors.magenta}stdout${colors.end}:`,
-                `${colors.green}${path.basename(process.argv[1])} -ps schema.json${colors.end}`,
+                `Bundle all references in ${colors.magenta}schema.json${colors.end} with internal $ref pointers and print output to ${colors.magenta}stdout${colors.end}:`,
+                `${colors.green}${path.basename(process.argv[1])} schema.json${colors.end}`,
             ].join('\n\n    '),
-        ].join('\n  '),
+            [
+                `Dereference all references in ${colors.magenta}schema.json${colors.end} and print output to ${colors.magenta}stdout${colors.end}:`,
+                `${colors.green}${path.basename(process.argv[1])} -d schema.json${colors.end}`,
+            ].join('\n\n    '),
+        ].join('\n\n  '),
     );
     process.exit(argv.h ? 0 : 1);
 }
@@ -56,7 +62,11 @@ argv.s || console.error(`Bundling ${input}`);
     let schema;
 
     try {
-        schema = await $RefParser.dereference(input);
+        if (argv.d) {
+            schema = await $RefParser.dereference(input);
+        } else {
+            schema = await $RefParser.bundle(input);
+        }
     } catch (err) {
         argv.s || console.error(err);
         process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skriptfabrik/json-schema-bundler",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The missing CLI for the JSON Schema $Ref Parser",
   "keywords": [
     "json",
@@ -22,7 +22,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "json-schema-ref-parser": "^9.0.9",
+    "@apidevtools/json-schema-ref-parser": "^9.0.9",
     "minimist": "^1.2.6"
   },
   "bin": {