Jest task should let jest.json to override Jest task's default options. (microsoft#435)

qz2017 · web-flow · commit 872d10d28296 · 2017-11-12T16:14:38.000-08:00
* Jest task should let jest.config.json to override certain CLI options.

* Add change file

* Move Jest related API from public to alpha and update IJestConfig.

* Removed unused code.

* Update description in the change file
diff --git a/common/changes/@microsoft/gulp-core-build/qz2017-jest_patch2_2017-11-09-23-54.json b/common/changes/@microsoft/gulp-core-build/qz2017-jest_patch2_2017-11-09-23-54.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/gulp-core-build",
+      "comment": "Allow settings in jest.json to override Jest task's default options",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/gulp-core-build",
+  "email": "qz2017@users.noreply.github.com"
+}
diff --git a/common/reviews/api/gulp-core-build.api.ts b/common/reviews/api/gulp-core-build.api.ts
@@ -188,17 +188,19 @@ interface IExecutable {
   onRegister?: () => void;
 }
 
-// @public
+// @alpha
 interface IJestConfig {
-  configFilePath?: string;
+  collectCoverageFrom?: string[];
   coverage?: boolean;
+  coverageReporters?: string[];
   isEnabled?: boolean;
+  testPathIgnorePatterns?: string[];
 }
 
 // @public
 export function initialize(gulp: typeof Gulp): void;
 
-// @public
+// @alpha
 class JestTask extends GulpTask<IJestConfig> {
   constructor();
   // (undocumented)
diff --git a/core-build/gulp-core-build/src/tasks/JestTask.ts b/core-build/gulp-core-build/src/tasks/JestTask.ts
@@ -10,7 +10,7 @@ import * as globby from 'globby';
 
 /**
  * Configuration for JestTask
- * @public
+ * @alpha
  */
 export interface IJestConfig {
   /**
@@ -19,16 +19,24 @@ export interface IJestConfig {
   isEnabled?: boolean;
 
   /**
-   * The jest config file relative to project root directory
-   * If not provided, the default value is 'jest.config.json'.
+   * Same as Jest CLI option collectCoverageFrom
    */
-  configFilePath?: string;
+  collectCoverageFrom?: string[];
 
   /**
-   * Indicates that test coverage information should be collected and reported in the output
-   * If not provided, the default value is true.
+   * Same as Jest CLI option coverage
    */
   coverage?: boolean;
+
+  /**
+   * Same as Jest CLI option coverageReporters
+   */
+  coverageReporters?: string[];
+
+  /**
+   * Same as Jest CLI option testPathIgnorePatterns
+   */
+  testPathIgnorePatterns?: string[];
 }
 
 const DEFAULT_JEST_CONFIG_FILE_NAME: string = 'jest.config.json';
@@ -50,14 +58,17 @@ export function _isJestEnabled(rootFolder: string): boolean {
 
 /**
  * This task takes in a map of dest: [sources], and copies items from one place to another.
- * @public
+ * @alpha
  */
 export class JestTask extends GulpTask<IJestConfig> {
 
   constructor() {
     super('jest',
     {
-      coverage: true
+      collectCoverageFrom: ['lib/**/*.js?(x)', '!lib/**/test/**'],
+      coverage: true,
+      coverageReporters: ['json', 'html'],
+      testPathIgnorePatterns: ['<rootDir>/(src|lib-amd|lib-es6|coverage|build|docs|node_modules)/']
     });
   }
 
@@ -77,22 +88,26 @@ export class JestTask extends GulpTask<IJestConfig> {
     completeCallback: (error?: string | Error) => void
   ): void {
     const configFileFullPath: string = path.join(this.buildConfig.rootPath,
-      'config', DEFAULT_JEST_CONFIG_FILE_NAME);
+      'config', 'jest', DEFAULT_JEST_CONFIG_FILE_NAME);
 
     this._copySnapshots(this.buildConfig.srcFolder, this.buildConfig.libFolder);
+
     Jest.runCLI(
       {
         ci: this.buildConfig.production,
         config: configFileFullPath,
+        collectCoverageFrom: this.taskConfig.collectCoverageFrom,
         coverage: this.taskConfig.coverage,
+        coverageReporters: this.taskConfig.coverageReporters,
+        coverageDirectory: path.join(this.buildConfig.tempFolder, 'coverage'),
         maxWorkers: 1,
-        runInBand: true,
-        updateSnapshot: !this.buildConfig.production,
+        moduleDirectories: ['node_modules', this.buildConfig.libFolder],
+        reporters: [path.join(__dirname, 'JestReporter.js')],
         rootDir: this.buildConfig.rootPath,
+        runInBand: true,
         testMatch: ['**/*.test.js?(x)'],
-        testPathIgnorePatterns: ['<rootDir>/(src|lib-amd|lib-es6|coverage|build|docs|node_modules)/'],
-        collectCoverageFrom: ['lib/**/*.js?(x)'],
-        reporters: [path.join(__dirname, 'JestReporter.js')]
+        testPathIgnorePatterns: this.taskConfig.testPathIgnorePatterns,
+        updateSnapshot: !this.buildConfig.production
       },
       [this.buildConfig.rootPath],
       (result) => {
diff --git a/core-build/gulp-core-build/src/tasks/jest.schema.json b/core-build/gulp-core-build/src/tasks/jest.schema.json
@@ -13,15 +13,31 @@
       "type": "boolean",
       "default": false
     },
-    "configFilePath": {
-      "description": "The path to a jest config file relative to root project folder",
-      "type": "string",
-      "default": "jest.config.json"
+    "collectCoverageFrom": {
+      "description": "Same as Jest CLI option collectCoverageFrom",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
     },
     "coverage": {
-      "description": "Indicates that test coverage information should be collected and reported in the output",
+      "description": "Same as Jest CLI option coverage",
       "type": "boolean",
       "default": true
+    },
+    "coverageReporters": {
+      "description": "Same as Jest CLI option coverageReporters",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "testPathIgnorePatterns": {
+      "description": "Same as Jest CLI option testPathIgnorePatterns",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
     }
   },
   "additionalProperties": false
