Merge remote-tracking branch 'upstream/master' into multi-defs

Author: sramam

.eslintrc.js

@@ -35,7 +35,6 @@ module.exports = {
         "@typescript-eslint/no-namespace": "error",
         "@typescript-eslint/no-non-null-assertion": "off",
         "max-len": ["error", { code: 120, tabWidth: 4 }],
-        "linebreak-style": ["error", "unix"],
         "no-alert": "error",
         "prefer-const": "error",
         "no-return-assign": "error",

.gitattributes

@@ -0,0 +1,2 @@
+*.ts text eol=lf
+*.js text eol=lf

.github/workflows/test.yml

@@ -27,11 +27,11 @@ jobs:
       - name: Install Node dependencies
         run: yarn --frozen-lockfile
 
-      - name: lint (only on ubuntu)
-        if: ${{ matrix.os !== 'windows-latest' }}
+      - name: Lint
         run: yarn lint
 
-      - run: yarn build
+      - name: Build
+        run: yarn build
 
       - name: Test coverage
         run: yarn jest test/ --collectCoverage=true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-json-schema-generator",
-  "version": "0.84.0",
+  "version": "0.85.0",
   "description": "Generate JSON schema from your Typescript sources",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -44,35 +44,35 @@
     "node": ">=10.0.0"
   },
   "dependencies": {
-    "@types/json-schema": "^7.0.6",
-    "commander": "^7.0.0",
+    "@types/json-schema": "^7.0.7",
+    "commander": "^7.1.0",
     "fast-json-stable-stringify": "^2.1.0",
     "glob": "^7.1.6",
     "json-stable-stringify": "^1.0.1",
-    "typescript": "~4.1.3"
+    "typescript": "~4.1.5"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
-    "@babel/preset-typescript": "^7.12.7",
+    "@babel/core": "^7.12.16",
+    "@babel/preset-env": "^7.12.16",
+    "@babel/preset-typescript": "^7.12.16",
     "@semantic-release/git": "^9.0.0",
     "@types/fast-json-stable-stringify": "^2.0.0",
     "@types/glob": "^7.1.3",
     "@types/jest": "^26.0.20",
     "@types/json-stable-stringify": "^1.0.32",
-    "@types/node": "^14.14.21",
-    "@typescript-eslint/eslint-plugin": "^4.13.0",
-    "@typescript-eslint/parser": "^4.13.0",
-    "ajv": "^7.0.3",
+    "@types/node": "^14.14.28",
+    "@typescript-eslint/eslint-plugin": "^4.15.1",
+    "@typescript-eslint/parser": "^4.15.1",
+    "ajv": "^7.1.1",
     "ajv-formats": "^1.5.1",
-    "chai": "^4.2.0",
-    "eslint": "^7.18.0",
-    "eslint-config-prettier": "^7.1.0",
+    "chai": "^4.3.0",
+    "eslint": "^7.20.0",
+    "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-prettier": "^3.3.1",
     "jest": "^26.6.3",
     "jest-junit": "^12.0.0",
     "prettier": "^2.2.1",
-    "semantic-release": "^17.3.3",
+    "semantic-release": "^17.3.9",
     "ts-node": "^9.1.1"
   },
   "scripts": {

src/NodeParser/TypeOperatorNodeParser.ts

@@ -20,6 +20,10 @@ export class TypeOperatorNodeParser implements SubNodeParser {
     public createType(node: ts.TypeOperatorNode, context: Context): BaseType {
         const type = this.childNodeParser.createType(node.type, context);
         const derefed = derefType(type);
+        // Remove readonly modifier from type
+        if (node.operator === ts.SyntaxKind.ReadonlyKeyword && derefed) {
+            return derefed;
+        }
         if (derefed instanceof ArrayType) {
             return new NumberType();
         }

src/SchemaGenerator.ts

@@ -16,10 +16,10 @@ import { JSONSchema7, JSONSchema7Definition } from "json-schema";
 
 export class SchemaGenerator {
     public constructor(
-        private readonly program: ts.Program,
-        private readonly nodeParser: NodeParser,
-        private readonly typeFormatter: TypeFormatter,
-        private readonly config?: Config
+        protected readonly program: ts.Program,
+        protected readonly nodeParser: NodeParser,
+        protected readonly typeFormatter: TypeFormatter,
+        protected readonly config?: Config
     ) {}
 
     public createSchema(fullName?: string): Schema {
@@ -62,7 +62,7 @@ export class SchemaGenerator {
         return resolveIdRefs(schema, idNameMap, this.config?.encodeRefs ?? true) as JSONSchema7;
     }
 
-    private getRootNodes(fullName: string | undefined) {
+    protected getRootNodes(fullName: string | undefined) {
         if (fullName && fullName !== "*") {
             return [this.findNamedNode(fullName)];
         } else {
@@ -75,7 +75,7 @@ export class SchemaGenerator {
             return [...rootNodes.values()];
         }
     }
-    private findNamedNode(fullName: string): ts.Node {
+    protected findNamedNode(fullName: string): ts.Node {
         const typeChecker = this.program.getTypeChecker();
         const allTypes = new Map<string, ts.Node>();
         const { projectFiles, externalFiles } = this.partitionFiles();
@@ -94,14 +94,10 @@ export class SchemaGenerator {
 
         throw new NoRootTypeError(fullName);
     }
-    private getRootTypeDefinition(rootType: BaseType): Definition {
+    protected getRootTypeDefinition(rootType: BaseType): Definition {
         return this.typeFormatter.getDefinition(rootType);
     }
-    private appendRootChildDefinitions(
-        rootType: BaseType,
-        childDefinitions: StringMap<Definition>,
-        idNameMap: Map<string, string>
-    ): void {
+    protected appendRootChildDefinitions(rootType: BaseType, childDefinitions: StringMap<Definition>, idNameMap: Map<string, string>): void {
         const seen = new Set<string>();
         const children = this.typeFormatter
             .getChildren(rootType)
@@ -134,7 +130,7 @@ export class SchemaGenerator {
             return definitions;
         }, childDefinitions);
     }
-    private partitionFiles() {
+    protected partitionFiles() {
         const projectFiles = new Array<ts.SourceFile>();
         const externalFiles = new Array<ts.SourceFile>();
 
@@ -145,7 +141,7 @@ export class SchemaGenerator {
 
         return { projectFiles, externalFiles };
     }
-    private appendTypes(
+    protected appendTypes(
         sourceFiles: readonly ts.SourceFile[],
         typeChecker: ts.TypeChecker,
         types: Map<string, ts.Node>
@@ -154,7 +150,7 @@ export class SchemaGenerator {
             this.inspectNode(sourceFile, typeChecker, types);
         }
     }
-    private inspectNode(node: ts.Node, typeChecker: ts.TypeChecker, allTypes: Map<string, ts.Node>): void {
+    protected inspectNode(node: ts.Node, typeChecker: ts.TypeChecker, allTypes: Map<string, ts.Node>): void {
         switch (node.kind) {
             case ts.SyntaxKind.InterfaceDeclaration:
             case ts.SyntaxKind.ClassDeclaration:
@@ -173,17 +169,17 @@ export class SchemaGenerator {
                 return;
         }
     }
-    private isExportType(node: ts.Node): boolean {
+    protected isExportType(node: ts.Node): boolean {
         if (this.config?.jsDoc !== "none" && hasJsDocTag(node, "internal")) {
             return false;
         }
         const localSymbol = localSymbolAtNode(node);
         return localSymbol ? "exportSymbol" in localSymbol : false;
     }
-    private isGenericType(node: ts.TypeAliasDeclaration): boolean {
+    protected isGenericType(node: ts.TypeAliasDeclaration): boolean {
         return !!(node.typeParameters && node.typeParameters.length > 0);
     }
-    private getFullName(node: ts.Node, typeChecker: ts.TypeChecker): string {
+    protected getFullName(node: ts.Node, typeChecker: ts.TypeChecker): string {
         const symbol = symbolAtNode(node)!;
         return typeChecker.getFullyQualifiedName(symbol).replace(/".*"\./, "");
     }

test/valid-data-other.test.ts

@@ -67,4 +67,5 @@ describe("valid-data-other", () => {
     it("duplicates", assertValidSchema("duplicates", "MyType"));
     it("duplicates-composition", assertValidSchema("duplicates-composition", "MyObject"));
     it("duplicates-inheritance", assertValidSchema("duplicates-inheritance", "MyObject"));
+    it("shorthand-array", assertValidSchema("shorthand-array", "MyType"));
 });

test/valid-data/duplicates/import1.ts

@@ -1 +1 @@
-export type A = number;
+export type A = number;

test/valid-data/duplicates/import2.ts

@@ -1 +1 @@
-export type A = string;
+export type A = string;

test/valid-data/duplicates/main.ts

@@ -1,4 +1,4 @@
-import {A as A1} from "./import1";
-import {A as A2} from "./import2";
-
-export type MyType = A1 | A2;
+import {A as A1} from "./import1";
+import {A as A2} from "./import2";
+
+export type MyType = A1 | A2;

test/valid-data/shorthand-array/main.ts

@@ -0,0 +1,4 @@
+export interface MyType {
+    numberArray: number[];
+    stringArray: readonly string[];
+}

test/valid-data/shorthand-array/schema.json

@@ -0,0 +1,28 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "definitions": {
+        "MyType": {
+            "type": "object",
+            "properties": {
+                "numberArray": {
+                    "type": "array",
+                    "items": {
+                        "type": "number"
+                    }
+                },
+                "stringArray": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "required": [
+                "numberArray",
+                "stringArray"
+            ],
+            "additionalProperties": false
+        }
+    },
+    "$ref": "#/definitions/MyType"
+}