fix(npm package): ignore unused files (#4405)

- Use a 'whitelist' (`"files"` in package.json) instead of a blacklist (`.npmignore` file) to mark files for the packages. - Remove a lot of unused config files from the stryker packages
stryker-mutator · Sep 27, 2023 · f14e789 · f14e789
1 parent 975f011
commit f14e789
Show file tree

Hide file tree

Showing 26 changed files with 17 additions and 210 deletions.
diff --git a/packages/api/.npmignore b/packages/api/.npmignore
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -8,6 +8,7 @@
     "url": "https://github.com/stryker-mutator/stryker-js.git",
     "directory": "packages/api"
   },
+  "files": ["./dist/", "./core.d.ts", "./src-generated/", "./src/"],
   "exports": {
     "./check": "./dist/src/check/index.js",
     "./core": "./dist/src/core/index.js",

diff --git a/packages/core/.npmignore b/packages/core/.npmignore
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -3,6 +3,7 @@
   "version": "7.1.1",
   "description": "The extendable JavaScript mutation testing framework",
   "type": "module",
+  "files": ["./bin/", "./dist/", "./schema/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/cucumber-runner/.npmignore b/packages/cucumber-runner/.npmignore
diff --git a/packages/cucumber-runner/package.json b/packages/cucumber-runner/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/cucumber-runner",
   "version": "7.1.1",
   "description": "A plugin to use the cucumber test runner in Stryker, the JavaScript mutation testing framework",
+  "files": ["./dist/", "./src-generated/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/grunt-stryker/.npmignore b/packages/grunt-stryker/.npmignore
diff --git a/packages/grunt-stryker/package.json b/packages/grunt-stryker/package.json
@@ -32,6 +32,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
+  "files": ["./tasks/"],
   "main": "Gruntfile.js",
   "devDependencies": {
     "@stryker-mutator/api": "7.1.1",

diff --git a/packages/instrumenter/.npmignore b/packages/instrumenter/.npmignore
diff --git a/packages/instrumenter/package.json b/packages/instrumenter/package.json
@@ -4,6 +4,7 @@
   "description": "The code instrumenter used in Stryker, the JavaScript mutation testing framework",
   "main": "dist/src/index.js",
   "type": "module",
+  "files": ["./dist/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/jasmine-runner/.npmignore b/packages/jasmine-runner/.npmignore
diff --git a/packages/jasmine-runner/package.json b/packages/jasmine-runner/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/jasmine-runner",
   "version": "7.1.1",
   "description": "A plugin to use the Jasmine (NodeJS) test runner in Stryker, the mutation testing framework for JavaScript and friends",
+  "files": ["./dist/", "./src-generated/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/jest-runner/.npmignore b/packages/jest-runner/.npmignore
diff --git a/packages/jest-runner/package.json b/packages/jest-runner/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/jest-runner",
   "version": "7.1.1",
   "description": "A plugin to use the jest test runner and framework in Stryker, the JavaScript mutation testing framework",
+  "files": ["./dist/", "./src-generated/", "./src/"],
   "main": "dist/src/index.js",
   "exports": {
     ".": {

diff --git a/packages/karma-runner/.npmignore b/packages/karma-runner/.npmignore
diff --git a/packages/karma-runner/package.json b/packages/karma-runner/package.json
@@ -2,6 +2,11 @@
   "name": "@stryker-mutator/karma-runner",
   "version": "7.1.1",
   "description": "A plugin to use the karma test runner in Stryker, the JavaScript mutation testing framework",
+  "files": [
+    "./dist/",
+    "./src-generated/",
+    "./src/",
+    "./stryker-karma.conf.cjs"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/mocha-runner/.npmignore b/packages/mocha-runner/.npmignore
diff --git a/packages/mocha-runner/package.json b/packages/mocha-runner/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/mocha-runner",
   "version": "7.1.1",
   "description": "A plugin to use the mocha test runner in Stryker, the JavaScript mutation testing framework",
+  "files": ["./dist/", "./src-generated/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/tap-runner/.npmignore b/packages/tap-runner/.npmignore
diff --git a/packages/tap-runner/package.json b/packages/tap-runner/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/tap-runner",
   "version": "7.1.1",
   "description": "A plugin to use the TAP (test anything protocol) test runner in Stryker, the JavaScript mutation testing framework",
+  "files": ["./dist/", "./src-generated/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/typescript-checker/.npmignore b/packages/typescript-checker/.npmignore
diff --git a/packages/typescript-checker/package.json b/packages/typescript-checker/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/typescript-checker",
   "version": "7.1.1",
   "description": "A typescript type checker plugin to be used in Stryker, the JavaScript mutation testing framework",
+  "files": ["./dist/", "./src-generated/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/util/.npmignore b/packages/util/.npmignore
diff --git a/packages/util/package.json b/packages/util/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/util",
   "version": "7.1.1",
   "description": "Contains utilities for Stryker, the mutation testing framework for JavaScript and friends",
+  "files": ["./dist/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"

diff --git a/packages/vitest-runner/.npmignore b/packages/vitest-runner/.npmignore
diff --git a/packages/vitest-runner/package.json b/packages/vitest-runner/package.json
@@ -2,6 +2,7 @@
   "name": "@stryker-mutator/vitest-runner",
   "version": "7.1.1",
   "description": "A plugin to use the vitest test runner and framework in Stryker, the JavaScript mutation testing framework",
+  "files": ["./dist/", "./src-generated/", "./src/"],
   "exports": {
     ".": {
       "import": "./dist/src/index.js"