add useFileCompiler setting

enables getting type-checking
while enforcing --isolatedModules

fix
ivogabe#613

Author: Max Heiber

lib/main.ts

@@ -59,7 +59,11 @@ function getFinalTransformers(getCustomTransformers?: GetCustomTransformers): Fi
 	return null;
 }
 
-function getTypeScript(typescript: typeof ts) {
+function getTypeScript(settingsTs: typeof ts, gulpTsSettingsTs: typeof ts) {
+	if (settingsTs && gulpTsSettingsTs && settingsTs !== gulpTsSettingsTs) {
+		throw Error("settings.typescript and gulpTsSettings.typescript aren't equal. Please specify only one or use the same `typescript` for both.");
+	}
+	const typescript = settingsTs || gulpTsSettingsTs;
 	if (typescript) return typescript;
 	try {
 		return require('typescript');
@@ -166,80 +170,99 @@ module compile {
 		// Unsupported by gulp-typescript
 		sourceRoot?: string; // Use sourceRoot in gulp-sourcemaps instead
 	}
+
+	export interface GulpTsSettings {
+		useFileCompiler?: boolean;
+		typescript?: typeof ts;
+	}
+
 	export type Project = _project.Project;
 	export type CompileStream = _project.ICompileStream;
 	export import reporter = _reporter;
 
-	export function createProject(tsConfigFileName: string, settings?: Settings): Project;
-	export function createProject(settings?: Settings): Project;
-	export function createProject(fileNameOrSettings?: string | Settings, settings?: Settings): Project {
+	function _createProject({
+		tsConfigFileName,
+		settings,
+		gulpTsSettings
+	}: {
+		tsConfigFileName: string | undefined;
+		settings: Settings;
+		gulpTsSettings: GulpTsSettings;
+	}): Project {
 		let finalTransformers: FinalTransformers;
-		let tsConfigFileName: string = undefined;
 		let tsConfigContent: TsConfig = undefined;
 		let projectDirectory = process.cwd();
 		let typescript: typeof ts;
 		let compilerOptions: ts.CompilerOptions;
 		let projectReferences: ReadonlyArray<ts.ProjectReference>;
-		let fileName: string;
 
 		let rawConfig: any;
 
-		if (fileNameOrSettings !== undefined) {
-			if (typeof fileNameOrSettings === 'string') {
-				fileName = fileNameOrSettings;
-				tsConfigFileName = path.resolve(process.cwd(), fileName);
-				projectDirectory = path.dirname(tsConfigFileName);
-				if (settings === undefined) settings = {};
-			} else {
-				settings = fileNameOrSettings || {};
-			}
-
-			finalTransformers = getFinalTransformers(settings.getCustomTransformers);
+		finalTransformers = getFinalTransformers(settings.getCustomTransformers);
 
-			typescript = getTypeScript(settings.typescript);
-			settings = checkAndNormalizeSettings(settings);
+		typescript = getTypeScript(settings.typescript, gulpTsSettings.typescript);
+		settings = checkAndNormalizeSettings(settings);
 
-			const settingsResult = typescript.convertCompilerOptionsFromJson(settings, projectDirectory);
-
-			if (settingsResult.errors) {
-				reportErrors(settingsResult.errors, typescript);
-			}
+		const settingsResult = typescript.convertCompilerOptionsFromJson(settings, projectDirectory);
 
-			compilerOptions = settingsResult.options;
+		if (settingsResult.errors) {
+			reportErrors(settingsResult.errors, typescript);
+		}
 
-			if (fileName !== undefined) {
-				let tsConfig = typescript.readConfigFile(tsConfigFileName, typescript.sys.readFile);
-				if (tsConfig.error) {
-					console.log(tsConfig.error.messageText);
-				}
+		compilerOptions = settingsResult.options;
 
-				let parsed: ts.ParsedCommandLine =
-					typescript.parseJsonConfigFileContent(
-						tsConfig.config || {},
-						getTsconfigSystem(typescript),
-						path.resolve(projectDirectory),
-						compilerOptions,
-						tsConfigFileName);
+		if (tsConfigFileName !== undefined) {
+			let tsConfig = typescript.readConfigFile(tsConfigFileName, typescript.sys.readFile);
+			if (tsConfig.error) {
+				console.log(tsConfig.error.messageText);
+			}
 
-				rawConfig = parsed.raw;
+			let parsed: ts.ParsedCommandLine =
+				typescript.parseJsonConfigFileContent(
+					tsConfig.config || {},
+					getTsconfigSystem(typescript),
+					path.resolve(projectDirectory),
+					compilerOptions,
+					tsConfigFileName);
 
-				tsConfigContent = parsed.raw;
+			rawConfig = parsed.raw;
 
-				if (parsed.errors) {
-					reportErrors(parsed.errors, typescript, [18003]);
-				}
+			tsConfigContent = parsed.raw;
 
-				compilerOptions = parsed.options;
-				projectReferences = parsed.projectReferences;
+			if (parsed.errors) {
+				reportErrors(parsed.errors, typescript, [18003]);
 			}
+
+			compilerOptions = parsed.options;
+			projectReferences = parsed.projectReferences;
 		}
 
 		normalizeCompilerOptions(compilerOptions, typescript);
-		const project = _project.setupProject(projectDirectory, tsConfigFileName, rawConfig, tsConfigContent, compilerOptions, projectReferences, typescript, finalTransformers);
+		const project = _project.setupProject(projectDirectory, tsConfigFileName, rawConfig, tsConfigContent, compilerOptions, projectReferences, typescript, finalTransformers, gulpTsSettings.useFileCompiler);
 
 		return project;
 	}
 
+	export function createProject(tsConfigFileName: string, settings?: Settings, gulpTsSettings?: GulpTsSettings): Project;
+	export function createProject(settings?: Settings, gulpTsSettings?: GulpTsSettings): Project;
+
+	export function createProject(fileNameOrSettings?: string | Settings, settingsOrGulpTsSettings?: Settings | GulpTsSettings, gulpTsSettingsParam?: GulpTsSettings): Project {
+		// overload: createProject(tsConfigFileName, settings, gulpTsSettings)
+		if (typeof fileNameOrSettings === 'string') {
+			return _createProject({
+				tsConfigFileName: fileNameOrSettings,
+				settings: settingsOrGulpTsSettings || {},
+				gulpTsSettings: gulpTsSettingsParam || {} }
+			);
+		}
+		// overload: createProject(settings, gulpTsSettings)
+		return _createProject({
+			tsConfigFileName: undefined,
+			settings: fileNameOrSettings || {},
+			gulpTsSettings: settingsOrGulpTsSettings as GulpTsSettings || {} }
+		);
+	}
+
 	export function filter(...args: any[]) {
 		utils.deprecate('ts.filter() is deprecated',
 			'soon you can use tsProject.resolve()',

lib/project.ts

@@ -50,17 +50,24 @@ export interface ProjectInfo {
 	reporter: Reporter;
 }
 
-export function setupProject(projectDirectory: string, configFileName: string, rawConfig: any, config: TsConfig, options: ts.CompilerOptions, projectReferences: ReadonlyArray<ts.ProjectReference>, typescript: typeof ts, finalTransformers: FinalTransformers) {
+export function setupProject(projectDirectory: string, configFileName: string, rawConfig: any, config: TsConfig, options: ts.CompilerOptions, projectReferences: ReadonlyArray<ts.ProjectReference>, typescript: typeof ts, finalTransformers: FinalTransformers, useFileCompiler: boolean | undefined) {
 	const input = new FileCache(typescript, options);
-	const compiler: ICompiler = options.isolatedModules ? new FileCompiler() : new ProjectCompiler();
-	let running = false;
+	if (useFileCompiler && !options.isolatedModules) {
+		throw Error("useFileCompiler: true can only be used if config.compilerOptions.isolatedModules is also set to true");
+	}
+    let compiler: ICompiler;
 
-	if (options.isolatedModules) {
+	if (options.isolatedModules && (useFileCompiler === undefined || useFileCompiler === true)) {
+        compiler = new FileCompiler();
 		options.newLine = typescript.NewLineKind.LineFeed;
 		options.sourceMap = false;
 		options.declaration = false;
 		options.inlineSourceMap = true;
-	}
+    }
+    else {
+        compiler = new ProjectCompiler();
+    }
+	let running = false;
 
 	const project: PartialProject = (reporter) => {
 		if (running) {

readme.md

@@ -44,7 +44,7 @@ Almost all options from TypeScript are supported.
 - `noEmitOnError` (boolean) - Do not emit outputs if any type checking errors were reported.
 - `noEmitHelpers` (boolean) - Do not generate custom helper functions like __extends in compiled output.
 - `preserveConstEnums` (boolean) - Do not erase const enum declarations in generated code. 
-- `isolatedModules` (boolean) - Compiles files seperately and doesn't check types, which causes a big speed increase. You have to use gulp-plumber and TypeScript 1.5+.
+- `isolatedModules` (boolean) - By default, this option compiles files seperately and doesn't check types, which causes a big speed increase. You have to use gulp-plumber and TypeScript 1.5+. If you use the `createProject` API (see below) and specify `useFileCompiler: false`, the meaning changes to match that of `tsc`. That is, you *will* get type-checking at the cost of slower compilation. In addition, TypeScript will error on constructs that would prevent safe separate compilation.
 - `allowJs` (boolean) - Allow JavaScript files to be compiled.
 - `rootDir` - Specifies the root directory of input files. Only use to control the output directory structure with `outDir`.
 
@@ -60,7 +60,8 @@ API overview
 gulp-typescript can be imported using `const ts = require('gulp-typescript');`. It provides the following functions:
 
 - `ts(options?)` - Returns a gulp stream that compiles TypeScript files using the specified options.
-- `ts.createProject(options?)`, `ts.createProject(tsconfig filename, options?)` - Returns a project. The intended usage is to create a project outside of a task with `const tsProject = ts.createProject(..);`. Within a task, `tsProject()` can be used to compile a stream of TypeScript files.
+- `ts.createProject(options?)`, `ts.createProject(tsconfig filename?: string, options?: CompilerOptions, gulpTsOptions?: GulpTsOptions)` - Returns a project. The intended usage is to create a project outside of a task with `const tsProject = ts.createProject(..);`. Within a task, `tsProject()` can be used to compile a stream of TypeScript files. The shape of `GulpTsOptions` is `{ useFileCompiler: boolean, typescript: TS }`. `useFileCompiler` defaults to `true` when `isolatedModules` is `true`. Specify `useFileCompiler: false` to use the project compiler even if `isolatedModules` is `true`.
+> The important differences are that the project compiler does type checking but the file compiler is faster and more more memory-efficient. Using `isolatedModules` and `useFileCompiler: false` together does extra type-checking that ensures that `useFileCompiler: true` *would* be safe.
 - `tsProject.src()` - Returns a stream containing the source files (.ts) from a tsconfig file. It can only be used if you create a project with a `tsconfig.json` file. It is a replacement for `gulp.src(..)`.
 
 Both `ts(..)` and `tsProject()` provide sub-streams that only contain the JavaScript or declaration files. An example is shown later in the readme.

release/main.d.ts

@@ -41,11 +41,15 @@ declare module compile {
         [name: string]: any;
         sourceRoot?: string;
     }
+    interface GulpTsSettings {
+        useFileCompiler?: boolean;
+        typescript?: typeof ts;
+    }
     type Project = _project.Project;
     type CompileStream = _project.ICompileStream;
     export import reporter = _reporter;
-    function createProject(tsConfigFileName: string, settings?: Settings): Project;
-    function createProject(settings?: Settings): Project;
+    function createProject(tsConfigFileName: string, settings?: Settings, gulpTsSettings?: GulpTsSettings): Project;
+    function createProject(settings?: Settings, gulpTsSettings?: GulpTsSettings): Project;
     function filter(...args: any[]): void;
 }
 export = compile;

release/main.js

@@ -49,7 +49,11 @@ function getFinalTransformers(getCustomTransformers) {
     }
     return null;
 }
-function getTypeScript(typescript) {
+function getTypeScript(settingsTs, gulpTsSettingsTs) {
+    if (settingsTs && gulpTsSettingsTs && settingsTs !== gulpTsSettingsTs) {
+        throw Error("settings.typescript and gulpTsSettings.typescript aren't equal. Please specify only one or use the same `typescript` for both.");
+    }
+    const typescript = settingsTs || gulpTsSettingsTs;
     if (typescript)
         return typescript;
     try {
@@ -98,54 +102,56 @@ function reportErrors(errors, typescript, ignore = []) {
 }
 (function (compile) {
     compile.reporter = _reporter;
-    function createProject(fileNameOrSettings, settings) {
+    function _createProject({ tsConfigFileName, settings, gulpTsSettings }) {
         let finalTransformers;
-        let tsConfigFileName = undefined;
         let tsConfigContent = undefined;
         let projectDirectory = process.cwd();
         let typescript;
         let compilerOptions;
         let projectReferences;
-        let fileName;
         let rawConfig;
-        if (fileNameOrSettings !== undefined) {
-            if (typeof fileNameOrSettings === 'string') {
-                fileName = fileNameOrSettings;
-                tsConfigFileName = path.resolve(process.cwd(), fileName);
-                projectDirectory = path.dirname(tsConfigFileName);
-                if (settings === undefined)
-                    settings = {};
-            }
-            else {
-                settings = fileNameOrSettings || {};
-            }
-            finalTransformers = getFinalTransformers(settings.getCustomTransformers);
-            typescript = getTypeScript(settings.typescript);
-            settings = checkAndNormalizeSettings(settings);
-            const settingsResult = typescript.convertCompilerOptionsFromJson(settings, projectDirectory);
-            if (settingsResult.errors) {
-                reportErrors(settingsResult.errors, typescript);
+        finalTransformers = getFinalTransformers(settings.getCustomTransformers);
+        typescript = getTypeScript(settings.typescript, gulpTsSettings.typescript);
+        settings = checkAndNormalizeSettings(settings);
+        const settingsResult = typescript.convertCompilerOptionsFromJson(settings, projectDirectory);
+        if (settingsResult.errors) {
+            reportErrors(settingsResult.errors, typescript);
+        }
+        compilerOptions = settingsResult.options;
+        if (tsConfigFileName !== undefined) {
+            let tsConfig = typescript.readConfigFile(tsConfigFileName, typescript.sys.readFile);
+            if (tsConfig.error) {
+                console.log(tsConfig.error.messageText);
             }
-            compilerOptions = settingsResult.options;
-            if (fileName !== undefined) {
-                let tsConfig = typescript.readConfigFile(tsConfigFileName, typescript.sys.readFile);
-                if (tsConfig.error) {
-                    console.log(tsConfig.error.messageText);
-                }
-                let parsed = typescript.parseJsonConfigFileContent(tsConfig.config || {}, getTsconfigSystem(typescript), path.resolve(projectDirectory), compilerOptions, tsConfigFileName);
-                rawConfig = parsed.raw;
-                tsConfigContent = parsed.raw;
-                if (parsed.errors) {
-                    reportErrors(parsed.errors, typescript, [18003]);
-                }
-                compilerOptions = parsed.options;
-                projectReferences = parsed.projectReferences;
+            let parsed = typescript.parseJsonConfigFileContent(tsConfig.config || {}, getTsconfigSystem(typescript), path.resolve(projectDirectory), compilerOptions, tsConfigFileName);
+            rawConfig = parsed.raw;
+            tsConfigContent = parsed.raw;
+            if (parsed.errors) {
+                reportErrors(parsed.errors, typescript, [18003]);
             }
+            compilerOptions = parsed.options;
+            projectReferences = parsed.projectReferences;
         }
         normalizeCompilerOptions(compilerOptions, typescript);
-        const project = _project.setupProject(projectDirectory, tsConfigFileName, rawConfig, tsConfigContent, compilerOptions, projectReferences, typescript, finalTransformers);
+        const project = _project.setupProject(projectDirectory, tsConfigFileName, rawConfig, tsConfigContent, compilerOptions, projectReferences, typescript, finalTransformers, gulpTsSettings.useFileCompiler);
         return project;
     }
+    function createProject(fileNameOrSettings, settingsOrGulpTsSettings, gulpTsSettingsParam) {
+        // overload: createProject(tsConfigFileName, settings, gulpTsSettings)
+        if (typeof fileNameOrSettings === 'string') {
+            return _createProject({
+                tsConfigFileName: fileNameOrSettings,
+                settings: settingsOrGulpTsSettings || {},
+                gulpTsSettings: gulpTsSettingsParam || {}
+            });
+        }
+        // overload: createProject(settings, gulpTsSettings)
+        return _createProject({
+            tsConfigFileName: undefined,
+            settings: fileNameOrSettings || {},
+            gulpTsSettings: settingsOrGulpTsSettings || {}
+        });
+    }
     compile.createProject = createProject;
     function filter(...args) {
         utils.deprecate('ts.filter() is deprecated', 'soon you can use tsProject.resolve()', 'Filters have been removed as of gulp-typescript 3.0.\nSoon tsProject.resolve() will be available as an alternative.\nSee https://github.com/ivogabe/gulp-typescript/issues/190.');

release/project.d.ts

@@ -28,7 +28,7 @@ export interface ProjectInfo {
     directory: string;
     reporter: Reporter;
 }
-export declare function setupProject(projectDirectory: string, configFileName: string, rawConfig: any, config: TsConfig, options: ts.CompilerOptions, projectReferences: ReadonlyArray<ts.ProjectReference>, typescript: typeof ts, finalTransformers: FinalTransformers): Project;
+export declare function setupProject(projectDirectory: string, configFileName: string, rawConfig: any, config: TsConfig, options: ts.CompilerOptions, projectReferences: ReadonlyArray<ts.ProjectReference>, typescript: typeof ts, finalTransformers: FinalTransformers, useFileCompiler: boolean | undefined): Project;
 export interface ICompileStream extends NodeJS.ReadWriteStream {
     js: stream.Readable;
     dts: stream.Readable;

release/project.js

@@ -18,16 +18,23 @@ const reporter_1 = require("./reporter");
 const input_1 = require("./input");
 const output_1 = require("./output");
 const compiler_1 = require("./compiler");
-function setupProject(projectDirectory, configFileName, rawConfig, config, options, projectReferences, typescript, finalTransformers) {
+function setupProject(projectDirectory, configFileName, rawConfig, config, options, projectReferences, typescript, finalTransformers, useFileCompiler) {
     const input = new input_1.FileCache(typescript, options);
-    const compiler = options.isolatedModules ? new compiler_1.FileCompiler() : new compiler_1.ProjectCompiler();
-    let running = false;
-    if (options.isolatedModules) {
+    if (useFileCompiler && !options.isolatedModules) {
+        throw Error("useFileCompiler: true can only be used if config.compilerOptions.isolatedModules is also set to true");
+    }
+    let compiler;
+    if (options.isolatedModules && (useFileCompiler === undefined || useFileCompiler === true)) {
+        compiler = new compiler_1.FileCompiler();
         options.newLine = typescript.NewLineKind.LineFeed;
         options.sourceMap = false;
         options.declaration = false;
         options.inlineSourceMap = true;
     }
+    else {
+        compiler = new compiler_1.ProjectCompiler();
+    }
+    let running = false;
     const project = (reporter) => {
         if (running) {
             throw new Error('gulp-typescript: A project cannot be used in two compilations at the same time. Create multiple projects with createProject instead.');

test/baselines/useFileCompiler/2.3/errors.txt

@@ -0,0 +1,12 @@
+TypeScript error: test/useFileCompiler/excluded-dir/test.ts(1,1): error TS2304: Cannot find name 'notCompiled'.
+TypeScript error: test/useFileCompiler/excluded-file.ts(1,1): error TS2304: Cannot find name 'notCompiled'.
+{
+    "transpileErrors": 0,
+    "optionsErrors": 0,
+    "syntaxErrors": 0,
+    "globalErrors": 0,
+    "semanticErrors": 2,
+    "declarationErrors": 0,
+    "emitErrors": 0,
+    "emitSkipped": false
+}