Pass options to $ref-resolver

Author: qm3ster

README.md

@@ -89,6 +89,7 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
 | enableConstEnums | boolean | `true` | Prepend enums with [`const`](https://www.typescriptlang.org/docs/handbook/enums.html#computed-and-constant-members)? |
 | style | object | `{ bracketSpacing: false,  printWidth: 120,  semi: true,  singleQuote: false,  tabWidth: 2,  trailingComma: 'none',  useTabs: false }` | A [Prettier](https://prettier.io/docs/en/options.html) configuration |
 | unreachableDefinitions | boolean | `false` | Generates code for `definitions` that aren't referenced by the schema. |
+| $refOptions | object | `{}` | [$RefParser](https://github.com/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s |
 ## CLI
 
 A simple CLI utility is provided with this package.

src/index.ts

@@ -11,6 +11,7 @@ import { parse } from './parser'
 import { dereference } from './resolver'
 import { error, stripExtension, Try } from './utils'
 import { validate } from './validator'
+import { Options as $RefOptions } from 'json-schema-ref-parser'
 
 export { EnumJSONSchema, JSONSchema, NamedEnumJSONSchema } from './types/JSONSchema'
 
@@ -39,6 +40,10 @@ export interface Options {
    * Generate code for `definitions` that aren't referenced by the schema?
    */
   unreachableDefinitions: boolean
+  /**
+   * [$RefParser](https://github.com/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s
+   */
+  $refOptions: $RefOptions
 }
 
 export const DEFAULT_OPTIONS: Options = {
@@ -59,7 +64,8 @@ export const DEFAULT_OPTIONS: Options = {
     trailingComma: 'none',
     useTabs: false
   },
-  unreachableDefinitions: false
+  unreachableDefinitions: false,
+  $refOptions: {}
 }
 
 export function compileFromFile(
@@ -102,7 +108,7 @@ export async function compile(
 
   return format(generate(
     optimize(
-      parse(await dereference(normalize(schema, name), _options.cwd), _options)
+      parse(await dereference(normalize(schema, name), _options), _options)
     ),
     _options
   ), _options)

src/resolver.ts

@@ -3,8 +3,8 @@ import { whiteBright } from 'cli-color'
 import { JSONSchema } from './types/JSONSchema'
 import { log } from './utils'
 
-export async function dereference(schema: JSONSchema, cwd: string): Promise<JSONSchema> {
+export async function dereference(schema: JSONSchema, {cwd, $refOptions}: {cwd: string, $refOptions: $RefParser.Options}): Promise<JSONSchema> {
   log(whiteBright.bgGreen('resolver'), schema, cwd)
   const parser = new $RefParser
-  return parser.dereference(cwd, schema, {})
+  return parser.dereference(cwd, schema, $refOptions)
 }

types/json-schema-ref-parser.d.ts

@@ -10,6 +10,8 @@ declare module 'json-schema-ref-parser' {
 
   export = $RefParser
 
+  type Options = $RefParser.Options
+
   /**
    * This is the default export of JSON Schema $Ref Parser. You can creates instances of this class using new $RefParser(), or you can just call its static methods.
    *
@@ -100,50 +102,52 @@ declare module 'json-schema-ref-parser' {
     ): Promise<$Refs>
   }
 
-  /**
-   * See https://github.com/BigstickCarpet/json-schema-ref-parser/blob/master/docs/options.md
-   */
-  type Options = object & {
-
+  namespace $RefParser{
     /**
-     * The `parse` options determine how different types of files will be parsed.
-     *
-     * JSON Schema `$Ref` Parser comes with built-in JSON, YAML, plain-text, and binary parsers, any of which you can configure or disable. You can also add your own custom parsers if you want.
+     * See https://github.com/BigstickCarpet/json-schema-ref-parser/blob/master/docs/options.md
      */
-    parse?: {
-      json?: ParserOptions | boolean
-      yaml?: ParserOptions | boolean
-      text?: (ParserOptions & { encoding?: string }) | boolean
-    }
+    export type Options = object & {
 
-    /**
-     * The `resolve` options control how JSON Schema $Ref Parser will resolve file paths and URLs, and how those files will be read/downloaded.
-     *
-     * JSON Schema `$Ref` Parser comes with built-in support for HTTP and HTTPS, as well as support for local files (when running in Node.js). You can configure or disable either of these built-in resolvers. You can also add your own custom resolvers if you want.
-     */
-    resolve?: {
+      /**
+       * The `parse` options determine how different types of files will be parsed.
+       *
+       * JSON Schema `$Ref` Parser comes with built-in JSON, YAML, plain-text, and binary parsers, any of which you can configure or disable. You can also add your own custom parsers if you want.
+       */
+      parse?: {
+        json?: ParserOptions | boolean
+        yaml?: ParserOptions | boolean
+        text?: (ParserOptions & { encoding?: string }) | boolean
+      }
 
       /**
-       * Determines whether external $ref pointers will be resolved. If this option is disabled, then external `$ref` pointers will simply be ignored.
+       * The `resolve` options control how JSON Schema $Ref Parser will resolve file paths and URLs, and how those files will be read/downloaded.
+       *
+       * JSON Schema `$Ref` Parser comes with built-in support for HTTP and HTTPS, as well as support for local files (when running in Node.js). You can configure or disable either of these built-in resolvers. You can also add your own custom resolvers if you want.
        */
-      external?: boolean
-      file?: ResolverOptions | boolean
-      http?: HTTPResolverOptions | boolean
-    }
+      resolve?: {
 
-    /**
-     * The `dereference` options control how JSON Schema `$Ref` Parser will dereference `$ref` pointers within the JSON schema.
-     */
-    dereference?: {
+        /**
+         * Determines whether external $ref pointers will be resolved. If this option is disabled, then external `$ref` pointers will simply be ignored.
+         */
+        external?: boolean
+        file?: ResolverOptions | boolean
+        http?: HTTPResolverOptions | boolean
+      }
 
       /**
-       * Determines whether circular `$ref` pointers are handled.
-       *
-       * If set to `false`, then a `ReferenceError` will be thrown if the schema contains any circular references.
-       *
-       * If set to `"ignore"`, then circular references will simply be ignored. No error will be thrown, but the `$Refs.circular` property will still be set to `true`.
+       * The `dereference` options control how JSON Schema `$Ref` Parser will dereference `$ref` pointers within the JSON schema.
        */
-      circular?: boolean | 'ignore'
+      dereference?: {
+
+        /**
+         * Determines whether circular `$ref` pointers are handled.
+         *
+         * If set to `false`, then a `ReferenceError` will be thrown if the schema contains any circular references.
+         *
+         * If set to `"ignore"`, then circular references will simply be ignored. No error will be thrown, but the `$Refs.circular` property will still be set to `true`.
+         */
+        circular?: boolean | 'ignore'
+      }
     }
   }