knip 1.6.0 → 1.7.0

package/README.md

@@ -8,7 +8,7 @@ export const myVar = true;
 ```
 
 ESLint handles files in isolation, so it does not know whether `myVar` is actually used somewhere else. Knip lints the
-project as a whole, and finds unused exports, files and dependencies
+project as a whole, and finds unused exports, files and dependencies.
 
 It's only human to forget removing things that you no longer use. But how do you find out? Where to even start finding
 things that can be removed?
@@ -26,25 +26,22 @@ The dots don't connect themselves. This is where Knip comes in:
 - [x] Features multiple [reporters][2] and supports [custom reporters][3]
 - [x] Run Knip as part of your CI environment to detect issues and prevent regressions
 
-Knip shines in both small and large projects. A comparison with similar tools answers the question [why another unused
-file/dependency/export finder?][4]
+Knip shines in both small and large projects. It's a fresh take on keeping your projects clean & tidy!
 
-Knip is a fresh take on keeping your projects clean & tidy!
-
-[![An orange cow with scissors, Van Gogh style][6]][5] <sup>_“An orange cow with scissors, Van Gogh style” - generated
+[![An orange cow with scissors, Van Gogh style][5]][4] <sup>_“An orange cow with scissors, Van Gogh style” - generated
 with OpenAI_</sup>
 
 ## Migrating to v1.0.0
 
-When coming from version v0.13.3 or before, please see [migration to v1][7].
+When coming from version v0.13.3 or before, please see [migration to v1][6].
 
 ## Issues
 
-Please report any false positives by [opening an issue in this repo][8]. Bonus points for linking to a public repository
-using Knip, or even opening a pull request with a directory and example files in `test/fixtures`. Correctness and bug
-fixes have priority over performance and new features.
+Are you seeing false positives? Please report them by [opening an issue in this repo][7]. Bonus points for linking to a
+public repository using Knip, or even opening a pull request with a directory and example files in `test/fixtures`.
+Correctness and bug fixes have priority over performance and new features.
 
-Also see the [FAQ][9].
+Also see the [FAQ][8].
 
 ## Installation
 
@@ -69,7 +66,7 @@ with a configuration file (or a `knip` property in `package.json`). Let's name t
 The `entry` files target the starting point(s) to resolve the rest of the imported code. The `project` files should
 contain all files to match against the files resolved from the entry files, including potentially unused files.
 
-Then run the checks with `npx knip`, or add a script to `package.json`:
+Then run the checks with `npx knip`. Or first add this script to `package.json`:
 
 ```json
 {
@@ -79,7 +76,8 @@ Then run the checks with `npx knip`, or add a script to `package.json`:
 }
 ```
 
-Use `npm run knip` to analyze the project and output unused files, dependencies and exports.
+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.
 
 ## Command-line options
 
@@ -146,6 +144,15 @@ The report contains the following types of issues:
 - **Unused exported class members**: did not find references to this member of the exported class
 - **Duplicate exports**: the same thing is exported more than once
 
+When an issue type has zero issues, it is not shown.
+
+_(1)_ This includes imports that could not be resolved.
+
+_(2)_ The variable or type is not referenced directly, and has become a member of a namespace. Knip can't find a
+reference to it, so you can _probably_ remove it.
+
+### Output filters
+
 You can `--include` or `--exclude` any of the types to slice & dice the report to your needs. Alternatively, they can be
 added to the configuration (e.g. `"exclude": ["dependencies"]`).
 
@@ -164,18 +171,20 @@ Use `--exclude` to ignore reports you're not interested in:
 Use `--dependencies` or `--exports` as shortcuts to combine groups of related types.
 
 Still not happy with the results? Getting too much output/false positives? The [FAQ][9] may be useful. Feel free to open
-an issue and I'm happy to look into it.
+an issue and I'm happy to look into it. Also see the next section on how to [ignore][10] certain false positives:
 
----
+## Ignore
 
-_(1)_ This includes dependencies that could not be resolved. For instance, what does `unresolved/dir/module` mean?
+There are a few ways to tell Knip to ignore certain packages, binaries, dependencies and workspaces. Some examples:
 
-- It might target a missing `unresolved` package in `node_modules/unresolved`.
-- It might incorrectly target a local module that should have a relative path.
-- It does not match any `paths` entry in `tsconfig.json#compilerOptions`.
-
-_(2)_ The variable or type is not referenced directly, and has become a member of a namespace. That's why Knip is not
-sure whether this export can be removed, so please look into it.
+```json
+{
+  "ignore": ["**/*.d.ts", "**/fixtures"],
+  "ignoreBinaries": ["zip", "docker-compose"],
+  "ignoreDependencies": ["hidden-package"],
+  "ignoreWorkspaces": ["packages/deno-lib"]
+}
+```
 
 ## Now what?
 
@@ -218,7 +227,7 @@ analysis.
 Extra "workspaces" not configured as a workspace in the root `package.json` can be configured as well, Knip is happy to
 analyze unused dependencies and exports from any directory with a `package.json`.
 
-Here's a small output example when running Knip in a workspace:
+Here's some example output when running Knip in a workspace:
 
 <img src="./assets/screenshot-workspaces.png" alt="example output in workspaces" width="578">
 
@@ -226,7 +235,7 @@ Here's a small output example when running Knip in a workspace:
 
 Knip contains a growing list of plugins:
 
-- [Babel][10]
+- [Babel][9]
 - [Capacitor][11]
 - [Changesets][12]
 - [commitlint][13]
@@ -257,9 +266,9 @@ Knip contains a growing list of plugins:
 - [Vitest][38]
 - [Webpack][39]
 
-Plugins are automatically activated, no need to enable anything. Each plugin is automatically enabled based on simple
-heuristics. Most of them check whether one or one of a few (dev) dependencies are listed in `package.json`. Once
-enabled, they add a set of configuration and/or entry files for Knip to analyze. These defaults can be overriden.
+Plugins are automatically activated. Each plugin is automatically enabled based on simple heuristics. Most of them check
+whether one or one of a few (dev) dependencies are listed in `package.json`. Once enabled, they add a set of
+configuration and/or entry files for Knip to analyze. These defaults can be overriden.
 
 Most plugins use one or both of the following file types:
 
@@ -270,7 +279,7 @@ See each plugin's documentation for its default values.
 
 ### `config`
 
-Plugins may include `config` files. They are parsed by the plugin's custom dependency resolvers. Here are some examples
+Plugins may include `config` files. They are parsed by the plugin's custom dependency resolver. Here are some examples
 to get an idea of how they work and why they are needed:
 
 - The `eslint` plugin tells Knip that the `"prettier"` entry in the array of `plugins` means that the
@@ -429,10 +438,11 @@ all of this, why not collect the various issues in one go?
 The structure and configuration of projects and their dependencies vary wildly, and no matter how well-balanced,
 defaults only get you so far. Some implementations and some tools out there have smart or unconventional ways to import
 code, making things more complicated. That's why Knip tends to require more configuration in larger projects, based on
-how many dependencies are used and how much the project diverges from the defaults.
+how many dependencies are used and how much the configuration in the project diverges from the defaults.
 
-One important goal of Knip is to minimize the amount of configuration necessary. So when there are feasible ways to
-infer things automatically, reducing the amount of configuration, please open an issue.
+One important goal of Knip is to minimize the amount of configuration necessary. When you false positives are reported
+and you think there are feasible ways to infer things automatically, reducing the amount of configuration, please open
+an issue.
 
 ### How do I handle too many output/false positives?
 
@@ -457,17 +467,21 @@ When the dependencies don't have a Knip plugin yet, please file an issue or [cre
 
 When the project is a library and the exports are meant to be used by consumers of the library, there are two options:
 
-1.  By default, unused exports of `entry` files are not reported, so you can add the containing file to it.
+1.  By default, unused exports of `entry` files are not reported. You could re-export from an existing entry file, or
+    add the containing file to the `entry` array in the configuration.
 2.  The exported values or types can be marked [using the JSDoc `@public` tag][47].
 
 ### How to start using Knip in CI while having too many issues to sort out?
 
 Eventually this type of QA only really works when it's tied to an automated workflow. But with too many issues to
-resolve this might not be feasible right away, especially in existing larger codebase. Here are a few options:
+resolve this might not be feasible right away, especially in existing larger codebase. Here are a few options that may
+help:
 
 - Use `--no-exit-code` for exit code 0 in CI.
-- Use `--include` (or `--exclude`) to report only the issue types don't have errors.
+- Use `--include` (or `--exclude`) to report only the issue types that have little or no errors.
+- Use a separate `--dependencies` and/or `--exports` Knip command.
 - Use `ignore` (for files and directories) and `ignoreDependencies` to filter out some problematic areas.
+- Limit the number of workspaces configured to analyze in `knip.json`.
 
 All of this is hiding problems, so please make sure to plan for fixing them and/or open issues here for false positives.
 
@@ -543,13 +557,13 @@ for the job. I'm motivated to make knip perfectly suited for the job of cutting
 [1]: #plugins
 [2]: #reporters
 [3]: #custom-reporters
-[4]: #really-another-unused-filedependencyexport-finder
-[5]: https://labs.openai.com/s/xZQACaLepaKya0PRUPtIN5dC
-[6]: ./assets/cow-with-orange-scissors-van-gogh-style.webp
-[7]: ./docs/migration-to-v1.md
-[8]: https://github.com/webpro/knip/issues
-[9]: #faq
-[10]: ./src/plugins/babel
+[4]: https://labs.openai.com/s/xZQACaLepaKya0PRUPtIN5dC
+[5]: ./assets/cow-with-orange-scissors-van-gogh-style.webp
+[6]: ./docs/migration-to-v1.md
+[7]: https://github.com/webpro/knip/issues
+[8]: #faq
+[9]: ./src/plugins/babel
+[10]: #ignore
 [11]: ./src/plugins/capacitor
 [12]: ./src/plugins/changesets
 [13]: ./src/plugins/commitlint

package/dist/constants.js

@@ -7,7 +7,23 @@ export const DEFAULT_WORKSPACE_CONFIG = {
     ignore: [],
 };
 export const TEST_FILE_PATTERNS = ['**/*.{test,spec}.{js,jsx,ts,tsx}', '**/__tests__/**/*.{js,jsx,ts,tsx}'];
-export const IGNORED_GLOBAL_BINARIES = ['npm', 'npx', 'node', 'yarn', 'pnpm', 'deno', 'git'];
+export const IGNORED_GLOBAL_BINARIES = [
+    'deno',
+    'git',
+    'node',
+    'npm',
+    'npx',
+    'pnpm',
+    'yarn',
+    'cd',
+    'cp',
+    'echo',
+    'exit',
+    'mkdir',
+    'mv',
+    'rm',
+    'sudo',
+];
 export const IGNORE_DEFINITELY_TYPED = ['node'];
 export const ISSUE_TYPES = [
     'files',

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

@@ -1,5 +1,5 @@
-import type { IsPluginEnabledCallback, GenericPluginCallback } from '../../types/plugins.js';
 import type { BabelConfig } from './types.js';
+import type { IsPluginEnabledCallback, GenericPluginCallback } from '../../types/plugins.js';
 export declare const NAME = "Babel";
 export declare const ENABLERS: RegExp[];
 export declare const isEnabled: IsPluginEnabledCallback;

package/dist/plugins/github-actions/index.js

@@ -6,7 +6,7 @@ import { timerify } from '../../util/performance.js';
 export const NAME = 'GitHub Actions';
 export const ENABLERS = 'This plugin is enabled when a `.yml` file is found in the `.github/workflows` folder.';
 export const isEnabled = async ({ cwd }) => Boolean(await _firstGlob({ cwd, patterns: ['.github/workflows/*.yml'] }));
-export const CONFIG_FILE_PATTERNS = ['.github/workflows/*.yml'];
+export const CONFIG_FILE_PATTERNS = ['.github/workflows/*.yml', '.github/**/action.{yml,yaml}'];
 const findGithubActionsDependencies = async (configFilePath, { manifest, rootConfig }) => {
     const config = await _load(configFilePath);
     if (!config)

package/dist/plugins/nx/index.js

@@ -1,4 +1,5 @@
 import { compact } from '../../util/array.js';
+import { getBinariesFromScripts } from '../../util/binaries/index.js';
 import { _load } from '../../util/loader.js';
 import { timerify } from '../../util/performance.js';
 import { hasDependency } from '../../util/plugin.js';
@@ -6,10 +7,19 @@ export const NAME = 'Nx';
 export const ENABLERS = [/^@nrwl\//];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
 export const CONFIG_FILE_PATTERNS = ['{apps,libs}/**/project.json'];
-const findNxDependencies = async (configFilePath) => {
+const findNxDependencies = async (configFilePath, { manifest }) => {
     const config = await _load(configFilePath);
-    const { targets } = config;
-    const executors = targets ? Object.values(targets).map(target => target?.executor) : [];
-    return compact(executors.filter(executor => executor && !executor.startsWith('.')).map(executor => executor?.split(':')[0]));
+    if (!config)
+        return [];
+    const targets = config.targets ? Object.values(config.targets) : [];
+    const executors = compact(targets
+        .map(target => target?.executor)
+        .filter(executor => executor && !executor.startsWith('.'))
+        .map(executor => executor?.split(':')[0]));
+    const scripts = compact(targets
+        .filter(target => target.executor === 'nx:run-commands')
+        .flatMap(target => (target.options?.commands ?? target.options?.command ? [target.options.command] : [])));
+    const binaries = getBinariesFromScripts(scripts, { manifest, knownGlobalsOnly: true });
+    return [...executors, ...binaries];
 };
 export const findDependencies = timerify(findNxDependencies);

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

@@ -0,0 +1,11 @@
+export interface NxProjectConfiguration {
+    targets?: {
+        [targetName: string]: {
+            executor?: string;
+            options?: {
+                command?: string;
+                commands?: string[];
+            };
+        };
+    };
+}

package/dist/plugins/nx/types.js

@@ -0,0 +1 @@
+export {};

package/dist/plugins/vitest/index.js

@@ -1,3 +1,4 @@
+import { compact } from '../../util/array.js';
 import { _load } from '../../util/loader.js';
 import { timerify } from '../../util/performance.js';
 import { hasDependency } from '../../util/plugin.js';
@@ -15,6 +16,6 @@ const findVitestDependencies = async (configFilePath) => {
     const environments = cfg.environment ? [getEnvPackageName(cfg.environment)] : [];
     const reporters = getExternalReporters(cfg.reporters);
     const coverage = cfg.coverage?.provider ? [`@vitest/coverage-${cfg.coverage.provider}`] : [];
-    return [...environments, ...reporters, ...coverage];
+    return compact([...environments, ...reporters, ...coverage]);
 };
 export const findDependencies = timerify(findVitestDependencies);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -38,27 +38,27 @@
     "schema.json"
   ],
   "dependencies": {
-    "@esbuild-kit/esm-loader": "2.5.4",
-    "@npmcli/map-workspaces": "3.0.1",
-    "@snyk/github-codeowners": "1.1.0",
-    "chalk": "5.2.0",
-    "easy-table": "1.2.0",
-    "esbuild": "0.17.0",
+    "@esbuild-kit/esm-loader": "^2.5.4",
+    "@npmcli/map-workspaces": "^3.0.1",
+    "@snyk/github-codeowners": "^1.1.0",
+    "chalk": "^5.2.0",
+    "easy-table": "^1.2.0",
+    "esbuild": "^0.17.3",
     "esbuild-register": "3.4.2",
-    "eslint": "8.32.0",
-    "fast-glob": "3.2.12",
-    "get-tsconfig": "4.3.0",
-    "globby": "13.1.3",
-    "js-yaml": "4.1.0",
-    "micromatch": "4.0.5",
-    "nano-memoize": "2.0.0",
-    "patch-package": "6.5.1",
-    "pretty-ms": "8.0.0",
-    "strip-json-comments": "5.0.0",
-    "summary": "2.1.0",
-    "ts-morph": "17.0.1",
-    "ts-morph-helpers": "0.6.3",
-    "zod": "3.20.2"
+    "eslint": "^8.32.0",
+    "fast-glob": "^3.2.12",
+    "get-tsconfig": "^4.3.0",
+    "globby": "^13.1.3",
+    "js-yaml": "^4.1.0",
+    "micromatch": "^4.0.5",
+    "nano-memoize": "^2.0.0",
+    "patch-package": "^6.5.1",
+    "pretty-ms": "^8.0.0",
+    "strip-json-comments": "^5.0.0",
+    "summary": "^2.1.0",
+    "ts-morph": "^17.0.1",
+    "ts-morph-helpers": "^0.6.3",
+    "zod": "^3.20.2"
   },
   "devDependencies": {
     "@jest/types": "29.3.1",
@@ -69,10 +69,10 @@
     "@types/node": "18.11.18",
     "@types/npmcli__map-workspaces": "3.0.0",
     "@types/webpack": "5.28.0",
-    "@typescript-eslint/eslint-plugin": "5.48.1",
-    "@typescript-eslint/parser": "5.48.1",
+    "@typescript-eslint/eslint-plugin": "5.48.2",
+    "@typescript-eslint/parser": "5.48.2",
     "eslint-import-resolver-typescript": "3.5.3",
-    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-import": "2.27.5",
     "globstar": "1.0.0",
     "release-it": "15.6.0",
     "remark-cli": "11.0.0",