knip 2.33.0 → 2.33.2

package/README.md

@@ -23,36 +23,37 @@ The dots don't connect themselves. This is where Knip comes in:
 - [x] Finds binaries and dependencies in npm scripts, and a lot more locations
 - [x] Finds unused members of classes and enums
 - [x] Finds duplicate exports
+- [x] Use [production and strict mode][4] to focus on isolated production code
 - [x] Supports any combination of JavaScript and TypeScript
-- [x] Multiple built-in [reporters][4] (or use [custom reporters][5] and [preprocessors][6])
-- [x] Understands [JSDoc/TSDoc tags][7] (e.g. `@public` and `@internal`)
+- [x] Multiple built-in [reporters][5] (or use [custom reporters][6] and [preprocessors][7])
+- [x] Understands [JSDoc/TSDoc tags][8] (e.g. `@public` and `@internal`)
 - [x] Run Knip as part of your CI environment to detect issues and prevent regressions
 
 Knip shines in both small and large projects. It's a fresh take on keeping your projects clean & tidy!
 
-[![An orange cow with scissors, Van Gogh style][9]][8] <sup>_“An orange cow with scissors, Van Gogh style” - generated
+[![An orange cow with scissors, Van Gogh style][10]][9] <sup>_“An orange cow with scissors, Van Gogh style” - generated
 with OpenAI_</sup>
 
-For updates or questions, come hang out in [The Knip Barn (Discord)][10], or follow [@webprolific (Twitter)][11] or
-[@webpro (fosstodon.org)][12]. Please use GitHub to [report issues][13].
+For updates or questions, come hang out in [The Knip Barn (Discord)][11], or follow [@webprolific (Twitter)][12] or
+[@webpro (fosstodon.org)][13]. Please use GitHub to [report issues][14].
 
 ## Contents
 
-- [Getting Started][14]
-  - [Installation][15]
-  - [Default Configuration][16]
-  - [Let's Go!][17]
-- [Configuration][18]
-  - [Entry Files][19]
+- [Getting Started][15]
+  - [Installation][16]
+  - [Default Configuration][17]
+  - [Let's Go!][18]
+- [Configuration][19]
+  - [Entry Files][20]
   - [Workspaces][1]
   - [Plugins][2]
   - [Compilers][3]
-  - [Ignore files, binaries, dependencies and workspaces][20]
-  - [Public exports][21]
-  - [Ignore exports used in file][22]
-  - [Include exports in entry files][23]
-  - [Paths][24]
-- [Production Mode][25]
+  - [Ignore files, binaries, dependencies and workspaces][21]
+  - [Public exports][22]
+  - [Ignore exports used in file][23]
+  - [Include exports in entry files][24]
+  - [Paths][25]
+- [Production Mode][4]
   - [Strict][26]
   - [Ignore `@internal` exports][27]
   - [Plugins][28]
@@ -60,9 +61,9 @@ For updates or questions, come hang out in [The Knip Barn (Discord)][10], or fol
   - [Screenshots][30]
   - [Reading the report][31]
   - [Rules & Filters][32]
-  - [Reporters][4]
+  - [Reporters][5]
 - [Fixing Issues][33]
-- [JSDoc tags][7]
+- [JSDoc tags][8]
 - [Command Line Options][34]
 - [Potential boost with `--no-gitignore`][35]
 - [Comparison & Migration][36]
@@ -88,7 +89,7 @@ Knip supports LTS versions of Node.js, and currently requires at least Node.js v
 
 ### Default Configuration
 
-Knip has good defaults and you can run it without any configuration. The (simplified) default config:
+Knip has good defaults and aims for no or little configuration. The (simplified) default config:
 
 ```json
 {
@@ -97,9 +98,9 @@ Knip has good defaults and you can run it without any configuration. The (simpli
 }
 ```
 
-There's more, jump to [Entry Files][19] for details.
+There's more, jump to [Entry Files][20] for details.
 
-Places where Knip looks for configuration (ordered by priority):
+Knip looks for this configuration file (ordered by priority):
 
 - `knip.json`
 - `knip.jsonc`
@@ -122,7 +123,7 @@ const config: KnipConfig = {
 export default config;
 ```
 
-Use `--config path/to/knip.json` to use a different location.
+Use `--config path/to/knip.config.json` for a different path.
 
 ### Let's Go!
 
@@ -136,8 +137,9 @@ Run the checks with `npx knip`. Or first add this script to `package.json`:
 }
 ```
 
-Then use `npm run knip` to analyze the project and output unused files, dependencies and exports. Knip works just fine
-with `yarn` or `pnpm` as well.
+Then use `npm run knip` to analyze the project and output unused files, dependencies and exports.
+
+Knip works just fine with `yarn` or `pnpm` or `bun`.
 
 See [Command Line Options][34] for an overview of available CLI options.
 
@@ -150,15 +152,15 @@ In addition to `index.js`, the following file names and extensions are also cons
 - `index`, `main` and `cli`
 - `js`, `mjs`, `cjs`, `jsx`, `ts`, `mts`, `cts` and `tsx`
 
-This means files like `main.cjs` and `src/cli.ts` are automatically added as entry files. Knip looks for entry files at
-those default locations, but also in other places:
+This means files like `main.cjs` and `src/cli.ts` are automatically added as entry files. Knip also looks for `entry`
+files in other places:
 
 - The `main`, `bin` and `exports` fields of `package.json`.
-- [Plugins][2] such as for Next.js, Remix, Gatsby or Svelte add entry files.
-- The `scripts` in package.json or other scripts may provide entry files.
+- [Plugins][2] such as for Jest, Next.js, Svelte or Vitest etc. add entry files.
+- The `scripts` in package.json and other scripts may provide entry files.
 
-Knip does this for each [workspace][1] it finds, trying to minimize the configuration to suit your project. In a
-perfectly boring world where everything is according to defaults you wouldn't even need a `knip.json` file at all.
+Knip does this for each [workspace][1] it finds. In a perfectly boring world where everything is according to defaults
+you wouldn't even need a `knip.json` file at all.
 
 Larger projects tend to have more things customized, and therefore probably get more out of Knip with a configuration
 file. Let's say you are using `.ts` files exclusively and have all source files only in the `src` directory:
@@ -202,7 +204,7 @@ Here's an example `knip.json` configuration with some custom `entry` and `projec
 ```
 
 It might be useful to run Knip first with no or little configuration to see where it needs custom `entry` and/or
-`project` files. Each workspace has the same [default configuration][18].
+`project` files. Each workspace has the same [default configuration][19].
 
 The root workspace is named `"."` under `workspaces` (like in the example).
 
@@ -540,6 +542,9 @@ The report contains the following types of issues:
 | Unused exported class members       | unable to find references to this class member  | `classMembers` |
 | Duplicate exports                   | the same thing is exported more than once       | `duplicates`   |
 
+Note that `devDependencies` is covered within a single key for all `dependencies`. In [strict production mode][4],
+`devDependencies` are not included.
+
 When an issue type has zero issues, it is not shown.
 
 Getting too many reported issues and false positives? Read more about [handling issues][49].
@@ -753,7 +758,7 @@ unimported
 knip --production --dependencies --include files
 ```
 
-Also see [production mode][25].
+Also see [production mode][4].
 
 ### ts-unused-exports
 
@@ -793,7 +798,7 @@ Many thanks to some of the early adopters of Knip:
 
 ## Articles, etc.
 
-- Discord: hang out in [The Knip Barn][10]
+- Discord: hang out in [The Knip Barn][11]
 - Ask your questions in the [Knip knowledge base][67] (powered by OpenAI and [7-docs][68], experimental!)
 - Smashing Magazine: [Knip: An Automated Tool For Finding Unused Files, Exports, And Dependencies][69]
 - Effective TypeScript: [Recommendation Update: ✂️ Use knip to detect dead code and types][70]
@@ -820,28 +825,28 @@ Special thanks to the wonderful people who have contributed to this project:
 [1]: #workspaces
 [2]: #plugins
 [3]: #compilers
-[4]: #reporters
-[5]: #custom-reporters
-[6]: #preprocessers
-[7]: #jsdoc-tags
-[8]: https://labs.openai.com/s/xZQACaLepaKya0PRUPtIN5dC
-[9]: ./assets/cow-with-orange-scissors-van-gogh-style.webp
-[10]: https://discord.gg/r5uXTtbTpc
-[11]: https://twitter.com/webprolific
-[12]: https://fosstodon.org/@webpro
-[13]: https://github.com/webpro/knip/issues
-[14]: #getting-started
-[15]: #installation
-[16]: #default-configuration
-[17]: #lets-go
-[18]: #configuration
-[19]: #entry-files
-[20]: #ignore-files-binaries-dependencies-and-workspaces
-[21]: #public-exports
-[22]: #ignore-exports-used-in-file
-[23]: #include-exports-in-entry-files
-[24]: #paths
-[25]: #production-mode
+[4]: #production-mode
+[5]: #reporters
+[6]: #custom-reporters
+[7]: #preprocessers
+[8]: #jsdoc-tags
+[9]: https://labs.openai.com/s/xZQACaLepaKya0PRUPtIN5dC
+[10]: ./assets/cow-with-orange-scissors-van-gogh-style.webp
+[11]: https://discord.gg/r5uXTtbTpc
+[12]: https://twitter.com/webprolific
+[13]: https://fosstodon.org/@webpro
+[14]: https://github.com/webpro/knip/issues
+[15]: #getting-started
+[16]: #installation
+[17]: #default-configuration
+[18]: #lets-go
+[19]: #configuration
+[20]: #entry-files
+[21]: #ignore-files-binaries-dependencies-and-workspaces
+[22]: #public-exports
+[23]: #ignore-exports-used-in-file
+[24]: #include-exports-in-entry-files
+[25]: #paths
 [26]: #strict
 [27]: #ignore-internal-exports
 [28]: #plugins-1

package/dist/WorkspaceWorker.js

@@ -182,8 +182,13 @@ export class WorkspaceWorker {
                     const configFilePaths = allConfigFilePaths.filter(filePath => !filePath.endsWith('package.json') ||
                         get(this.manifest, 'PACKAGE_JSON_PATH' in plugin ? plugin.PACKAGE_JSON_PATH : pluginName));
                     debugLogArray(`Found ${plugin.NAME} config file paths`, configFilePaths);
-                    if (patterns.length > 0 && configFilePaths.length === 0)
-                        continue;
+                    if (patterns.length > 0 && configFilePaths.length === 0) {
+                        if (typeof pluginConfig !== 'boolean' && pluginConfig.entry !== null && pluginConfig.entry.length > 0) {
+                        }
+                        else {
+                            continue;
+                        }
+                    }
                     if (patterns.length === 0)
                         configFilePaths.push(FAKE_PATH);
                     const pluginDependencies = new Set();

package/dist/binaries/index.js

@@ -1,6 +1,7 @@
+import { IGNORED_FILE_EXTENSIONS } from '../constants.js';
 import { compact } from '../util/array.js';
 import { getPackageNameFromModuleSpecifier } from '../util/modules.js';
-import { isInternal } from '../util/path.js';
+import { extname, isInternal } from '../util/path.js';
 import { timerify } from '../util/Performance.js';
 import { isBinary } from '../util/protocols.js';
 import { getBinariesFromScript } from './bash-parser.js';
@@ -10,8 +11,14 @@ const getDependenciesFromScripts = (npmScripts, options = {}) => {
     const scripts = typeof npmScripts === 'string' ? [npmScripts] : [...npmScripts];
     const results = scripts.flatMap(script => getBinariesFromScript(script, { cwd, manifest, knownGlobalsOnly }));
     return compact(results.map(identifier => {
-        if (isBinary(identifier) || isInternal(identifier))
+        if (isBinary(identifier))
             return identifier;
+        if (isInternal(identifier)) {
+            const ext = extname(identifier);
+            if (ext && IGNORED_FILE_EXTENSIONS.includes(ext))
+                return;
+            return identifier;
+        }
         return getPackageNameFromModuleSpecifier(identifier);
     }));
 };

package/dist/constants.js

@@ -45,6 +45,7 @@ export const IGNORED_FILE_EXTENSIONS = [
     '.sass',
     '.scss',
     '.svg',
+    '.sh',
     '.ttf',
     '.webp',
     '.woff',

package/dist/plugins/playwright/index.js

@@ -14,12 +14,14 @@ export const toEntryPatterns = (testMatch, cwd, configFilePath, config) => {
     const patterns = [testMatch].flat().filter((p) => typeof p === 'string');
     return patterns.map(pattern => toEntryPattern(join(dir, pattern)));
 };
-const findPlaywrightDependencies = async (configFilePath, { cwd }) => {
-    const config = await load(configFilePath);
-    const projects = config.projects ? [config, ...config.projects] : [config];
-    const patterns = projects.flatMap(config => toEntryPatterns(config.testMatch, cwd, configFilePath, config));
-    if (patterns.length > 0)
-        return patterns;
-    return toEntryPatterns(ENTRY_FILE_PATTERNS, cwd, configFilePath, config);
+const findPlaywrightDependencies = async (configFilePath, { cwd, config }) => {
+    const cfg = await load(configFilePath);
+    if (cfg) {
+        const projects = cfg.projects ? [cfg, ...cfg.projects] : [cfg];
+        const patterns = projects.flatMap(config => toEntryPatterns(config.testMatch, cwd, configFilePath, config));
+        if (patterns.length > 0)
+            return patterns;
+    }
+    return toEntryPatterns(config?.entry ?? ENTRY_FILE_PATTERNS, cwd, configFilePath, cfg ?? {});
 };
 export const findDependencies = timerify(findPlaywrightDependencies);

package/dist/plugins/storybook/index.d.ts

@@ -3,6 +3,7 @@ export declare const NAME = "Storybook";
 export declare const ENABLERS: (string | RegExp)[];
 export declare const isEnabled: IsPluginEnabledCallback;
 export declare const CONFIG_FILE_PATTERNS: string[];
+export declare const STORIES_FILE_PATTERNS: string[];
 export declare const ENTRY_FILE_PATTERNS: string[];
 export declare const PROJECT_FILE_PATTERNS: string[];
 export declare const findDependencies: GenericPluginCallback;

package/dist/plugins/storybook/index.js

@@ -1,23 +1,27 @@
+import { dirname, join, relative } from '../../util/path.js';
 import { timerify } from '../../util/Performance.js';
 import { hasDependency, load } from '../../util/plugin.js';
 import { toEntryPattern } from '../../util/protocols.js';
 export const NAME = 'Storybook';
 export const ENABLERS = [/^@storybook\//, '@nrwl/storybook'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
-export const CONFIG_FILE_PATTERNS = ['.storybook/{main,manager,test-runner}.{js,ts}'];
-export const ENTRY_FILE_PATTERNS = ['.storybook/preview.{js,jsx,ts,tsx}', '**/*.stories.{js,jsx,ts,tsx}'];
+export const CONFIG_FILE_PATTERNS = ['.storybook/{main,test-runner}.{js,ts}'];
+export const STORIES_FILE_PATTERNS = ['**/*.stories.{js,jsx,ts,tsx}'];
+export const ENTRY_FILE_PATTERNS = ['.storybook/{manager,preview}.{js,jsx,ts,tsx}', ...STORIES_FILE_PATTERNS];
 export const PROJECT_FILE_PATTERNS = ['.storybook/**/*.{js,jsx,ts,tsx}'];
-const findStorybookDependencies = async (configFilePath, { isProduction }) => {
-    const entryPatterns = ENTRY_FILE_PATTERNS.map(toEntryPattern);
+const findStorybookDependencies = async (configFilePath, { isProduction, config }) => {
+    const cfg = await load(configFilePath);
+    const stories = (typeof cfg.stories === 'function' ? await cfg.stories(STORIES_FILE_PATTERNS) : cfg.stories)?.map(pattern => relative(join(dirname(configFilePath), pattern)));
+    const cfgPatterns = [...(config?.entry ?? []), ...(stories ?? [])];
+    const entryPatterns = (cfgPatterns.length > 0 ? cfgPatterns : ENTRY_FILE_PATTERNS).map(toEntryPattern);
     if (isProduction)
         return entryPatterns;
-    const config = await load(configFilePath);
-    if (!config)
+    if (!cfg)
         return [];
-    const addons = config.addons?.map(addon => (typeof addon === 'string' ? addon : addon.name)) ?? [];
-    const builder = config?.core?.builder;
+    const addons = cfg.addons?.map(addon => (typeof addon === 'string' ? addon : addon.name)) ?? [];
+    const builder = cfg?.core?.builder;
     const builderPackages = builder && /webpack/.test(builder) ? [`@storybook/builder-${builder}`, `@storybook/manager-${builder}`] : [];
-    const frameworks = config.framework?.name ? [config.framework.name] : [];
+    const frameworks = cfg.framework?.name ? [cfg.framework.name] : [];
     return [...entryPatterns, ...addons, ...builderPackages, ...frameworks];
 };
 export const findDependencies = timerify(findStorybookDependencies);

package/dist/plugins/storybook/types.d.ts

@@ -1,4 +1,5 @@
 export type StorybookConfig = {
+    stories?: string[] | ((patterns: string[]) => Promise<string[]>);
     addons?: (string | {
         name: string;
     })[];

package/dist/plugins/webpack/index.js

@@ -53,16 +53,16 @@ const findWebpackDependencies = async (configFilePath, { manifest, isProduction
     const dependencies = passes.flatMap(isProduction => {
         const env = { production: isProduction };
         const argv = { mode: isProduction ? 'production' : 'development' };
-        const cfg = typeof config === 'function' ? config(env, argv) : config;
-        return [cfg].flat().flatMap(config => {
-            const dependencies = (config.module?.rules?.flatMap(resolveRuleSetDependencies) ?? []).map(loader => loader.replace(/\?.*/, ''));
+        const resolvedConfig = typeof config === 'function' ? config(env, argv) : config;
+        return [resolvedConfig].flat().flatMap(options => {
+            const dependencies = (options.module?.rules?.flatMap(resolveRuleSetDependencies) ?? []).map(loader => loader.replace(/\?.*/, ''));
             const entries = [];
-            if (typeof cfg.entry === 'string')
-                entries.push(cfg.entry);
-            else if (Array.isArray(cfg.entry))
-                entries.push(...cfg.entry);
-            else if (typeof cfg.entry === 'object') {
-                Object.values(cfg.entry).map(entry => {
+            if (typeof options.entry === 'string')
+                entries.push(options.entry);
+            else if (Array.isArray(options.entry))
+                entries.push(...options.entry);
+            else if (typeof options.entry === 'object') {
+                Object.values(options.entry).map(entry => {
                     if (typeof entry === 'string')
                         entries.push(entry);
                     else if (Array.isArray(entry))
@@ -73,7 +73,7 @@ const findWebpackDependencies = async (configFilePath, { manifest, isProduction
                         entries.push(entry['filename']);
                 });
             }
-            return [...dependencies, ...entries.map(entry => (config.context ? join(config.context, entry) : entry))];
+            return [...dependencies, ...entries.map(entry => (options.context ? join(options.context, entry) : entry))];
         });
     });
     const scripts = Object.values(manifest.scripts ?? {});

package/dist/reporters/json.js

@@ -24,6 +24,7 @@ export default async ({ report, issues, options }) => {
             ...(report.devDependencies && { devDependencies: [] }),
             ...(report.optionalPeerDependencies && { optionalPeerDependencies: [] }),
             ...(report.unlisted && { unlisted: [] }),
+            ...(report.binaries && { binaries: [] }),
             ...(report.unresolved && { unresolved: [] }),
             ...((report.exports || report.nsExports) && { exports: [] }),
             ...((report.types || report.nsTypes) && { types: [] }),

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.33.0";
+export declare const version = "2.33.2";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.33.0';
+export const version = '2.33.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.33.0",
+  "version": "2.33.2",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -69,22 +69,22 @@
     "@release-it/bumper": "5.1.0",
     "@swc/cli": "0.1.62",
     "@swc/core": "1.3.92",
-    "@types/eslint": "8.44.3",
-    "@types/js-yaml": "4.0.6",
+    "@types/eslint": "8.44.4",
+    "@types/js-yaml": "4.0.7",
     "@types/micromatch": "4.0.3",
     "@types/minimist": "1.2.3",
-    "@types/node": "20.8.3",
+    "@types/node": "20.8.4",
     "@types/npmcli__map-workspaces": "3.0.2",
     "@types/pkgjs__parseargs": "0.10.1",
     "@types/webpack": "5.28.3",
-    "@typescript-eslint/eslint-plugin": "6.7.4",
-    "@typescript-eslint/parser": "6.7.4",
+    "@typescript-eslint/eslint-plugin": "6.7.5",
+    "@typescript-eslint/parser": "6.7.5",
     "c8": "8.0.1",
     "eslint": "8.51.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-n": "16.1.0",
-    "playwright": "1.38.1",
+    "eslint-plugin-n": "16.2.0",
+    "playwright": "1.39.0",
     "prettier": "3.0.3",
     "release-it": "16.2.1",
     "remark-cli": "12.0.0",