Merge pull request #1414 from vega/next

.autorc.json

@@ -0,0 +1,13 @@
+{
+    "plugins": [
+        "npm",
+        "conventional-commits",
+        "first-time-contributor",
+        "released"
+    ],
+    "baseBranch": "stable",
+    "prereleaseBranches": [
+        "next"
+    ],
+    "author": "GitHub Actions Bot <vega-actions-bot@users.noreply.github.com>"
+}

.github/workflows/publish-auto.yml

@@ -15,13 +15,14 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          # Fetch all history for all tags and branches
           fetch-depth: 0
 
       - uses: actions/setup-node@v3
         with:
           registry-url: "https://registry.npmjs.org"
-          node-version: "16"
+          cache: "yarn"
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile

.github/workflows/test.yml

@@ -39,4 +39,4 @@ jobs:
         run: yarn jest test/ --collectCoverage=true
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2.1.0
+        uses: codecov/codecov-action@v3

README.md

@@ -14,7 +14,7 @@ Inspired by [`YousefED/typescript-json-schema`](https://github.com/YousefED/type
 
 ## Contributors
 
-This project is made possible by a [community of contributors](https://github.com/vega/ts-json-schema-generator/graphs/contributors). We welcome contributions of any kind (issues, code, documentation, examples, tests,...). Please read our [code of conduct](https://github.com/vega/vega/blob/master/CODE_OF_CONDUCT.md).
+This project is made possible by a [community of contributors](https://github.com/vega/ts-json-schema-generator/graphs/contributors). We welcome contributions of any kind (issues, code, documentation, examples, tests,...). Please read our [code of conduct](https://vega.github.io/vega/about/code-of-conduct).
 
 ## CLI Usage
 
@@ -137,7 +137,8 @@ Similar to custom formatting, extending the built-in parsing works practically t
 ```ts
 // my-constructor-parser.ts
 import { Context, StringType, ReferenceType, BaseType, SubNodeParser } from "ts-json-schema-generator";
-import ts from "typescript";
+// use typescript exported by TJS to avoid version conflict
+import ts from "ts-json-schema-generator";
 
 export class MyConstructorParser implements SubNodeParser {
     supportsNode(node: ts.Node): boolean {

factory/parser.ts

@@ -22,11 +22,13 @@ import { FunctionNodeParser } from "../src/NodeParser/FunctionNodeParser";
 import { FunctionParser } from "../src/NodeParser/FunctionParser";
 import { HiddenNodeParser } from "../src/NodeParser/HiddenTypeNodeParser";
 import { IndexedAccessTypeNodeParser } from "../src/NodeParser/IndexedAccessTypeNodeParser";
+import { InferTypeNodeParser } from "../src/NodeParser/InferTypeNodeParser";
 import { InterfaceAndClassNodeParser } from "../src/NodeParser/InterfaceAndClassNodeParser";
 import { IntersectionNodeParser } from "../src/NodeParser/IntersectionNodeParser";
 import { IntrinsicNodeParser } from "../src/NodeParser/IntrinsicNodeParser";
 import { LiteralNodeParser } from "../src/NodeParser/LiteralNodeParser";
 import { MappedTypeNodeParser } from "../src/NodeParser/MappedTypeNodeParser";
+import { NamedTupleMemberNodeParser } from "../src/NodeParser/NamedTupleMemberNodeParser";
 import { NeverTypeNodeParser } from "../src/NodeParser/NeverTypeNodeParser";
 import { NullLiteralNodeParser } from "../src/NodeParser/NullLiteralNodeParser";
 import { NumberLiteralNodeParser } from "../src/NodeParser/NumberLiteralNodeParser";
@@ -120,8 +122,8 @@ export function createParser(program: ts.Program, config: Config, augmentor?: Pa
 
         .addNodeParser(new TypeReferenceNodeParser(typeChecker, chainNodeParser))
         .addNodeParser(new ExpressionWithTypeArgumentsNodeParser(typeChecker, chainNodeParser))
-
-        .addNodeParser(new IndexedAccessTypeNodeParser(chainNodeParser))
+        .addNodeParser(new IndexedAccessTypeNodeParser(typeChecker, chainNodeParser))
+        .addNodeParser(new InferTypeNodeParser(typeChecker, chainNodeParser))
         .addNodeParser(new TypeofNodeParser(typeChecker, chainNodeParser))
         .addNodeParser(new MappedTypeNodeParser(chainNodeParser, mergedConfig.additionalProperties))
         .addNodeParser(new ConditionalTypeNodeParser(typeChecker, chainNodeParser))
@@ -130,6 +132,7 @@ export function createParser(program: ts.Program, config: Config, augmentor?: Pa
         .addNodeParser(new UnionNodeParser(typeChecker, chainNodeParser))
         .addNodeParser(new IntersectionNodeParser(typeChecker, chainNodeParser))
         .addNodeParser(new TupleNodeParser(typeChecker, chainNodeParser))
+        .addNodeParser(new NamedTupleMemberNodeParser(chainNodeParser))
         .addNodeParser(new OptionalTypeNodeParser(chainNodeParser))
         .addNodeParser(new RestTypeNodeParser(chainNodeParser))
 

factory/program.ts

@@ -1,6 +1,7 @@
 import * as glob from "glob";
 import * as path from "path";
 import ts from "typescript";
+import normalize from "normalize-path";
 
 import { Config } from "../src/Config";
 import { DiagnosticError } from "../src/Error/DiagnosticError";
@@ -59,7 +60,7 @@ function getTsConfig(config: Config) {
 }
 
 export function createProgram(config: Config): ts.Program {
-    const rootNamesFromPath = config.path ? glob.sync(path.resolve(config.path)) : [];
+    const rootNamesFromPath = config.path ? glob.sync(normalize(path.resolve(config.path))) : [];
     const tsconfig = getTsConfig(config);
     const rootNames = rootNamesFromPath.length ? rootNamesFromPath : tsconfig.fileNames;
 

index.ts

@@ -1,43 +1,72 @@
 export * from "./src/Error/BaseError";
-export * from "./src/Error/LogicError";
 export * from "./src/Error/DiagnosticError";
+export * from "./src/Error/LogicError";
+export * from "./src/Error/NoRootNamesError";
 export * from "./src/Error/NoRootTypeError";
+export * from "./src/Error/NoTSConfigError";
 export * from "./src/Error/UnknownNodeError";
 export * from "./src/Error/UnknownTypeError";
 
 export * from "./src/Config";
 
-export * from "./src/Utils/StringMap";
-export * from "./src/Utils/uniqueArray";
-export * from "./src/Utils/formatError";
+export * from "./src/Utils/allOfDefinition";
+export * from "./src/Utils/assert";
+export * from "./src/Utils/deepMerge";
 export * from "./src/Utils/derefType";
+export * from "./src/Utils/extractLiterals";
+export * from "./src/Utils/formatError";
+export * from "./src/Utils/hasJsDocTag";
+export * from "./src/Utils/intersectionOfArrays";
+export * from "./src/Utils/isAssignableTo";
+export * from "./src/Utils/isHidden";
+export * from "./src/Utils/modifiers";
+export * from "./src/Utils/narrowType";
+export * from "./src/Utils/nodeKey";
+export * from "./src/Utils/notNever";
+export * from "./src/Utils/preserveAnnotation";
+export * from "./src/Utils/removeUndefined";
+export * from "./src/Utils/removeUnreachable";
+export * from "./src/Utils/StringMap";
+export * from "./src/Utils/String";
 export * from "./src/Utils/symbolAtNode";
+export * from "./src/Utils/typeKeys";
+export * from "./src/Utils/typeName";
+export * from "./src/Utils/uniqueArray";
+export * from "./src/Utils/uniqueTypeArray";
+
+export * from "./src/Interfaces/AnnotationsReader";
+export * from "./src/Interfaces/MutableParser";
 
 export * from "./src/Schema/Definition";
 export * from "./src/Schema/Schema";
 
-export * from "./src/Type/BaseType";
+export * from "./src/Type/AliasType";
+export * from "./src/Type/AnnotatedType";
 export * from "./src/Type/AnyType";
-export * from "./src/Type/NullType";
-export * from "./src/Type/UndefinedType";
-export * from "./src/Type/PrimitiveType";
-export * from "./src/Type/BooleanType";
-export * from "./src/Type/NumberType";
-export * from "./src/Type/StringType";
-export * from "./src/Type/LiteralType";
 export * from "./src/Type/ArrayType";
-export * from "./src/Type/UnionType";
+export * from "./src/Type/BaseType";
+export * from "./src/Type/BooleanType";
+export * from "./src/Type/DefinitionType";
+export * from "./src/Type/EnumType";
+export * from "./src/Type/FunctionType";
 export * from "./src/Type/IntersectionType";
-export * from "./src/Type/TupleType";
+export * from "./src/Type/LiteralType";
+export * from "./src/Type/NeverType";
+export * from "./src/Type/NullType";
+export * from "./src/Type/NumberType";
 export * from "./src/Type/ObjectType";
-export * from "./src/Type/EnumType";
-export * from "./src/Type/AliasType";
+export * from "./src/Type/OptionalType";
+export * from "./src/Type/PrimitiveType";
 export * from "./src/Type/ReferenceType";
-export * from "./src/Type/DefinitionType";
-export * from "./src/Type/AnnotatedType";
-export * from "./src/Type/FunctionType";
+export * from "./src/Type/RestType";
+export * from "./src/Type/StringType";
+export * from "./src/Type/SymbolType";
+export * from "./src/Type/TupleType";
+export * from "./src/Type/UndefinedType";
+export * from "./src/Type/UnionType";
+export * from "./src/Type/UnknownType";
+export * from "./src/Type/VoidType";
 
-export * from "./src/AnnotationsReader";
 export * from "./src/AnnotationsReader/BasicAnnotationsReader";
 export * from "./src/AnnotationsReader/ExtendedAnnotationsReader";
 
@@ -46,61 +75,89 @@ export * from "./src/SubTypeFormatter";
 export * from "./src/ChainTypeFormatter";
 export * from "./src/MutableTypeFormatter";
 export * from "./src/CircularReferenceTypeFormatter";
+export * from "./src/TypeFormatter/AliasTypeFormatter";
+export * from "./src/TypeFormatter/AnnotatedTypeFormatter";
 export * from "./src/TypeFormatter/AnyTypeFormatter";
-export * from "./src/TypeFormatter/UnknownTypeFormatter";
-export * from "./src/TypeFormatter/NullTypeFormatter";
-export * from "./src/TypeFormatter/UndefinedTypeFormatter";
+export * from "./src/TypeFormatter/ArrayTypeFormatter";
 export * from "./src/TypeFormatter/BooleanTypeFormatter";
+export * from "./src/TypeFormatter/DefinitionTypeFormatter";
+export * from "./src/TypeFormatter/EnumTypeFormatter";
+export * from "./src/TypeFormatter/IntersectionTypeFormatter";
+export * from "./src/TypeFormatter/LiteralTypeFormatter";
+export * from "./src/TypeFormatter/LiteralUnionTypeFormatter";
+export * from "./src/TypeFormatter/NeverTypeFormatter";
+export * from "./src/TypeFormatter/NullTypeFormatter";
 export * from "./src/TypeFormatter/NumberTypeFormatter";
+export * from "./src/TypeFormatter/ObjectTypeFormatter";
+export * from "./src/TypeFormatter/OptionalTypeFormatter";
+export * from "./src/TypeFormatter/PrimitiveUnionTypeFormatter";
+export * from "./src/TypeFormatter/ReferenceTypeFormatter";
+export * from "./src/TypeFormatter/RestTypeFormatter";
 export * from "./src/TypeFormatter/StringTypeFormatter";
-export * from "./src/TypeFormatter/LiteralTypeFormatter";
-export * from "./src/TypeFormatter/ArrayTypeFormatter";
+export * from "./src/TypeFormatter/SymbolTypeFormatter";
 export * from "./src/TypeFormatter/TupleTypeFormatter";
+export * from "./src/TypeFormatter/UndefinedTypeFormatter";
 export * from "./src/TypeFormatter/UnionTypeFormatter";
-export * from "./src/TypeFormatter/IntersectionTypeFormatter";
-export * from "./src/TypeFormatter/ObjectTypeFormatter";
-export * from "./src/TypeFormatter/EnumTypeFormatter";
-export * from "./src/TypeFormatter/AliasTypeFormatter";
-export * from "./src/TypeFormatter/ReferenceTypeFormatter";
-export * from "./src/TypeFormatter/DefinitionTypeFormatter";
-export * from "./src/TypeFormatter/PrimitiveUnionTypeFormatter";
-export * from "./src/TypeFormatter/LiteralUnionTypeFormatter";
-export * from "./src/TypeFormatter/AnnotatedTypeFormatter";
+export * from "./src/TypeFormatter/UnknownTypeFormatter";
+export * from "./src/TypeFormatter/VoidTypeFormatter";
 
 export * from "./src/NodeParser";
 export * from "./src/SubNodeParser";
 export * from "./src/ChainNodeParser";
 export * from "./src/ExposeNodeParser";
 export * from "./src/TopRefNodeParser";
 export * from "./src/CircularReferenceNodeParser";
+export * from "./src/NodeParser/AnnotatedNodeParser";
 export * from "./src/NodeParser/AnyTypeNodeParser";
-export * from "./src/NodeParser/UnknownTypeNodeParser";
-export * from "./src/NodeParser/LiteralNodeParser";
-export * from "./src/NodeParser/NullLiteralNodeParser";
-export * from "./src/NodeParser/UndefinedTypeNodeParser";
-export * from "./src/NodeParser/NeverTypeNodeParser";
-export * from "./src/NodeParser/NumberLiteralNodeParser";
-export * from "./src/NodeParser/StringLiteralNodeParser";
+export * from "./src/NodeParser/ArrayLiteralExpressionNodeParser";
+export * from "./src/NodeParser/ArrayNodeParser";
+export * from "./src/NodeParser/AsExpressionNodeParser";
 export * from "./src/NodeParser/BooleanLiteralNodeParser";
 export * from "./src/NodeParser/BooleanTypeNodeParser";
-export * from "./src/NodeParser/NumberTypeNodeParser";
-export * from "./src/NodeParser/StringTypeNodeParser";
+export * from "./src/NodeParser/CallExpressionParser";
+export * from "./src/NodeParser/ConditionalTypeNodeParser";
 export * from "./src/NodeParser/EnumNodeParser";
 export * from "./src/NodeParser/ExpressionWithTypeArgumentsNodeParser";
+export * from "./src/NodeParser/FunctionNodeParser";
+export * from "./src/NodeParser/FunctionParser";
+export * from "./src/NodeParser/HiddenTypeNodeParser";
+export * from "./src/NodeParser/IndexedAccessTypeNodeParser";
 export * from "./src/NodeParser/InterfaceAndClassNodeParser";
+export * from "./src/NodeParser/IntersectionNodeParser";
+export * from "./src/NodeParser/IntrinsicNodeParser";
+export * from "./src/NodeParser/LiteralNodeParser";
+export * from "./src/NodeParser/MappedTypeNodeParser";
+export * from "./src/NodeParser/NeverTypeNodeParser";
+export * from "./src/NodeParser/NullLiteralNodeParser";
+export * from "./src/NodeParser/NumberLiteralNodeParser";
+export * from "./src/NodeParser/NumberTypeNodeParser";
+export * from "./src/NodeParser/ObjectLiteralExpressionNodeParser";
+export * from "./src/NodeParser/ObjectTypeNodeParser";
+export * from "./src/NodeParser/OptionalTypeNodeParser";
+export * from "./src/NodeParser/ParameterParser";
 export * from "./src/NodeParser/ParenthesizedNodeParser";
+export * from "./src/NodeParser/PrefixUnaryExpressionNodeParser";
+export * from "./src/NodeParser/PropertyAccessExpressionParser";
+export * from "./src/NodeParser/RestTypeNodeParser";
+export * from "./src/NodeParser/StringLiteralNodeParser";
+export * from "./src/NodeParser/StringTemplateLiteralNodeParser";
+export * from "./src/NodeParser/StringTypeNodeParser";
+export * from "./src/NodeParser/SymbolTypeNodeParser";
+export * from "./src/NodeParser/TupleNodeParser";
 export * from "./src/NodeParser/TypeAliasNodeParser";
 export * from "./src/NodeParser/TypeLiteralNodeParser";
+export * from "./src/NodeParser/TypeofNodeParser";
+export * from "./src/NodeParser/TypeOperatorNodeParser";
 export * from "./src/NodeParser/TypeReferenceNodeParser";
-export * from "./src/NodeParser/ArrayNodeParser";
-export * from "./src/NodeParser/IntersectionNodeParser";
+export * from "./src/NodeParser/UndefinedLiteralNodeParser";
+export * from "./src/NodeParser/UndefinedTypeNodeParser";
 export * from "./src/NodeParser/UnionNodeParser";
-export * from "./src/NodeParser/TupleNodeParser";
-export * from "./src/NodeParser/AnnotatedNodeParser";
-export * from "./src/NodeParser/CallExpressionParser";
-export * from "./src/NodeParser/ConditionalTypeNodeParser";
-export * from "./src/NodeParser/PrefixUnaryExpressionNodeParser";
+export * from "./src/NodeParser/UnknownTypeNodeParser";
+export * from "./src/NodeParser/VoidTypeNodeParser";
 
 export * from "./src/SchemaGenerator";
 
 export * from "./factory";
+
+import ts from "typescript";
+export { ts };