@skriptfabrik/json-schema-bundler 0.0.0-dev

package/.dockerignore

@@ -0,0 +1,22 @@
+# GitHub
+/.github
+
+# JetBrains IDEs - PhpStorm
+/.idea
+
+# Microsoft IDEs - VSCode
+/.vscode
+
+# Dependencies
+node_modules
+
+# Misc
+.dockerignore
+.editorconfig
+.git*
+Dockerfile
+README.md
+
+# System Files
+.DS_Store
+Thumbs.db

package/.editorconfig

@@ -0,0 +1,19 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{json,yml,yaml}]
+indent_size = 2
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+
+env:
+  DOCKER_BUILDKIT: 1
+  DOCKER_BUILDKIT_INLINE_CACHE: 1
+  DOCKER_IMAGE_NAME: skriptfabrik/json-schema-bundler
+  NODE_VERSION: 18.2.0
+
+jobs:
+  publish-push:
+    name: Publish package and Push Docker images
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install Node.js version ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Bump package version
+        if: github.ref_type == 'tag'
+        run: npm version from-git --no-git-tag-version
+
+      - name: Publish package
+        uses: JS-DevTools/npm-publish@v1
+        if: github.ref_type == 'tag'
+        with:
+          access: public
+          token: ${{ secrets.NPM_TOKEN }}
+
+      - name: Log in to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Build and Push latest Docker image
+        if: github.ref_name == 'main'
+        uses: docker/build-push-action@v2
+        with:
+          build-args: |-
+            BUILDKIT_INLINE_CACHE=${{ env.DOCKER_BUILDKIT_INLINE_CACHE }}
+          cache-from: type=registry,ref=${{ env.DOCKER_IMAGE_NAME }}:latest
+          platforms: |-
+            linux/amd64
+            linux/arm64
+          pull: true
+          push: true
+          tags: |-
+            ${{ env.DOCKER_IMAGE_NAME }}:latest
+
+      - name: Export release version
+        if: github.ref_type == 'tag'
+        run: |-
+          echo "RELEASE_VERSION=${GITHUB_REF_NAME}" >> ${GITHUB_ENV}
+
+      - name: Build and Push Docker image release version
+        if: github.ref_type == 'tag'
+        uses: docker/build-push-action@v2
+        with:
+          build-args: |-
+            BUILDKIT_INLINE_CACHE=${{ env.DOCKER_BUILDKIT_INLINE_CACHE }}
+            JSON_SCHEMA_BUNDLER_VERSION=v${{ env.RELEASE_VERSION }}
+          cache-from: type=registry,ref=${{ env.DOCKER_IMAGE_NAME }}:latest
+          platforms: |-
+            linux/amd64
+            linux/arm64
+          pull: true
+          push: true
+          tags: |-
+            ${{ env.DOCKER_IMAGE_NAME }}:${{ env.RELEASE_VERSION }}

package/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:18.2.0-alpine
+
+LABEL maintainer="Daniel Schröder <daniel.schroeder@skriptfabrik.com>"
+
+ARG JSON_SCHEMA_BUNDLER_VERSION=latest
+
+ENV JSON_SCHEMA_BUNDLER_VERSION=${JSON_SCHEMA_BUNDLER_VERSION}
+ENV NODE_ENV=production
+
+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
+
+ENTRYPOINT [ "json-schema-bundler" ]

package/README.md

@@ -0,0 +1,55 @@
+[![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)
+
+# JSON Schema Bundler
+
+> The missing CLI for the [JSON Schema $Ref Parser](https://github.com/APIDevTools/json-schema-ref-parser)
+
+## Installation
+
+Install using [npm](https://docs.npmjs.com/about-npm/) as global package:
+
+```bash
+npm install -g @skriptfabrik/json-schema-bundler
+```
+
+## Usage
+
+```bash
+json-schema-bundler --help
+```
+
+```text
+JSON Schema Bundler (latest)
+
+Usage:
+  json-schema-bundler [options] <input>
+
+Arguments:
+  input  The path or URL of the input schema file
+
+Options:
+  -h, --help    Display this help message
+  -p, --pretty  Pretty print output
+  -s, --silent  Silent mode
+
+Examples:
+  Bundle all references in schema.json and print output to stdout:
+
+    json-schema-bundler -ps schema.json
+```
+
+## Docker
+
+Use the following command to bundle (dereference) 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
+```
+
+It is also possible to print the status logs to `stderr` and redirect `stdout` to a file:
+
+```bash
+docker run --rm -v `pwd`:/work -w /work skriptfabrik/json-schema-bundler -p schema.json > output.json
+```

package/json-schema-bundler-cli.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+
+const $RefParser = require('json-schema-ref-parser');
+const minimist = require('minimist');
+const path = require('path');
+
+const argv = minimist(process.argv.slice(2), {
+    boolean: ['h', 'p', 's'],
+    alias: {
+        h: 'help',
+        p: 'pretty',
+        s: 'silent',
+    },
+});
+
+const colors = {
+    end: '\x1b[0m',
+    green: '\x1b[32m',
+    yellow: '\x1b[33m',
+    magenta: '\x1b[35m',
+};
+
+if (argv.h || argv._.length < 1) {
+    console.error(
+        `JSON Schema Bundler (%s)\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`,
+        process.env['JSON_SCHEMA_BUNDLER_VERSION'],
+        `${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`,
+        ].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));
+})();

package/output.json

@@ -0,0 +1,5 @@
+{
+  "schema2": {
+    "foo": "bar"
+  }
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@skriptfabrik/json-schema-bundler",
+  "version": "0.0.0-dev",
+  "description": "The missing CLI for the JSON Schema $Ref Parser",
+  "keywords": [
+    "json",
+    "schema",
+    "jsonschema",
+    "json-schema",
+    "json-pointer",
+    "$ref",
+    "bundle",
+    "cli"
+  ],
+  "author": {
+    "name": "Daniel Schröder",
+    "email": "daniel.schroeder@skriptfabrik.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/skriptfabrik/json-schema-bundler.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "json-schema-ref-parser": "^9.0.9",
+    "minimist": "^1.2.6"
+  },
+  "bin": {
+    "json-schema-bundler": "./json-schema-bundler-cli.js"
+  }
+}

package/schema.json

@@ -0,0 +1,5 @@
+{
+  "schema2": {
+      "$ref": "schema2.json"
+  }
+}

package/schema2.json

@@ -0,0 +1,3 @@
+{
+  "foo": "bar"
+}