Add Mock Service Worker - msw (#513)

* Add msw

* PR feedback

* Support Intellij project users

* PR review

* PR review

* PR review

* PR review

* PR review

* PR review

* PR review

* PR review

* PR review

* PR review

* Wrap up

* Add msw to schema & types

---------

Co-authored-by: Lars Kappert <[email protected]>

.gitignore

@@ -1 +1,2 @@
 node_modules
+.idea

packages/knip/fixtures/plugins/msw/bob/mockServiceWorker.js

@@ -0,0 +1,6 @@
+/**
+ * Mock Service Worker (2.2.0).
+ * @see https://github.com/mswjs/msw
+ * - Please do NOT modify this file.
+ * - Please do NOT serve this file on production.
+ */

packages/knip/fixtures/plugins/msw/mocks/browser.ts

@@ -0,0 +1 @@
+import './handlers';

packages/knip/fixtures/plugins/msw/mocks/server.ts

@@ -0,0 +1 @@
+import './handlers';

packages/knip/fixtures/plugins/msw/package.json

@@ -0,0 +1,13 @@
+{
+ "name": "@fixtures/msw",
+ "version": "*",
+ "knip": {
+ "msw": true
+ },
+ "devDependencies": {
+ "msw": "*"
+ },
+ "msw": {
+ "workerDirectory": "bob"
+ }
+}

packages/knip/schema.json

@@ -358,6 +358,10 @@
  "title": "Mocha plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/mocha/README.md)",
  "$ref": "#/definitions/plugin"
  },
+ "msw": {
+ "title": "Mocha plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/msw/README.md)",
+ "$ref": "#/definitions/plugin"
+ },
  "netlify": {
  "title": "Netlify plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/netlify/README.md)",
  "$ref": "#/definitions/plugin"

packages/knip/src/ConfigurationValidator.ts

@@ -98,6 +98,7 @@ const pluginsSchema = z.object({
  linthtml: pluginSchema,
  markdownlint: pluginSchema,
  mocha: pluginSchema,
+ msw: pluginSchema,
  netlify: pluginSchema,
  next: pluginSchema,
  'node-test-runner': pluginSchema,

packages/knip/src/plugins/index.ts

@@ -21,6 +21,7 @@ export { default as lintStaged } from './lint-staged/index.js';
 export { default as linthtml } from './linthtml/index.js';
 export { default as markdownlint } from './markdownlint/index.js';
 export { default as mocha } from './mocha/index.js';
+export { default as msw } from './msw/index.js';
 export { default as netlify } from './netlify/index.js';
 export { default as next } from './next/index.js';
 export { default as nodeTestRunner } from './node-test-runner/index.js';

packages/knip/src/plugins/msw/index.ts

@@ -0,0 +1,38 @@
+import { join } from '../../util/path.js';
+import { basename } from '../../util/path.js';
+import { hasDependency } from '../../util/plugin.js';
+import { toEntryPattern } from '../../util/protocols.js';
+import type { MSWConfig } from './types.js';
+import type { GenericPluginCallback, IsPluginEnabledCallback } from '../../types/plugins.js';
+
+// https://mswjs.io/docs/integrations/browser
+
+const NAME = 'Mock Service Worker';
+
+const ENABLERS = ['msw'];
+
+const isEnabled: IsPluginEnabledCallback = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
+
+const CONFIG_FILE_PATTERNS = ['package.json'];
+
+const ENTRY_FILE_PATTERNS = ['mockServiceWorker.js'];
+
+const findDependencies: GenericPluginCallback = async (configFilePath, options) => {
+ const { manifest } = options;
+
+ // @ts-expect-error Bug in TS? (see other plugins with `await load`)
+ const localConfig: MSWConfig | undefined = basename(configFilePath) === 'package.json' ? manifest.msw : undefined;
+
+ const workerDirectory = localConfig?.workerDirectory ?? '.';
+
+ return ENTRY_FILE_PATTERNS.map(pattern => toEntryPattern(join(workerDirectory, pattern)));
+};
+
+export default {
+ NAME,
+ ENABLERS,
+ isEnabled,
+ CONFIG_FILE_PATTERNS,
+ ENTRY_FILE_PATTERNS,
+ findDependencies,
+};

packages/knip/src/plugins/msw/types.ts

@@ -0,0 +1,3 @@
+export interface MSWConfig {
+ workerDirectory?: string;
+}

packages/knip/src/plugins/next/index.ts

@@ -16,8 +16,7 @@ const productionEntryFilePatternsWithoutSrc = [
  '{instrumentation,middleware}.{js,ts}',
  'app/global-error.{js,jsx,ts,tsx}',
  'app/**/{error,layout,loading,not-found,page,template}.{js,jsx,ts,tsx}',
- 'app/**/route.{js,ts}',
- 'app/**/default.{js,jsx,ts,tsx}',
+ 'app/**/{route,default}.{js,ts}',
  'app/{manifest,sitemap,robots}.{js,ts}',
  'app/**/{icon,apple-icon}.{js,jsx,ts,tsx}',
  'app/**/{opengraph,twitter}-image.{js,jsx,ts,tsx}',

packages/knip/test/plugins/msw.test.ts

@@ -0,0 +1,24 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { main } from '../../src/index.js';
+import { resolve } from '../../src/util/path.js';
+import baseArguments from '../helpers/baseArguments.js';
+import baseCounters from '../helpers/baseCounters.js';
+
+const cwd = resolve('fixtures/plugins/msw');
+
+test('Should not see the msw files in issues', async () => {
+ const { counters } = await main({
+ ...baseArguments,
+ cwd,
+ isStrict: true,
+ });
+
+ assert.deepEqual(counters, {
+ ...baseCounters,
+ files: 4,
+ devDependencies: 1,
+ total: 5,
+ processed: 5,
+ });
+});