Add --include flag: further limits files from tsconfig.json. (YousefED#211)

* Add --include flag: further limits files from tsconfig.json.

In a large project, it is slow and not needed to extract schemata from
all TypeScript files in `tsconfig.json` (also it can be infeasible due
to limitations of what can be converted to JSON schema).  OTOH listing
the files as the command-line argument ignores all the parameters from
`tsconfig.json`.  `--include` gets us the advantages of both.

Tests for --include flag (and programFromConfig).

(PR ready: no generated files).

* Document --include flag.

* Fix lint error.

* Update README.md

Author: arielshaqed

.gitignore

@@ -4,4 +4,6 @@ test/*.d.ts
 test/*.map
 .vscode/*.*
 npm-debug.log
-.idea
+.idea
+*~
+.#*

README.md

@@ -16,6 +16,9 @@ Generate json-schemas from your Typescript sources.
 * Install with `npm install typescript-json-schema -g`
 * Generate schema from a typescript type: `typescript-json-schema project/directory/tsconfig.json TYPE`
 
+To generate files for only _some_ types in `tsconfig.json` specify
+filenames or globs with the `--include` option. This is especially useful for large projects.
+
 In case no `tsconfig.json` is available for your project, you can directly specify the .ts files (this in this case we use some built-in compiler presets):
 
 * Generate schema from a typescript type: `typescript-json-schema "project/directory/**/*.ts" TYPE`
@@ -38,6 +41,7 @@ Options:
   --useTypeOfKeyword    Use `typeOf` keyword (https://goo.gl/DC6sni) for functions.  [boolean] [default: false]
   --out, -o             The output file, defaults to using stdout
   --validationKeywords  Provide additional validation keywords to include            [array]   [default: []]
+  --include             Further limit tsconfig to include only matching files        [array]   [default: []]
   --ignoreErrors        Generate even if the program has errors.                     [boolean] [default: false]
   --excludePrivate      Exclude private members from the schema                      [boolean] [default: false]
 ```

test/programs/tsconfig/exclude.ts

@@ -0,0 +1,5 @@
+// This file is ignored.
+
+export interface Excluded {
+    a: string;
+}

test/programs/tsconfig/includedAlways.ts

@@ -0,0 +1,5 @@
+// This file is included by tsconfig.json and --include.
+
+export interface IncludedAlways {
+    a: string;
+};

test/programs/tsconfig/includedByConfig.ts

@@ -0,0 +1,5 @@
+// This file is included by tsconfig.json.
+
+export interface IncludedOnlyByTsConfig {
+    a: string;
+};

test/programs/tsconfig/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "compilerOptions": {
+        "target": "es5",
+    },
+    "include": [
+        "**/include*.ts",
+    ]
+}

test/schema.test.ts

@@ -243,3 +243,30 @@ describe("schema", () => {
         assertSchema("builtin-names", "Ext.Foo");
     });
 });
+
+describe("tsconfig.json", () => {
+    it("should read files from tsconfig.json", () => {
+        const program = TJS.programFromConfig(resolve(BASE + "tsconfig/tsconfig.json"));
+        const generator = TJS.buildGenerator(program);
+        assert(generator !== null);
+        assert.instanceOf(generator, TJS.JsonSchemaGenerator);
+        if (generator !== null) {
+            assert.doesNotThrow(() => generator.getSchemaForSymbol("IncludedAlways"));
+            assert.doesNotThrow(() => generator.getSchemaForSymbol("IncludedOnlyByTsConfig"));
+            assert.throws(() => generator.getSchemaForSymbol("Excluded"));
+        }
+    });
+    it("should support includeOnlyFiles with tsconfig.json", () => {
+        const program = TJS.programFromConfig(
+            resolve(BASE + "tsconfig/tsconfig.json"), [resolve(BASE + "tsconfig/includedAlways.ts")]
+        );
+        const generator = TJS.buildGenerator(program);
+        assert(generator !== null);
+        assert.instanceOf(generator, TJS.JsonSchemaGenerator);
+        if (generator !== null) {
+            assert.doesNotThrow(() => generator.getSchemaForSymbol("IncludedAlways"));
+            assert.throws(() => generator.getSchemaForSymbol("Excluded"));
+            assert.throws(() => generator.getSchemaForSymbol("IncludedOnlyByTsConfig"));
+        }
+    });
+});

typescript-json-schema-cli.ts

@@ -32,6 +32,8 @@ export function run() {
             .describe("out", "The output file, defaults to using stdout")
         .array("validationKeywords").default("validationKeywords", defaultArgs.validationKeywords)
             .describe("validationKeywords", "Provide additional validation keywords to include.")
+        .array("include").default("*", defaultArgs.include)
+            .describe("include", "Further limit tsconfig to include only matching files.")
         .argv;
 
     exec(args._[0], args._[1], {
@@ -48,6 +50,7 @@ export function run() {
         ignoreErrors: args.ignoreErrors,
         out: args.out,
         validationKeywords: args.validationKeywords,
+        include: args.include,
         excludePrivate: args.excludePrivate,
     });
 }

typescript-json-schema.d.ts

@@ -18,6 +18,7 @@ export declare type Args = {
     ignoreErrors: boolean;
     out: string;
     validationKeywords: string[];
+    include: string[];
     excludePrivate: boolean;
 };
 export declare type PartialArgs = Partial<Args>;
@@ -90,5 +91,5 @@ export declare class JsonSchemaGenerator {
 export declare function getProgramFromFiles(files: string[], jsonCompilerOptions?: any, basePath?: string): ts.Program;
 export declare function buildGenerator(program: ts.Program, args?: PartialArgs): JsonSchemaGenerator | null;
 export declare function generateSchema(program: ts.Program, fullTypeName: string, args?: PartialArgs, onlyIncludeFiles?: string[]): Definition | null;
-export declare function programFromConfig(configFileName: string): ts.Program;
+export declare function programFromConfig(configFileName: string, onlyIncludeFiles?: string[]): ts.Program;
 export declare function exec(filePattern: string, fullTypeName: string, args?: Args): void;

typescript-json-schema.ts

@@ -26,6 +26,7 @@ export function getDefaultArgs(): Args {
         ignoreErrors: false,
         out: "",
         validationKeywords: [],
+        include: [],
         excludePrivate: false,
     };
 }
@@ -48,6 +49,7 @@ export type Args = {
     ignoreErrors: boolean;
     out: string;
     validationKeywords: string[];
+    include: string[];
     excludePrivate: boolean;
 };
 
@@ -1083,7 +1085,7 @@ export function generateSchema(program: ts.Program, fullTypeName: string, args:
     }
 }
 
-export function programFromConfig(configFileName: string): ts.Program {
+export function programFromConfig(configFileName: string, onlyIncludeFiles?: string[]): ts.Program {
     // basically a copy of https://github.com/Microsoft/TypeScript/blob/3663d400270ccae8b69cbeeded8ffdc8fa12d7ad/src/compiler/tsc.ts -> parseConfigFile
     const result = ts.parseConfigFileTextToJson(configFileName, ts.sys.readFile(configFileName)!);
     const configObject = result.config;
@@ -1096,7 +1098,7 @@ export function programFromConfig(configFileName: string): ts.Program {
     delete options.outFile;
     delete options.declaration;
 
-    const program = ts.createProgram(configParseResult.fileNames, options);
+    const program = ts.createProgram(onlyIncludeFiles || configParseResult.fileNames, options);
     return program;
 }
 
@@ -1111,7 +1113,11 @@ export function exec(filePattern: string, fullTypeName: string, args = getDefaul
     let program: ts.Program;
     let onlyIncludeFiles: string[] | undefined = undefined;
     if (REGEX_TSCONFIG_NAME.test(path.basename(filePattern))) {
-        program = programFromConfig(filePattern);
+        if (args.include.length > 0) {
+            const globs: string[][] = args.include.map(f => glob.sync(f));
+            onlyIncludeFiles = ([] as string[]).concat(...globs).map(normalizeFileName);
+        }
+        program = programFromConfig(filePattern, onlyIncludeFiles);
     } else {
         onlyIncludeFiles = glob.sync(filePattern);
         program = getProgramFromFiles(onlyIncludeFiles, {