Merge pull request bcherny#3 from forivall/feat/circular

feat: support circular schemas

package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "build": "npm run clean && mkdir dist && npm run build:browser && npm run build:server",
     "build:browser": "browserify src/index.ts -s jstt -p tsify > dist/bundle.js",
-    "build:server": "tsc -d",
+    "build:server": "tsc -d && shx chmod +x ./dist/src/cli.js",
     "clean": "shx rm -rf dist",
     "lint": "eslint src/*.ts test/*.ts",
     "tdd": "concurrently -r -p '' -k 'npm run watch' 'npm run watch:test'",

src/cli.ts

@@ -1,11 +1,17 @@
 #!/usr/bin/env node
 
+try {
+  const sms = require('source-map-support')
+  sms.install()
+} catch {}
+
 import {whiteBright} from 'cli-color'
 import minimist = require('minimist')
 import {readFile, writeFile, existsSync, lstatSync, readdirSync} from 'mz/fs'
 import * as mkdirp from 'mkdirp'
 import * as _glob from 'glob'
 import isGlob = require('is-glob')
+import * as _ from 'lodash'
 import {promisify} from 'util'
 import {join, resolve, dirname, basename} from 'path'
 import stdin = require('stdin')
@@ -20,7 +26,8 @@ main(
     alias: {
       help: ['h'],
       input: ['i'],
-      output: ['o']
+      output: ['o'],
+      verbose: ['v']
     }
   })
 )
@@ -31,9 +38,23 @@ async function main(argv: minimist.ParsedArgs) {
     process.exit(0)
   }
 
+  if (argv.verbose) {
+    process.env.VERBOSE = '1'
+  }
+
   const argIn: string = argv._[0] || argv.input
   const argOut: string | undefined = argv._[1] || argv.output // the output can be omitted so this can be undefined
 
+  function coerceBool(arg: string) {
+    const value = _.get(argv, arg)
+    const coerced = value === 'true' ? true : value === 'false' ? false : undefined
+    if (coerced !== undefined) {
+      _.set(argv, arg, coerced)
+    }
+  }
+
+  coerceBool('$refOptions.dereference.circular')
+
   const ISGLOB = isGlob(argIn)
   const ISDIR = isDir(argIn)
 

src/parser.ts

@@ -1,3 +1,4 @@
+import $RefParser = require('@apidevtools/json-schema-ref-parser')
 import {whiteBright} from 'cli-color'
 import {JSONSchema4Type, JSONSchema4TypeName} from 'json-schema'
 import {isEqual, findKey, includes, isPlainObject, map} from 'lodash'
@@ -218,6 +219,16 @@ function parseNonLiteral(
         type: 'UNION'
       })
     case 'REFERENCE':
+      if (schema.$ref === '#') {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const {$ref, ...fixedSchema} = schema
+        return parse(fixedSchema, options, rootSchema, keyName, true, processed, usedNames)
+      }
+      const resolver = new $RefParser()
+      resolver.parse(rootSchema)
+      const resolved = resolver.$refs.get(schema.$ref!)
+      log(whiteBright.bgBlue('parser'), schema.$ref, 'resolved', resolved)
+      return parse(resolved, options, rootSchema, keyName, true, processed, usedNames)
       throw Error(format('Refs should have been resolved by the resolver!', schema))
     case 'STRING':
       return set({

src/resolver.ts

@@ -8,7 +8,7 @@ export async function dereference(
   schema: JSONSchema,
   {cwd, $refOptions}: {cwd: string; $refOptions: $RefParser.Options}
 ): Promise<JSONSchema> {
-  log(whiteBright.bgGreen('resolver'), schema, cwd)
+  log(whiteBright.bgGreen('resolver'), schema, cwd, $refOptions)
   const parser = new $RefParser()
   return parser.dereference(cwd, schema as JSONSchema4, $refOptions)
 }