feat(reporter config): remove deprecated reporter config option (#1371)

BREAKING CHANGE: Removes the 'reporter' config option. Please use the 'reporters' (plural) config option instead.
stryker-mutator · Feb 12, 2019 · 2034a67 · 2034a67
1 parent cb585b4
commit 2034a67
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 40 deletions.
diff --git a/e2e/test/command/stryker.conf.js b/e2e/test/command/stryker.conf.js
@@ -3,7 +3,7 @@ module.exports = function (config) {
     mutate: ['src/*.js'],
     testFramework: 'mocha',
     coverageAnalysis: 'off',
-    reporter: ['clear-text', 'event-recorder'],
+    reporters: ['clear-text', 'event-recorder'],
     mutator: 'javascript',
     maxConcurrentTestRunners: 2,
     commandRunner: {

diff --git a/e2e/test/vue-javascript/stryker.conf.js b/e2e/test/vue-javascript/stryker.conf.js
@@ -4,7 +4,7 @@ module.exports = function (config) {
     mutator: 'vue',
     testFramework: 'jasmine',
     testRunner: 'karma',
-    reporter: ['clear-text', 'event-recorder'],
+    reporters: ['clear-text', 'event-recorder'],
     maxConcurrentTestRunners: 2,
     karma: {
       configFile: 'test/unit/karma.conf.js'

diff --git a/packages/stryker-api/src/config/Config.ts b/packages/stryker-api/src/config/Config.ts
@@ -17,7 +17,6 @@ export default class Config implements StrykerOptions {
   public timeoutMS = 5000;
   public timeoutFactor = 1.5;
   public plugins: string[] = ['stryker-*'];
-  public reporter = [];
   public reporters: string[] = ['progress', 'clear-text'];
   public coverageAnalysis: 'perTest' | 'all' | 'off' = 'off';
   public testRunner: string = 'command';

diff --git a/packages/stryker-api/src/core/StrykerOptions.ts b/packages/stryker-api/src/core/StrykerOptions.ts
@@ -97,10 +97,6 @@ interface StrykerOptions {
    */
   coverageAnalysis: 'perTest' | 'all' | 'off';
 
-  /**
-   * DEPRECATED PROPERTY. Please use the `reporters` property
-   */
-  reporter?: string | string[];
   /**
    * The names of the reporters to use
    * Possible values: 'clear-text', 'progress'.

diff --git a/packages/stryker/src/config/ConfigReader.ts b/packages/stryker/src/config/ConfigReader.ts
@@ -33,15 +33,6 @@ export default class ConfigReader {
     // merge the config from config file and cliOptions (precedence)
     config.set(this.cliOptions);
 
-    if (config.reporter.length) {
-      if (Array.isArray(config.reporter)) {
-        config.reporters = config.reporter;
-      } else {
-        config.reporters = [config.reporter];
-      }
-      this.log.warn(`DEPRECATED: please change the config setting 'reporter: ${JSON.stringify(config.reporter)}' into 'reporters: ${JSON.stringify(config.reporters)}'`);
-    }
-
     return config;
   }
 

diff --git a/packages/stryker/src/initializer/presets/VueJsPreset.ts b/packages/stryker/src/initializer/presets/VueJsPreset.ts
@@ -24,7 +24,7 @@ export class VueJsPreset implements Preset {
       jest: {
         // config: require('path/to/your/custom/jestConfig.js')
       },
-      reporter: ['progress', 'clear-text', 'html'],
+      reporters: ['progress', 'clear-text', 'html'],
       coverageAnalysis: 'off'
     }`;
 
@@ -39,7 +39,7 @@ export class VueJsPreset implements Preset {
           browsers: ['ChromeHeadless']
         }
       },
-      reporter: ['progress', 'clear-text', 'html'],
+      reporters: ['progress', 'clear-text', 'html'],
       coverageAnalysis: 'off'
     }`;
 

diff --git a/packages/stryker/test/integration/config-reader/ConfigReaderSpec.ts b/packages/stryker/test/integration/config-reader/ConfigReaderSpec.ts
@@ -129,27 +129,5 @@ describe(ConfigReader.name, () => {
         expect(() => sut.readConfig()).throws('Invalid config file. Inner error: SyntaxError: Unexpected identifier');
       });
     });
-
-    describe('with deprecated reporter property', () => {
-      it('should log a warning when a single reporter is specified', () => {
-        const reporterName = 'html';
-        sut = createSut({ reporter: reporterName });
-
-        const result = sut.readConfig();
-
-        expect(result.reporters).to.deep.eq([reporterName]);
-        expect(testInjector.logger.warn).calledWithExactly(`DEPRECATED: please change the config setting 'reporter: "${reporterName}"' into 'reporters: ["${reporterName}"]'`);
-      });
-
-      it('should log a warning when multiple reporters are specified', () => {
-        const configuredReporters = ['html', 'progress'];
-        sut = createSut({ reporter: configuredReporters });
-
-        const result = sut.readConfig();
-
-        expect(result.reporters).to.deep.eq(configuredReporters);
-        expect(testInjector.logger.warn).calledWithExactly(`DEPRECATED: please change the config setting 'reporter: ${JSON.stringify(configuredReporters)}' into 'reporters: ${JSON.stringify(configuredReporters)}'`);
-      });
-    });
   });
 });