support JSON Type Definition

Author: epoberezkin

README.md

@@ -29,10 +29,11 @@ npm install -g ajv-cli
 
 ## JSON schema version
 
-Parameter `--spec` can be used with all commands (other than help) to define which JSON schema version is used:
+Parameter `--spec` can be used with all commands (other than help) to define which JSON schema language is used:
 
 - `--spec=draft7` (default) - support JSON Schema draft-07 (uses `import Ajv from "ajv"`)
 - `--spec=draft2019` - support JSON Schema draft-2019-09 (uses `import Ajv from "ajv/dist/2019"`)
+- `--spec=jtd` - support JSON Type Definition (uses `import Ajv from "ajv/dist/jtd"`)
 
 ## Commands
 
@@ -148,7 +149,7 @@ This command also supports parameters `-r`, `-m` and `-c` as in [validate](#vali
 
 This command validates and migrates schema from JSON Schema draft-04 to JSON Schema draft-07 or draft-2019-09 using [json-schema-migrate](https://github.com/epoberezkin/json-schema-migrate) package.
 
-The [version of JSON Schema](#json-schema-version) is determined by `--spec` parameter (`"draft7"` or `"draft2019"`).
+The [version of JSON Schema](#json-schema-version) is determined by `--spec` parameter (only `"draft7"` or `"draft2019"`).
 
 ```sh
 ajv migrate -s schema
@@ -202,36 +203,36 @@ This command supports the same options and parameters as [validate](#validate-da
 
 You can pass the following [Ajv options](https://github.com/ajv-validator/ajv/blob/master/docs/api.md#options):
 
-| Option                       | Description                                                               |
-| ---------------------------- | ------------------------------------------------------------------------- |
-| Strict mode |
-| `--strict=false`             | disable [strict mode](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md) |
-| `--strict-tuples=`           | throw on (`true`) or ignore (`false`) [strict tuples](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#prohibit-unconstrained-tuples) restrictions (the default is to log) |
-| `--strict-types=`            | throw on (`true`) or ignore (`false`) [strict types](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#strict-types) restrictions (the default is to log) |
-| `--allow-matching-properties`| allow `properties` [matching patterns](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#prohibit-overlap-between-properties-and-patternproperties-keywords) in `patternProperties` |
-| `--allow-union-types`        | allow [union types](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#prohibit-union-types) |
-| `--validate-formats=false`   | disable format validation |
-| Validation and reporting |
-| `--data`                     | use [$data references](https://github.com/ajv-validator/ajv/blob/master/docs/validation.md#data-reference) |
-| `--all-errors`               | collect all validation errors |
-| `--verbose`                  | include schema and data in errors |
-| `--comment`                  | log schema `$comment`s |
-| `--inline-refs=`             | referenced schemas compilation mode (true/false/\<number\>) |
-| Modify validated data |
-| `--remove-additional`        | remove additional properties (true/all/failing) |
-| `--use-defaults`             | replace missing properties/items with the values from default keyword |
-| `--coerce-types`             | change type of data to match type keyword |
-| Advanced |
-| `--multiple-of-precision`    | precision of multipleOf, pass integer number |
-| `--messages=false`           | do not include text messages in errors |
-| `--loop-required=`           | max size of `required` to compile to expression (rather than to loop) |
-| `--loop-enum=`               | max size of `enum` to compile to expression (rather than to loop) |
-| `--own-properties`           | only validate own properties (not relevant for JSON, but can have effect for JavaScript objects) |
-| Code generation |
-| `--code-es5`                 | generate ES5 code |
-| `--code-lines`               | generate multi-line code |
-| `--code-optimize=`           | disable optimization (`false`) or number of optimization passes (1 pass by default) |
-| `--code-formats=`            | code to require formats object (only needed if you generate standalone code and do not use [ajv-formats](https://github.com/ajv-validator/ajv-formats)) |
+| Option                        | Description                                                                                                                                                                                            |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Strict mode                   |
+| `--strict=false`              | disable [strict mode](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md)                                                                                                            |
+| `--strict-tuples=`            | throw on (`true`) or ignore (`false`) [strict tuples](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#prohibit-unconstrained-tuples) restrictions (the default is to log)         |
+| `--strict-types=`             | throw on (`true`) or ignore (`false`) [strict types](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#strict-types) restrictions (the default is to log)                           |
+| `--allow-matching-properties` | allow `properties` [matching patterns](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#prohibit-overlap-between-properties-and-patternproperties-keywords) in `patternProperties` |
+| `--allow-union-types`         | allow [union types](https://github.com/ajv-validator/ajv/blob/master/docs/strict-mode.md#prohibit-union-types)                                                                                         |
+| `--validate-formats=false`    | disable format validation                                                                                                                                                                              |
+| Validation and reporting      |
+| `--data`                      | use [$data references](https://github.com/ajv-validator/ajv/blob/master/docs/validation.md#data-reference)                                                                                             |
+| `--all-errors`                | collect all validation errors                                                                                                                                                                          |
+| `--verbose`                   | include schema and data in errors                                                                                                                                                                      |
+| `--comment`                   | log schema `$comment`s                                                                                                                                                                                 |
+| `--inline-refs=`              | referenced schemas compilation mode (true/false/\<number\>)                                                                                                                                            |
+| Modify validated data         |
+| `--remove-additional`         | remove additional properties (true/all/failing)                                                                                                                                                        |
+| `--use-defaults`              | replace missing properties/items with the values from default keyword                                                                                                                                  |
+| `--coerce-types`              | change type of data to match type keyword                                                                                                                                                              |
+| Advanced                      |
+| `--multiple-of-precision`     | precision of multipleOf, pass integer number                                                                                                                                                           |
+| `--messages=false`            | do not include text messages in errors                                                                                                                                                                 |
+| `--loop-required=`            | max size of `required` to compile to expression (rather than to loop)                                                                                                                                  |
+| `--loop-enum=`                | max size of `enum` to compile to expression (rather than to loop)                                                                                                                                      |
+| `--own-properties`            | only validate own properties (not relevant for JSON, but can have effect for JavaScript objects)                                                                                                       |
+| Code generation               |
+| `--code-es5`                  | generate ES5 code                                                                                                                                                                                      |
+| `--code-lines`                | generate multi-line code                                                                                                                                                                               |
+| `--code-optimize=`            | disable optimization (`false`) or number of optimization passes (1 pass by default)                                                                                                                    |
+| `--code-formats=`             | code to require formats object (only needed if you generate standalone code and do not use [ajv-formats](https://github.com/ajv-validator/ajv-formats))                                                |
 
 Options can be passed using either dash-case or camelCase.
 

package.json

@@ -6,7 +6,7 @@
     "build": "rimraf dist && tsc",
     "prepublish": "npm run build",
     "eslint": "eslint \"src/**/*.*s\" \"test/**/*.js\"",
-    "prettier:write": "prettier --write \"./**/*.{md,json,yaml,js,ts}\"",
+    "prettier:write": "prettier --write \"./**/*.{json,yaml,js,ts}\"",
     "prettier:check": "prettier --list-different \"./**/*.{md,json,yaml,js,ts}\"",
     "test-spec": "cross-env TS_NODE_PROJECT=test/tsconfig.json mocha -r ts-node/register \"test/**/*.spec.{ts,js}\" -R spec",
     "test-cov": "nyc npm run test-spec",
@@ -34,7 +34,7 @@
     "url": "https://github.com/ajv-validator/ajv-cli"
   },
   "dependencies": {
-    "ajv": "^7.1.0",
+    "ajv": "^7.2.1",
     "fast-json-patch": "^2.0.0",
     "glob": "^7.1.0",
     "js-yaml": "^3.14.0",

src/commands/ajv.ts

@@ -2,6 +2,7 @@ import type AjvCore from "ajv/dist/core"
 import type {ParsedArgs} from "minimist"
 import Ajv7, {Plugin} from "ajv"
 import Ajv2019 from "ajv/dist/2019"
+import AjvJTD from "ajv/dist/jtd"
 import {Service} from "ts-node"
 import {getOptions} from "./options"
 import * as util from "./util"
@@ -18,13 +19,19 @@ const interopRequireDefault = (obj: any): {default: any} =>
 const importDefault = <T = unknown>(moduleName: string): T =>
   interopRequireDefault(require(moduleName)).default
 
+const AjvClass: {[S in string]?: typeof AjvCore} = {
+  jtd: AjvJTD,
+  draft7: Ajv7,
+  draft2019: Ajv2019,
+}
+
 export default function (argv: ParsedArgs): AjvCore {
   const opts = getOptions(argv)
   if (argv.o) opts.code.source = true
-  const Ajv: typeof AjvCore = argv.spec === "draft2019" ? Ajv2019 : Ajv7
+  const Ajv: typeof AjvCore = AjvClass[argv.spec] || Ajv7
   const ajv = new Ajv(opts)
   let invalid: boolean | undefined
-  ajv.addMetaSchema(draft6metaSchema)
+  if (argv.spec !== "jtd") ajv.addMetaSchema(draft6metaSchema)
   addSchemas(argv.m, "addMetaSchema", "meta-schema")
   addSchemas(argv.r, "addSchema", "schema")
   customFormatsKeywords(argv.c)

src/commands/compile.ts

@@ -17,7 +17,7 @@ const cmd: Command = {
       m: {$ref: "#/$defs/stringOrArray"},
       c: {$ref: "#/$defs/stringOrArray"},
       o: {anyOf: [{type: "string", format: "notGlob"}, {type: "boolean"}]},
-      spec: {enum: ["draft7", "draft2019"]},
+      spec: {enum: ["draft7", "draft2019", "jtd"]},
     },
     ajvOptions: true,
   },

src/commands/test.ts

@@ -21,7 +21,7 @@ const cmd: Command = {
       valid: {type: "boolean"},
       invalid: {type: "boolean", enum: [true]},
       errors: {enum: ["json", "line", "text", "js", "no"]},
-      spec: {enum: ["draft7", "draft2019"]},
+      spec: {enum: ["draft7", "draft2019", "jtd"]},
     },
     ajvOptions: true,
   },

src/commands/validate.ts

@@ -20,7 +20,7 @@ const cmd: Command = {
       c: {$ref: "#/$defs/stringOrArray"},
       errors: {enum: ["json", "line", "text", "js", "no"]},
       changes: {enum: [true, "json", "line", "js"]},
-      spec: {enum: ["draft7", "draft2019"]},
+      spec: {enum: ["draft7", "draft2019", "jtd"]},
     },
     ajvOptions: true,
   },

test/compile.spec.ts

@@ -172,6 +172,15 @@ describe("compile", function () {
       done()
     })
   })
+
+  it("should compile JTD schema", (done) => {
+    cli("compile -s test/jtd/schema --spec=jtd", (error, stdout, stderr) => {
+      assert.strictEqual(error, null)
+      assertValid(stdout, 1)
+      assert.strictEqual(stderr, "")
+      done()
+    })
+  })
 })
 
 function assertValid(stdout: string, count: number): void {

test/custom/invalid_custom_ts.ts

@@ -1 +1 @@
-export = [];
+export = []

test/jtd/data.json

@@ -0,0 +1,4 @@
+{
+  "type": "a",
+  "a": 42
+}

test/jtd/invalid_data.json

@@ -0,0 +1,4 @@
+{
+  "type": "b",
+  "a": 42
+}