@skriptfabrik/json-schema-bundler 0.2.0 → 0.4.0

package/.github/dependabot.yaml

@@ -0,0 +1,41 @@
+version: 2
+
+registries:
+  dockerhub:
+    type: 'docker-registry'
+    url: 'https://registry.hub.docker.com'
+    username: '${{ secrets.DOCKERHUB_USERNAME }}'
+    password: '${{ secrets.DOCKERHUB_TOKEN }}'
+    replaces-base: true
+
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    reviewers:
+      - 'skriptfabrik/developers'
+    schedule:
+      interval: 'weekly'
+      time: '08:00'
+      timezone: 'Europe/Berlin'
+
+  - package-ecosystem: 'npm'
+    directory: '/'
+    ignore:
+      - dependency-name: '@types/*'
+    reviewers:
+      - 'skriptfabrik/developers'
+    schedule:
+      interval: 'weekly'
+      time: '08:00'
+      timezone: 'Europe/Berlin'
+
+  - package-ecosystem: 'docker'
+    directory: '/'
+    reviewers:
+      - 'skriptfabrik/developers'
+    registries:
+      - 'dockerhub'
+    schedule:
+      interval: 'weekly'
+      time: '08:00'
+      timezone: 'Europe/Berlin'

package/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Describe your changes
+
+-   [ ] Bug fix (non-breaking change which fixes an issue)
+-   [ ] New feature (non-breaking change which adds functionality)
+-   [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklist before requesting a review
+
+-   [ ] I have included the ticket number of the issue at the beginning of the title of this pull request.
+-   [ ] I have updated the docs and/or specs to reflect this change.
+-   [ ] I have performed a self-review of my code.
+-   [ ] I have added thorough tests.

package/.github/workflows/ci.yml

@@ -69,7 +69,7 @@ jobs:
 
       - name: Build and Push latest Docker image
         if: github.ref_name == 'main'
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v4
         with:
           build-args: |-
             BUILDKIT_INLINE_CACHE=${{ env.DOCKER_BUILDKIT_INLINE_CACHE }}
@@ -91,7 +91,7 @@ jobs:
 
       - name: Build and Push Docker image release version
         if: github.ref_type == 'tag'
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v4
         with:
           build-args: |-
             BUILDKIT_INLINE_CACHE=${{ env.DOCKER_BUILDKIT_INLINE_CACHE }}

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.2.0-alpine
+FROM node:18.14.0-alpine
 
 LABEL maintainer="Daniel Schröder <daniel.schroeder@skriptfabrik.com>"
 
@@ -11,6 +11,6 @@ COPY . /opt/json-schema-bundler-${JSON_SCHEMA_BUNDLER_VERSION}
 RUN set -eux; \
     npm --prefix /opt/json-schema-bundler-${JSON_SCHEMA_BUNDLER_VERSION} install; \
     rm -Rf ~/.npm; \
-    ln -s /opt/json-schema-bundler-${JSON_SCHEMA_BUNDLER_VERSION}/json-schema-bundler-cli.js /usr/local/bin/json-schema-bundler
+    ln -s /opt/json-schema-bundler-${JSON_SCHEMA_BUNDLER_VERSION}/json-schema-bundler-cli.mjs /usr/local/bin/json-schema-bundler
 
 ENTRYPOINT [ "json-schema-bundler" ]

package/README.md

@@ -1,6 +1,6 @@
 [![NPM Version](https://img.shields.io/npm/v/@skriptfabrik/json-schema-bundler)](https://www.npmjs.com/package/@skriptfabrik/json-schema-bundler)
 [![NPM Downloads](https://img.shields.io/npm/dt/@skriptfabrik/json-schema-bundler)](https://www.npmjs.com/package/@skriptfabrik/json-schema-bundler)
-[![Continuous Integration](https://img.shields.io/github/workflow/status/skriptfabrik/json-schema-bundler/Continuous%20Integration)](https://github.com/skriptfabrik/json-schema-bundler/actions/workflows/ci.yml)
+[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/skriptfabrik/json-schema-bundler/ci.yml)](https://github.com/skriptfabrik/json-schema-bundler/actions/workflows/ci.yml)
 
 # JSON Schema Bundler
 
@@ -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.mjs

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+
+import $RefParser from '@apidevtools/json-schema-ref-parser';
+import chalk from 'chalk';
+import { readFile } from 'fs/promises';
+import minimist from 'minimist';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import YAML from 'js-yaml';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const pkg = JSON.parse(await readFile(path.join(__dirname, 'package.json')));
+
+const argv = minimist(process.argv.slice(2), {
+    boolean: ['d', 'h', 'p', 's', 'v', 'y'],
+    alias: {
+        d: 'dereference',
+        h: 'help',
+        p: 'pretty',
+        s: 'silent',
+        v: 'version',
+        y: 'yaml',
+    },
+});
+
+if (argv.v) {
+    console.log(pkg.version);
+    process.exit(0);
+}
+
+if (argv.h || argv._.length < 1) {
+    console.error(
+        `JSON Schema Bundler\n\n${chalk.yellow('Usage:')}\n  %s\n\n${chalk.yellow('Arguments:')}\n  %s\n\n${chalk.yellow('Options:')}\n  %s\n\n${chalk.yellow('Examples:')}\n  %s`,
+        `  ${path.basename(process.argv[1])} [options] <input>`,
+        `  ${chalk.green('input')}  The path of the input schema file`,
+        [
+            `  ${chalk.green('-d, --dereference')}  Replacing each reference with its resolved value`,
+            `  ${chalk.green('-h, --help')}         Display this help message`,
+            `  ${chalk.green('-p, --pretty')}       Pretty print output`,
+            `  ${chalk.green('-s, --silent')}       Silent mode`,
+            `  ${chalk.green('-v, --version')}      Print version number`,
+            `  ${chalk.green('-y, --yaml')}         Output as YAML document instead of JSON`,
+        ].join('\n'),
+        [
+            `  Bundle all references in ${chalk.magenta('schema.json')} with internal $ref pointers and print output to ${chalk.magenta('stdout')}:`,
+            ``,
+            `    ${chalk.green(`${path.basename(process.argv[1])} schema.json`)}`,
+            ``,
+            `  Dereference all references in ${chalk.magenta('schema.json')} and print output to ${chalk.magenta('stdout')}:`,
+            ``,
+            `    ${chalk.green(`${path.basename(process.argv[1])} -d schema.json`)}`,
+        ].join('\n')
+    );
+    process.exit(argv.h ? 0 : 1);
+}
+
+const input = path.resolve(argv._[0]);
+
+argv.s || console.error(`Bundling ${input}`);
+
+let schema;
+
+try {
+    if (argv.d) {
+        schema = await $RefParser.dereference(input);
+    } else {
+        schema = await $RefParser.bundle(input);
+    }
+} catch (err) {
+    argv.s || console.error(err);
+    process.exit(1);
+}
+
+if (argv.y) {
+    console.log(YAML.dump(schema, argv.p ? undefined : { flowLevel: 3 }));
+} else {
+    console.log(JSON.stringify(schema, undefined, argv.p ? 2 : undefined));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skriptfabrik/json-schema-bundler",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "The missing CLI for the JSON Schema $Ref Parser",
   "keywords": [
     "json",
@@ -22,10 +22,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "json-schema-ref-parser": "^9.0.9",
-    "minimist": "^1.2.6"
+    "@apidevtools/json-schema-ref-parser": "^10.1.0",
+    "chalk": "^5.2.0",
+    "js-yaml": "~4.0.0",
+    "minimist": "^1.2.7"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "~4.0.0"
   },
   "bin": {
-    "json-schema-bundler": "./json-schema-bundler-cli.js"
+    "json-schema-bundler": "./json-schema-bundler-cli.mjs"
   }
 }

package/json-schema-bundler-cli.js

@@ -1,66 +0,0 @@
-#!/usr/bin/env node
-
-const $RefParser = require('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'],
-    alias: {
-        h: 'help',
-        p: 'pretty',
-        s: 'silent',
-        v: 'version',
-    },
-});
-
-const colors = {
-    end: '\x1b[0m',
-    green: '\x1b[32m',
-    yellow: '\x1b[33m',
-    magenta: '\x1b[35m',
-};
-
-if (argv.v) {
-    console.log(pkg.version);
-    process.exit(0);
-}
-
-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}-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}`,
-            ].join('\n\n    '),
-        ].join('\n  '),
-    );
-    process.exit(argv.h ? 0 : 1);
-}
-
-const input = path.resolve(argv._[0]);
-
-argv.s || console.error(`Bundling ${input}`);
-
-(async () => {
-    let schema;
-
-    try {
-        schema = await $RefParser.dereference(input);
-    } catch (err) {
-        argv.s || console.error(err);
-        process.exit(1);
-    }
-
-    console.log(JSON.stringify(schema, undefined, argv.p ? 2 : undefined));
-})();