@stryker-mutator/api - npm Package Compare versions

Comparing version 6.4.2 to 7.0.0

CHANGELOG.md

@@ -6,2 +6,35 @@ # Change Log
 
+# [7.0.0](https://github.com/stryker-mutator/stryker-js/compare/v6.4.2...v7.0.0) (2023-06-02)
+
+### Bug Fixes
+
+- **deps:** update mutation-testing-elements monorepo to v2.0.1 ([#4182](https://github.com/stryker-mutator/stryker-js/issues/4182)) ([c1b7312](https://github.com/stryker-mutator/stryker-js/commit/c1b7312a238b67f43630101b084ff33780eda1c5))
+- **deps:** update mutation-testing-metrics and mutation-report-schema to v2 ([#4154](https://github.com/stryker-mutator/stryker-js/issues/4154)) ([9b77a3f](https://github.com/stryker-mutator/stryker-js/commit/9b77a3f6fdeb7036b1e15610f03dd8c85a502670))
+
+### chore
+
+- **esm:** use "exports" and module "Node16" ([#4171](https://github.com/stryker-mutator/stryker-js/issues/4171)) ([cdf4a34](https://github.com/stryker-mutator/stryker-js/commit/cdf4a342b73d922423eb46a919eb3b38c4c43c46))
+
+### Features
+
+- **config:** add `--allowEmpty` option ([#4198](https://github.com/stryker-mutator/stryker-js/issues/4198)) ([44e355e](https://github.com/stryker-mutator/stryker-js/commit/44e355ee727bbceff1a4069055844c49c0ea2118))
+- **config:** add `'always'` option to `cleanTempDir` ([#4187](https://github.com/stryker-mutator/stryker-js/issues/4187)) ([f02efb2](https://github.com/stryker-mutator/stryker-js/commit/f02efb2db08d13be132c0bd318dfa6d3f6399788))
+- **node:** Drop support for node 14 ([#4105](https://github.com/stryker-mutator/stryker-js/issues/4105)) ([a88744f](https://github.com/stryker-mutator/stryker-js/commit/a88744f1a5fa47274ee0f30abc635831b18113fa))
+- **reporter-api:** remove `onAllMutantsTested` ([#4234](https://github.com/stryker-mutator/stryker-js/issues/4234)) ([762c023](https://github.com/stryker-mutator/stryker-js/commit/762c023e5ac0ae6e2967be0458663c41d31e82ea))
+- **type-checking:** disable type check by default ([#4246](https://github.com/stryker-mutator/stryker-js/issues/4246)) ([d45350a](https://github.com/stryker-mutator/stryker-js/commit/d45350ad2440d455b7ba215aae1f87712e22fdc5))
+
+### BREAKING CHANGES
+
+- **type-checking:** `disableTypeChecks` is now `true` by default. You can use this configuration to opt out:
+
+```json
+{
+  "disableTypeChecks": "{test,src,lib}/**/*.{js,ts,jsx,tsx,html,vue,cts,mts}"
+}
+```
+
+- **reporter-api:** The event `onAllMutantsTested` has been removed. Plugin creators should use `onMutationTestReportReady` instead.
+- **esm:** Deep (and undocumented) imports from `@stryker-mutator/core` or one of the plugins will no longer work. If you want to import something that's not available, please let us know by [opening an issue](https://github.com/stryker-mutator/stryker-js/issues/new/choose)
+- **node:** Node 14 is no longer supported. Please install an LTS version of node: nodejs.org/
+
 ## [6.4.2](https://github.com/stryker-mutator/stryker-js/compare/v6.4.1...v6.4.2) (2023-03-24)
@@ -8,0 +41,0 @@

dist/schema/stryker-core.json

@@ -429,6 +429,3 @@ {
                 {
-                    "enum": [
-                        false,
-                        true
-                    ]
+                    "type": "boolean"
                 },
@@ -439,3 +436,6 @@ {
             ],
-            "default": "{test,src,lib}/**/*.{js,ts,jsx,tsx,html,vue}"
+            "examples": [
+                "{test,src,lib}/**/*.{js,ts,jsx,tsx,html,vue,cts,mts}"
+            ],
+            "default": true
         },
@@ -453,4 +453,8 @@ "symlinkNodeModules": {
         "cleanTempDir": {
-            "description": "Choose whether or not to clean the temp dir (which is \".stryker-tmp\" inside the current working directory by default) after a successful run. The temp dir will never be removed when the run failed for some reason (for debugging purposes)",
-            "type": "boolean",
+            "description": "Choose whether or not to clean the temp dir (which is \".stryker-tmp\" inside the current working directory by default).\n - false: Never delete the temp dir;\n - true: Delete the tmp dir after a successful run;\n - \"always\": Always delete the temp dir, regardless of whether the run was successful.",
+            "enum": [
+                "always",
+                false,
+                true
+            ],
             "default": true
@@ -513,4 +517,9 @@ },
             "default": false
+        },
+        "allowEmpty": {
+            "description": "Allows stryker to exit without any errors in cases where no tests are found",
+            "type": "boolean",
+            "default": false
         }
     }
 }

dist/src-generated/stryker-core.d.ts

@@ -112,3 +112,3 @@ /**
      */
-    disableTypeChecks: (false | true) | string;
+    disableTypeChecks: boolean | string;
     /**
@@ -123,5 +123,8 @@ * The 'symlinkNodeModules' value indicates whether Stryker should create a symbolic link to your current node_modules directory in the sandbox directories. This makes running your tests by Stryker behave more like your would run the tests yourself in your project directory. Only disable this setting if you really know what you are doing.
     /**
-     * Choose whether or not to clean the temp dir (which is ".stryker-tmp" inside the current working directory by default) after a successful run. The temp dir will never be removed when the run failed for some reason (for debugging purposes)
+     * Choose whether or not to clean the temp dir (which is ".stryker-tmp" inside the current working directory by default).
+     *  - false: Never delete the temp dir;
+     *  - true: Delete the tmp dir after a successful run;
+     *  - "always": Always delete the temp dir, regardless of whether the run was successful.
      */
-    cleanTempDir: boolean;
+    cleanTempDir: 'always' | false | true;
     /**
@@ -160,2 +163,6 @@ * With 'testRunner' you specify the test runner that Stryker uses to run your tests. The default value is command. The command runner runs a configurable bash/cmd command and bases the result on the exit code of that program (0 for success, otherwise failed). You can configure this command via the config file using the 'commandRunner: { command: 'npm run mocha' }'. It uses 'npm test' as the command by default.
     disableBail: boolean;
+    /**
+     * Allows stryker to exit without any errors in cases where no tests are found
+     */
+    allowEmpty: boolean;
     [k: string]: unknown;
@@ -162,0 +169,0 @@ }

dist/src/report/reporter.d.ts

@@ -25,7 +25,2 @@ import { MutationTestMetricsResult } from 'mutation-testing-metrics';
     /**
-     * Called when all mutants were tested
-     * @param results The immutable results
-     */
-    onAllMutantsTested?(results: ReadonlyArray<Readonly<MutantResult>>): void;
-    /**
      * Called when mutation testing is done
@@ -32,0 +27,0 @@ * @param report the mutation test result that is valid according to the mutation-testing-report-schema (json schema)

package.json

 {
   "name": "@stryker-mutator/api",
-  "version": "6.4.2",
+  "version": "7.0.0",
   "description": "The api for the extendable JavaScript mutation testing framework Stryker",
@@ -19,24 +19,2 @@ "type": "module",
   },
-  "typesVersions": {
-    "*": {
-      "check": [
-        "./dist/src/check/index.d.ts"
-      ],
-      "core": [
-        "./dist/src/core/index.d.ts"
-      ],
-      "logging": [
-        "./dist/src/logging/index.d.ts"
-      ],
-      "plugin": [
-        "./dist/src/plugin/index.d.ts"
-      ],
-      "report": [
-        "./dist/src/report/index.d.ts"
-      ],
-      "test-runner": [
-        "./dist/src/test-runner/index.d.ts"
-      ]
-    }
-  },
   "scripts": {
@@ -71,14 +49,14 @@ "stryker": "node ../core/bin/stryker.js run",
   "engines": {
-    "node": ">=14.18.0"
+    "node": ">=16.0.0"
   },
   "dependencies": {
-    "mutation-testing-metrics": "1.7.14",
-    "mutation-testing-report-schema": "1.7.14",
+    "mutation-testing-metrics": "2.0.1",
+    "mutation-testing-report-schema": "2.0.1",
     "tslib": "~2.5.0"
   },
   "devDependencies": {
-    "@types/node": "18.15.6",
-    "typed-inject": "3.0.1"
+    "@types/node": "18.16.16",
+    "typed-inject": "4.0.0"
   },
-  "gitHead": "2c0e11d1724756339d17504d2c73898fb816cc2b"
+  "gitHead": "aeedbd2b20ada4b689e504889132fb97c4db2946"
 }

src-generated/stryker-core.ts

@@ -114,3 +114,3 @@ /**
    */
-  disableTypeChecks: (false | true) | string;
+  disableTypeChecks: boolean | string;
   /**
@@ -125,5 +125,8 @@ * The 'symlinkNodeModules' value indicates whether Stryker should create a symbolic link to your current node_modules directory in the sandbox directories. This makes running your tests by Stryker behave more like your would run the tests yourself in your project directory. Only disable this setting if you really know what you are doing.
   /**
-   * Choose whether or not to clean the temp dir (which is ".stryker-tmp" inside the current working directory by default) after a successful run. The temp dir will never be removed when the run failed for some reason (for debugging purposes)
+   * Choose whether or not to clean the temp dir (which is ".stryker-tmp" inside the current working directory by default).
+   *  - false: Never delete the temp dir;
+   *  - true: Delete the tmp dir after a successful run;
+   *  - "always": Always delete the temp dir, regardless of whether the run was successful.
    */
-  cleanTempDir: boolean;
+  cleanTempDir: 'always' | false | true;
   /**
@@ -162,2 +165,6 @@ * With 'testRunner' you specify the test runner that Stryker uses to run your tests. The default value is command. The command runner runs a configurable bash/cmd command and bases the result on the exit code of that program (0 for success, otherwise failed). You can configure this command via the config file using the 'commandRunner: { command: 'npm run mocha' }'. It uses 'npm test' as the command by default.
   disableBail: boolean;
+  /**
+   * Allows stryker to exit without any errors in cases where no tests are found
+   */
+  allowEmpty: boolean;
   [k: string]: unknown;
@@ -164,0 +171,0 @@ }

src/report/reporter.ts

@@ -31,8 +31,2 @@ import { MutationTestMetricsResult } from 'mutation-testing-metrics';
   /**
-   * Called when all mutants were tested
-   * @param results The immutable results
-   */
-  onAllMutantsTested?(results: ReadonlyArray<Readonly<MutantResult>>): void;
-
-  /**
    * Called when mutation testing is done
@@ -39,0 +33,0 @@ * @param report the mutation test result that is valid according to the mutation-testing-report-schema (json schema)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

224895

increased by1.16%

Lines of code

2765

increased by0.51%

Dependency changes

• + Addedmutation-testing-metrics@2.0.1(transitive)

• + Addedmutation-testing-report-schema@2.0.1(transitive)

• - Removedmutation-testing-metrics@1.7.14(transitive)

• - Removedmutation-testing-report-schema@1.7.14(transitive)

• Updatedmutation-testing-metrics@2.0.1

• Updatedmutation-testing-report-schema@2.0.1