Merge pull request microsoft#22 from Microsoft/nickpape/remove-comments

nickpape-msft · web-flow · commit 2474552c9964 · 2016-11-09T12:56:58.000-08:00
Introduce an option which remove comments, but only from JS files (no…
diff --git a/common/changes/nickpape-remove-comments_2016-11-09-19-33.json b/common/changes/nickpape-remove-comments_2016-11-09-19-33.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/gulp-core-build-typescript",
+      "comment": "Added additional options which will remove comments and one that will turn off sourcemaps",
+      "type": "minor"
+    }
+  ],
+  "email": "nickpape@microsoft.com"
+}
diff --git a/common/npm-shrinkwrap.json b/common/npm-shrinkwrap.json
diff --git a/common/temp_modules/npmx-gulp-core-build-typescript/package.json b/common/temp_modules/npmx-gulp-core-build-typescript/package.json
@@ -16,6 +16,7 @@
     "gulp": "~3.9.1",
     "gulp-cache": "~0.4.5",
     "gulp-changed": "~1.3.2",
+    "gulp-decomment": "~0.1.3",
     "gulp-plumber": "~1.1.0",
     "gulp-sourcemaps": "~1.6.0",
     "gulp-texttojs": "~1.0.3",
diff --git a/gulp-core-build-typescript/.vscode/settings.json b/gulp-core-build-typescript/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "typescript.check.workspaceVersion": false
+}
diff --git a/gulp-core-build-typescript/README.md b/gulp-core-build-typescript/README.md
@@ -62,6 +62,16 @@ Optional override of the typescript compiler. Set this to the result of require(
 
 Default: `undefined`
 
+### removeCommentsFromJavaScript
+Removes comments from all generated `.js` files. Will **not** remove comments from generated `.d.ts` files.
+
+Default: `false`
+
+### emitSourceMaps
+If true, creates sourcemap files which are useful for debugging.
+
+Default: `true`
+
 # TSLintTask
 ## Usage
 The task for linting the TypeScript code.
diff --git a/gulp-core-build-typescript/package.json b/gulp-core-build-typescript/package.json
@@ -22,6 +22,7 @@
     "gulp": "~3.9.1",
     "gulp-cache": "~0.4.5",
     "gulp-changed": "~1.3.2",
+    "gulp-decomment": "~0.1.3",
     "gulp-plumber": "~1.1.0",
     "gulp-sourcemaps": "~1.6.0",
     "gulp-texttojs": "~1.0.3",
diff --git a/gulp-core-build-typescript/src/TypeScriptTask.ts b/gulp-core-build-typescript/src/TypeScriptTask.ts
@@ -45,6 +45,17 @@ export interface ITypeScriptTaskConfig {
   /* tslint:disable:no-any */
   typescript?: any;
   /* tslint:enable:no-any */
+
+  /**
+   * Removes comments from all generated `.js` files. Will **not** remove comments from generated `.d.ts` files.
+   * Defaults to false.
+   */
+  removeCommentsFromJavaScript?: boolean;
+
+  /**
+   * If true, creates sourcemap files which are useful for debugging. Defaults to true.
+   */
+  emitSourceMaps?: boolean;
 }
 
 export class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
@@ -82,22 +93,25 @@ export class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
       'src/**/*.js',
       'src/**/*.json',
       'src/**/*.jsx'
-    ]
+    ],
+    removeCommentsFromJavaScript: false,
+    emitSourceMaps: true
   };
 
   private _tsProject: ts.Project;
 
   public executeTask(gulp: gulpType.Gulp, completeCallback: (result?: string) => void): void {
     /* tslint:disable:typedef */
-    const plumber = require('gulp-plumber');
-    const sourcemaps = require('gulp-sourcemaps');
     const assign = require('object-assign');
     const merge = require('merge2');
     /* tslint:enable:typedef */
 
-    let errorCount: number = 0;
     const allStreams: NodeJS.ReadWriteStream[] = [];
 
+    const result: { errorCount: number } = {
+      errorCount: 0
+    };
+
     /* tslint:disable:no-any */
     let tsConfig: any = this.readJSONSync('tsconfig.json');
     /* tslint:enable:no-any */
@@ -121,65 +135,32 @@ export class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
       this.log(`Using custom version: ${this.taskConfig.typescript.version}`);
     }
 
-    const tsCompilerOptions: ts.Project = assign({}, tsConfig.compilerOptions, {
+    const tsCompilerOptions: ts.Settings = assign({}, tsConfig.compilerOptions, {
       module: 'commonjs',
       typescript: this.taskConfig.typescript
     });
 
-    const tsProject: ts.Project = this._tsProject = this._tsProject || ts.createProject(tsCompilerOptions);
-
-    /* tslint:disable:typedef */
-    const { libFolder, libAMDFolder } = this.buildConfig;
-    /* tslint:enable:typedef */
-    let tsResult: ts.CompileStream = gulp.src(this.taskConfig.sourceMatch)
-      .pipe(plumber({
-        errorHandler: (): void => {
-          errorCount++;
-        }
-      }))
-      .pipe(sourcemaps.init())
-      .pipe(ts(tsProject, undefined, this.taskConfig.reporter));
-
-    allStreams.push(tsResult.js
-      .pipe(sourcemaps.write('.', { sourceRoot: this._resolveSourceMapRoot }))
-      .pipe(gulp.dest(libFolder)));
-
-    allStreams.push(tsResult.dts.pipe(gulp.dest(libFolder)));
+    this._compileProject(gulp, tsCompilerOptions, this.buildConfig.libFolder, allStreams, result);
 
     // Static passthrough files.
     const staticSrc: NodeJS.ReadWriteStream = gulp.src(this.taskConfig.staticMatch);
 
     allStreams.push(
-      staticSrc.pipe(gulp.dest(libFolder)));
+      staticSrc.pipe(gulp.dest(this.buildConfig.libFolder)));
 
     // If AMD modules are required, also build that.
-    if (libAMDFolder) {
+    if (this.buildConfig.libAMDFolder) {
       allStreams.push(
-        staticSrc.pipe(gulp.dest(libAMDFolder)));
+        staticSrc.pipe(gulp.dest(this.buildConfig.libAMDFolder)));
 
       const tsAMDProject: ts.Project = ts.createProject(assign({}, tsCompilerOptions, { module: 'amd' }));
-
-      tsResult = gulp.src(this.taskConfig.sourceMatch)
-        .pipe(plumber({
-          errorHandler: (): void => {
-            errorCount++;
-          }
-        }))
-        .pipe(sourcemaps.write({ sourceRoot: this._resolveSourceMapRoot }))
-        .pipe(ts(tsAMDProject, undefined, this.taskConfig.reporter));
-
-      allStreams.push(
-        tsResult.js
-          .pipe(sourcemaps.write('.', { sourceRoot: this._resolveSourceMapRoot }))
-          .pipe(gulp.dest(libAMDFolder)));
-
-      allStreams.push(tsResult.dts.pipe(gulp.dest(libAMDFolder)));
+      this._compileProject(gulp, tsAMDProject, this.buildConfig.libAMDFolder, allStreams, result);
     }
 
     // Listen for pass/fail, and ensure that the task passes/fails appropriately.
     merge(allStreams)
       .on('queueDrain', () => {
-        if (this.taskConfig.failBuildOnErrors && errorCount) {
+        if (this.taskConfig.failBuildOnErrors && result.errorCount) {
           completeCallback('TypeScript error(s) occurred.');
         } else {
           completeCallback();
@@ -193,6 +174,47 @@ export class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
     throw 'Do not use mergeConfig with gulp-core-build-typescript';
   }
 
+  private _compileProject(gulp: gulpType.Gulp, tsCompilerOptions: ts.Settings, destDir: string,
+    allStreams: NodeJS.ReadWriteStream[], result: { errorCount: number }): void {
+    /* tslint:disable:typedef */
+    const plumber = require('gulp-plumber');
+    const sourcemaps = require('gulp-sourcemaps');
+    /* tslint:enable:typedef */
+
+    const tsProject: ts.Project = this._tsProject = this._tsProject || ts.createProject(tsCompilerOptions);
+
+    // tslint:disable-next-line:no-any
+    let tsResult: any = gulp.src(this.taskConfig.sourceMatch)
+      .pipe(plumber({
+        errorHandler: (): void => {
+          result.errorCount++;
+        }
+      }));
+
+    if (this.taskConfig.emitSourceMaps) {
+      tsResult = tsResult.pipe(sourcemaps.init());
+    }
+
+    tsResult = tsResult
+      .pipe(ts(tsProject, undefined, this.taskConfig.reporter));
+
+    // tslint:disable-next-line:typedef
+    let jsResult = (this.taskConfig.removeCommentsFromJavaScript
+      ? tsResult.js.pipe(require('gulp-decomment')({
+        space: !!this.taskConfig.emitSourceMaps /* turn comments into spaces to preserve sourcemaps */
+      }))
+      : tsResult.js);
+
+    if (this.taskConfig.emitSourceMaps) {
+      jsResult = jsResult.pipe(sourcemaps.write('.', { sourceRoot: this._resolveSourceMapRoot }));
+    }
+
+    allStreams.push(jsResult
+      .pipe(gulp.dest(destDir)));
+
+    allStreams.push(tsResult.dts.pipe(gulp.dest(destDir)));
+  }
+
   private _resolveSourceMapRoot(file: { relative: string, cwd: string }): string {
     return path.relative(file.relative, path.join(file.cwd, 'src'));
   }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "typescript.check.workspaceVersion": false`
	`3`	`+}`