upgrade version

.github/workflows/test.yml

@@ -10,8 +10,8 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
       - run: yarn --frozen-lockfile
       - name: Lint
         run: yarn lint

README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://img.shields.io/npm/v/typescript-json-schema.svg)](https://www.npmjs.com/package/typescript-json-schema) ![Test](https://github.com/YousefED/typescript-json-schema/workflows/Test/badge.svg)
 
-Generate json-schemas from your Typescript sources.
+Generate json-schemas from your Typescript sources. This library is lightweight and more or less in maintenance mode. For a more complete JSON schema generator, take a look at [ts-json-schema-generator](https://github.com/vega/ts-json-schema-generator).
 
 ## Features
 
@@ -51,6 +51,9 @@ Options:
   --id                  Set schema id.                                               [string]  [default: ""]
   --defaultNumberType   Default number type.                                         [choices: "number", "integer"] [default: "number"]
   --tsNodeRegister      Use ts-node/register (needed for require typescript files).  [boolean] [default: false]
+  --constAsEnum         Use enums with a single value when declaring constants.      [boolean] [default: false]
+  --experimentalDecorators  Use experimentalDecorators when loading typescript modules.
+   [boolean] [default: true]
 ```
 
 ### Programmatic use

api.md

@@ -230,13 +230,20 @@ interface MySubObject {
     a: boolean;
 }
 
+interface AnotherSubObject {
+    b: boolean;
+}
+
 interface MyObject {
     /**
      * @title empty#
      */
     empty;
-
+    /**
+     * @title filled
+     */
     filled: MySubObject;
+    nonTitled: AnotherSubObject;
 }
 ```
 
@@ -485,6 +492,21 @@ interface MyObject {
 ```
 
 
+## [comments-comment](./test/programs/comments-comment)
+
+```ts
+/**
+ * @$comment Object comment
+ */
+interface MyObject {
+  /**
+   * @$comment Property comment
+   */
+  text: string;
+}
+```
+
+
 ## [comments-from-lib](./test/programs/comments-from-lib)
 
 ```ts
@@ -600,6 +622,25 @@ export interface MyObject {
 ```
 
 
+## [const-as-enum](./test/programs/const-as-enum)
+
+```ts
+export interface MyObject {
+    reference: true;
+}
+```
+
+
+## [const-keyword](./test/programs/const-keyword)
+
+```ts
+const fn = <const T>(value: T) =>
+  ({ value });
+
+export type Object = ReturnType<typeof fn<"value">>;
+```
+
+
 ## [custom-dates](./test/programs/custom-dates)
 
 ```ts
@@ -1032,6 +1073,68 @@ export interface MyObject {
 ```
 
 
+## [key-in-key-of-multi](./test/programs/key-in-key-of-multi)
+
+```ts
+type Util = {
+    utilKey1: {
+        utilDeepKey11: string;
+        utilDeepKey12: number;
+    };
+    utilKey2: {
+        utilDeepKey21: boolean;
+        utilDeepKey22: null;
+    };
+};
+
+export type Main = {
+    [Key in keyof Util]: {
+        [key: string]: Util[Key];
+    };
+};
+```
+
+
+## [key-in-key-of-multi-underscores](./test/programs/key-in-key-of-multi-underscores)
+
+```ts
+type Util = {
+    __2Underscores: {
+        utilDeepKey2: string;
+    };
+    ___3Underscores: {
+        utilDeepKey3: string;
+    };
+    ____4Underscores: {
+        utilDeepKey4: string;
+    };
+};
+
+export type Main = {
+    [Key in keyof Util]: {
+        [key: string]: Util[Key];
+    };
+};
+```
+
+
+## [key-in-key-of-single](./test/programs/key-in-key-of-single)
+
+```ts
+type Util = {
+    utilKey: {
+        utilDeepKey: string;
+    };
+};
+
+export type Main = {
+    [Key in keyof Util]: {
+        [key: string]: Util[Key];
+    };
+};
+```
+
+
 ## [map-types](./test/programs/map-types)
 
 ```ts
@@ -1170,6 +1273,21 @@ export interface Never {
 ```
 
 
+## [no-ref](./test/programs/no-ref)
+
+```ts
+type MySubType = {
+    id: string;
+};
+
+export type MyModule = {
+    address: MySubType & { extraProp: number };
+    address2: MySubType;
+    address3: MySubType;
+};
+```
+
+
 ## [no-unrelated-definitions](./test/programs/no-unrelated-definitions)
 
 ```ts
@@ -1191,6 +1309,17 @@ interface SomeOtherDefinition {
 ```
 
 
+## [numeric-keys-and-others](./test/programs/numeric-keys-and-others)
+
+```ts
+interface NumericKeysAndOthers {
+    [key: number]: number;
+    a: string;
+    b: boolean;
+}
+```
+
+
 ## [object-numeric-index](./test/programs/object-numeric-index)
 
 ```ts
@@ -1280,6 +1409,26 @@ export class ObjectId {}
 ```
 
 
+## [satisfies-keyword](./test/programs/satisfies-keyword)
+
+```ts
+interface Basic {
+    a: string;
+    b: number;
+    c: boolean;
+}
+
+const myObject = {
+    a: "a" as const,
+    b: 1 as const,
+    c: true as const,
+// tslint:disable-next-line:variable-name
+} satisfies Basic;
+
+export type Specific = typeof myObject;
+```
+
+
 ## [strict-null-checks](./test/programs/strict-null-checks)
 
 ```ts
@@ -1320,6 +1469,33 @@ class MyObject {
 ```
 
 
+## [string-template-literal](./test/programs/string-template-literal)
+
+```ts
+interface MyObject {
+  a: `@${string}`,
+  b: `@${number}`,
+  c: `@${bigint}`,
+  d: `@${boolean}`,
+  e: `@${undefined}`,
+  f: `@${null}`,
+  g: `${string}@`,
+  h: `${number}@`,
+  i: `${string}@${number}`,
+  j: `${string}.${string}`,
+}
+```
+
+
+## [symbol](./test/programs/symbol)
+
+```ts
+export type MyObject = {
+    a: symbol;
+};
+```
+
+
 ## [tsconfig](./test/programs/tsconfig)
 
 ```ts
@@ -1353,6 +1529,13 @@ export interface IncludedOnlyByTsConfig {
 ```
 
 
+## [type-alias-never](./test/programs/type-alias-never)
+
+```ts
+export type MyNever = never;
+```
+
+
 ## [type-alias-or](./test/programs/type-alias-or)
 
 ```ts
@@ -1400,6 +1583,13 @@ type MyString = string;
 ```
 
 
+## [type-alias-undefined](./test/programs/type-alias-undefined)
+
+```ts
+export type MyUndefined = undefined;
+```
+
+
 ## [type-aliases](./test/programs/type-aliases)
 
 ```ts
@@ -1764,8 +1954,37 @@ interface ChildFoo {
 }
 
 interface Foo {
-    readonly childFoos: Foo & ChildFoo;
+    readonly childFoos: Foo | ChildFoo;
+}
+```
+
+
+## [type-intersection-recursive-no-additional](./test/programs/type-intersection-recursive-no-additional)
+
+```ts
+type MyRecursiveNode = {
+    next?: MyNode;
 }
+
+type MyNode = {
+    val: string;
+} & MyRecursiveNode;
+
+type MyLinkedList = MyNode;
+```
+
+
+## [type-literals](./test/programs/type-literals)
+
+```ts
+type MyObject = {
+    param1: "1" | "2" | "3";
+    param2: "1" | "2" | 3 | true;
+    /** @enum {string} */
+    param3: "1" | "2" | "3";
+    /** @enum {unknown} */
+    param4: "1" | "2" | 3 | true;
+};
 ```
 
 
@@ -1894,6 +2113,34 @@ interface MyObject {
 ```
 
 
+## [type-union-strict-null-keep-description](./test/programs/type-union-strict-null-keep-description)
+
+```ts
+/**
+ * Description of InnerObject.
+ */
+type InnerObject = {
+	/**
+	 * Description of foo.
+	 */
+	foo: string;
+};
+
+/**
+ * Description of MyObject.
+ */
+type MyObject = {
+
+	inner1?: InnerObject;
+
+	/**
+	 * Override description.
+	 */
+	inner2?: InnerObject;
+};
+```
+
+
 ## [type-union-tagged](./test/programs/type-union-tagged)
 
 ```ts
@@ -1927,6 +2174,16 @@ interface MyObject {
 ```
 
 
+## [undefined-property](./test/programs/undefined-property)
+
+```ts
+export type MyObject = {
+    a: string;
+    b: undefined;
+};
+```
+
+
 ## [unique-names](./test/programs/unique-names)
 
 ```ts