Adding ability to convert any's into unknown's (bcherny#281)

* Adding ability to convert any's into unknown's

* Fix snapshots

* Updating README and printHelp

Co-authored-by: Jeremy Walton <[email protected]>

Author: dl748

README.md

@@ -92,6 +92,7 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
 | unreachableDefinitions | boolean | `false` | Generates code for `definitions` that aren't referenced by the schema. |
 | strictIndexSignatures | boolean | `false` | Append all index signatures with `| undefined` so that they are strictly typed. |
 | $refOptions | object | `{}` | [$RefParser](https://github.com/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s |
+| unknownAny | boolean | `false` | Converts all `any` types into `unknown`'s |
 ## CLI
 
 A CLI utility is provided with this package.

src/cli.ts

@@ -156,6 +156,8 @@ Boolean values can be set to false using the 'no-' prefix.
       Prettier configuration
   --unreachableDefinitions
       Generates code for definitions that aren't referenced by the schema
+  --unknownAny
+      Output unknown type instead of any type
 `
   )
 }

src/generator.ts

@@ -179,7 +179,7 @@ function generateRawType(ast: AST, options: Options): string {
 
   switch (ast.type) {
     case 'ANY':
-      return 'any'
+      return options.unknownAny ? 'unknown' : 'any'
     case 'ARRAY':
       return (() => {
         const type = generateType(ast.params, options)

src/index.ts

@@ -50,6 +50,10 @@ export interface Options {
    * Generate code for `definitions` that aren't referenced by the schema?
    */
   unreachableDefinitions: boolean
+  /**
+   * Generate unknown type instead of any
+   */
+  unknownAny: boolean
   /**
    * [$RefParser](https://github.com/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s
    */
@@ -78,7 +82,8 @@ export const DEFAULT_OPTIONS: Options = {
     trailingComma: 'none',
     useTabs: false
   },
-  unreachableDefinitions: false
+  unreachableDefinitions: false,
+  unknownAny: false
 }
 
 export function compileFromFile(filename: string, options: Partial<Options> = DEFAULT_OPTIONS): Promise<string> {

test/__snapshots__/test/test.ts.md

@@ -4,6 +4,31 @@ The actual snapshot is saved in `test.ts.snap`.
 
 Generated by [AVA](https://avajs.dev).
 
+## --unknownAny
+
+> Snapshot 1
+
+    `/* tslint:disable */␊
+    /**␊
+     * This file was automatically generated by json-schema-to-typescript.␊
+     * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊
+     * and run json-schema-to-typescript to regenerate this file.␊
+     */␊
+    ␊
+    export interface ExampleSchema {␊
+      firstName: string;␊
+      lastName: string;␊
+      /**␊
+       * Age in years␊
+       */␊
+      age?: number;␊
+      height?: number;␊
+      favoriteFoods?: unknown[];␊
+      likesDogs?: boolean;␊
+      [k: string]: unknown;␊
+    }␊
+    `
+
 ## Add empty `required` property if none is defined
 
 > Snapshot 1
@@ -2016,10 +2041,9 @@ Generated by [AVA](https://avajs.dev).
      * and run json-schema-to-typescript to regenerate this file.␊
      */␊
     ␊
-    export interface BSchema {␊
-      x?: string;␊
-      y: number;␊
-      [k: string]: any;␊
+    export interface ASchema {␊
+      f: string;␊
+      g?: number;␊
     }␊
     /* tslint:disable */␊
     /**␊
@@ -2028,9 +2052,10 @@ Generated by [AVA](https://avajs.dev).
      * and run json-schema-to-typescript to regenerate this file.␊
      */␊
     ␊
-    export interface ASchema {␊
-      f: string;␊
-      g?: number;␊
+    export interface BSchema {␊
+      x?: string;␊
+      y: number;␊
+      [k: string]: any;␊
     }␊
     `
 

test/__snapshots__/test/test.ts.snap

@@ -76,6 +76,10 @@ export function run() {
     unlinkSync('./ReferencedType.d.ts')
   })
 
+  test('--unknownAny', t => {
+    t.snapshot(execSync('node dist/src/cli.js --unknownAny --input ./test/resources/ReferencedType.json').toString())
+  })
+
   test('files in (-i), files out (-o)', t => {
     execSync("node dist/src/cli.js -i './test/resources/MultiSchema/**/*.json' -o ./test/resources/MultiSchema/out")