knip 2.21.1 → 2.22.0

package/README.md

@@ -624,7 +624,7 @@ Tip: back up files or use an VCS like Git before deleting files or making change
 
 Repeat the process to reveal new unused files and exports. It's so liberating to remove unused things!
 
-Getting too many reported issues and false positives? Read more about [handling issues][50] describing potential causes
+Getting too many reported issues and false positives? Read more about [handling issues][48] describing potential causes
 for false positives, and how to handle them.
 
 ## Command Line Options
@@ -640,7 +640,7 @@ for false positives, and how to handle them.
       --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
       --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)
       --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)
-      --workspace [dir]        Analyze a single workspace (default: analyze all configured workspaces)
+      -W, --workspace [dir]    Analyze a single workspace (default: analyze all configured workspaces)
       --no-gitignore           Don't use .gitignore
       --include                Report only provided issue type(s), can be comma-separated or repeated (1)
       --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)
@@ -675,13 +675,13 @@ for false positives, and how to handle them.
 
 ## Potential boost with `--no-gitignore`
 
-To increase performance in a large monorepo, check out [Potential boost with `--no-gitignore`][51].
+To increase performance in a large monorepo, check out [Potential boost with `--no-gitignore`][50].
 
 ## Comparison & Migration
 
 This table is an ongoing comparison. Based on their docs (please report any mistakes):
 
-| Feature                 | **knip** | [depcheck][52] | [unimported][53] | [ts-unused-exports][54] | [ts-prune][55] |
+| Feature                 | **knip** | [depcheck][51] | [unimported][52] | [ts-unused-exports][53] | [ts-prune][54] |
 | :---------------------- | :------: | :------------: | :--------------: | :---------------------: | :------------: |
 | Unused files            |    ✅    |       -        |        ✅        |            -            |       -        |
 | Unused dependencies     |    ✅    |       ✅       |        ✅        |            -            |       -        |
@@ -739,25 +739,25 @@ The following commands are similar:
 
 Many thanks to some of the early adopters of Knip:
 
-- [Block Protocol][56]
-- [DeepmergeTS][57]
-- [eslint-plugin-functional][58]
-- [freeCodeCamp.org][59]
-- [is-immutable-type][60]
-- [IsaacScript][61]
-- [Nuxt][62]
-- [Owncast][63]
-- [release-it][64]
-- [Template TypeScript Node Package][65]
-- [Tipi][66]
+- [Block Protocol][55]
+- [DeepmergeTS][56]
+- [eslint-plugin-functional][57]
+- [freeCodeCamp.org][58]
+- [is-immutable-type][59]
+- [IsaacScript][60]
+- [Nuxt][61]
+- [Owncast][62]
+- [release-it][63]
+- [Template TypeScript Node Package][64]
+- [Tipi][65]
 
 ## Articles, etc.
 
 - Discord: hang out in [The Knip Barn][9]
-- 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]
-- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][71]
+- Ask your questions in the [Knip knowledge base][66] (powered by OpenAI and [7-docs][67], experimental!)
+- Smashing Magazine: [Knip: An Automated Tool For Finding Unused Files, Exports, And Dependencies][68]
+- Effective TypeScript: [Recommendation Update: ✂️ Use knip to detect dead code and types][69]
+- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][70]
 
 ## Why "Knip"?
 
@@ -775,7 +775,7 @@ each file, and traversing all of this, why not collect the various issues in one
 
 Special thanks to the wonderful people who have contributed to this project:
 
-[![Contributors][73]][72]
+[![Contributors][72]][71]
 
 [1]: #workspaces
 [2]: #plugins
@@ -824,32 +824,31 @@ Special thanks to the wonderful people who have contributed to this project:
 [45]: https://nx.dev/concepts/integrated-vs-package-based
 [46]: ./docs/writing-a-plugin.md
 [47]: ./docs/compilers.md
-[48]: #handling-issues
+[48]: ./docs/handling-issues.md
 [49]: ./docs/reporters-and-preprocessors.md
-[50]: ./docs/handling-issues.md
-[51]: ./docs/perf-boost-with-no-gitignore.md
-[52]: https://github.com/depcheck/depcheck
-[53]: https://github.com/smeijer/unimported
-[54]: https://github.com/pzavolinsky/ts-unused-exports
-[55]: https://github.com/nadeesha/ts-prune
-[56]: https://github.com/blockprotocol/blockprotocol
-[57]: https://github.com/RebeccaStevens/deepmerge-ts
-[58]: https://github.com/eslint-functional/eslint-plugin-functional
-[59]: https://github.com/freeCodeCamp/freeCodeCamp
-[60]: https://github.com/RebeccaStevens/is-immutable-type
-[61]: https://github.com/IsaacScript/isaacscript
-[62]: https://github.com/nuxt/nuxt
-[63]: https://github.com/owncast/owncast
-[64]: https://github.com/release-it/release-it
-[65]: https://github.com/JoshuaKGoldberg/template-typescript-node-package
-[66]: https://github.com/meienberger/runtipi
-[67]: https://knip.deno.dev
-[68]: https://github.com/7-docs/7-docs
-[69]: https://www.smashingmagazine.com/2023/08/knip-automated-tool-find-unused-files-exports-dependencies/
-[70]: https://effectivetypescript.com/2023/07/29/knip/
-[71]: https://www.joshuakgoldberg.com/blog/speeding-up-centered-part-4-unused-code-bloat/
-[72]: https://github.com/webpro/knip/graphs/contributors
-[73]: https://contrib.rocks/image?repo=webpro/knip
+[50]: ./docs/perf-boost-with-no-gitignore.md
+[51]: https://github.com/depcheck/depcheck
+[52]: https://github.com/smeijer/unimported
+[53]: https://github.com/pzavolinsky/ts-unused-exports
+[54]: https://github.com/nadeesha/ts-prune
+[55]: https://github.com/blockprotocol/blockprotocol
+[56]: https://github.com/RebeccaStevens/deepmerge-ts
+[57]: https://github.com/eslint-functional/eslint-plugin-functional
+[58]: https://github.com/freeCodeCamp/freeCodeCamp
+[59]: https://github.com/RebeccaStevens/is-immutable-type
+[60]: https://github.com/IsaacScript/isaacscript
+[61]: https://github.com/nuxt/nuxt
+[62]: https://github.com/owncast/owncast
+[63]: https://github.com/release-it/release-it
+[64]: https://github.com/JoshuaKGoldberg/template-typescript-node-package
+[65]: https://github.com/meienberger/runtipi
+[66]: https://knip.deno.dev
+[67]: https://github.com/7-docs/7-docs
+[68]: https://www.smashingmagazine.com/2023/08/knip-automated-tool-find-unused-files-exports-dependencies/
+[69]: https://effectivetypescript.com/2023/07/29/knip/
+[70]: https://www.joshuakgoldberg.com/blog/speeding-up-centered-part-4-unused-code-bloat/
+[71]: https://github.com/webpro/knip/graphs/contributors
+[72]: https://contrib.rocks/image?repo=webpro/knip
 [plugin-ava]: ./src/plugins/ava
 [plugin-babel]: ./src/plugins/babel
 [plugin-capacitor]: ./src/plugins/capacitor

package/dist/DependencyDeputy.d.ts

@@ -32,6 +32,7 @@ export declare class DependencyDeputy {
         scripts: string[];
         dependencies: string[];
         peerDependencies: string[];
+        optionalPeerDependencies: string[];
         optionalDependencies: string[];
         devDependencies: string[];
         allDependencies: string[];
@@ -46,12 +47,15 @@ export declare class DependencyDeputy {
     addReferencedBinary(workspaceName: string, binaryName: string): void;
     addPeerDependencies(workspaceName: string, peerDependencies: Map<string, Set<string>>): void;
     getPeerDependenciesOf(workspaceName: string, dependency: string): string[];
+    getPeerDependencies(workspaceName: string): string[];
+    getOptionalPeerDependencies(workspaceName: string): string[];
     maybeAddReferencedExternalDependency(workspace: Workspace, packageName: string): boolean;
     maybeAddReferencedBinary(workspace: Workspace, binaryName: string): boolean;
     private isInDependencies;
     settleDependencyIssues(): {
         dependencyIssues: Issue[];
         devDependencyIssues: Issue[];
+        optionalPeerDependencyIssues: Issue[];
     };
     getConfigurationHints(): {
         configurationHints: ConfigurationHints;

package/dist/DependencyDeputy.js

@@ -22,6 +22,11 @@ export class DependencyDeputy {
         const dependencies = Object.keys(manifest.dependencies ?? {});
         const peerDependencies = Object.keys(manifest.peerDependencies ?? {});
         const optionalDependencies = Object.keys(manifest.optionalDependencies ?? {});
+        const optionalPeerDependencies = manifest.peerDependenciesMeta
+            ? peerDependencies.filter(peerDependency => manifest.peerDependenciesMeta &&
+                peerDependency in manifest.peerDependenciesMeta &&
+                manifest.peerDependenciesMeta[peerDependency].optional)
+            : [];
         const devDependencies = Object.keys(manifest.devDependencies ?? {});
         const allDependencies = [...dependencies, ...devDependencies, ...peerDependencies, ...optionalDependencies];
         this._manifests.set(name, {
@@ -32,6 +37,7 @@ export class DependencyDeputy {
             scripts,
             dependencies,
             peerDependencies,
+            optionalPeerDependencies,
             optionalDependencies,
             devDependencies,
             allDependencies,
@@ -79,6 +85,18 @@ export class DependencyDeputy {
     getPeerDependenciesOf(workspaceName, dependency) {
         return Array.from(this.peerDependencies.get(workspaceName)?.get(dependency) ?? []);
     }
+    getPeerDependencies(workspaceName) {
+        const manifest = this._manifests.get(workspaceName);
+        if (!manifest)
+            return [];
+        return manifest.peerDependencies;
+    }
+    getOptionalPeerDependencies(workspaceName) {
+        const manifest = this._manifests.get(workspaceName);
+        if (!manifest)
+            return [];
+        return manifest.optionalPeerDependencies;
+    }
     maybeAddReferencedExternalDependency(workspace, packageName) {
         if (isBuiltin(packageName))
             return true;
@@ -133,6 +151,7 @@ export class DependencyDeputy {
     settleDependencyIssues() {
         const dependencyIssues = [];
         const devDependencyIssues = [];
+        const optionalPeerDependencyIssues = [];
         for (const [workspaceName, { manifestPath, ignoreDependencies, ignoreBinaries }] of this._manifests.entries()) {
             const referencedDependencies = this.referencedDependencies.get(workspaceName);
             const installedBinaries = this.getInstalledBinaries(workspaceName);
@@ -175,6 +194,7 @@ export class DependencyDeputy {
             const isNotReferencedDependency = (dependency) => !isReferencedDependency(dependency);
             const pd = this.getProductionDependencies(workspaceName);
             const dd = this.getDevDependencies(workspaceName);
+            const od = this.getOptionalPeerDependencies(workspaceName);
             pd.filter(isNotIgnoredDependency)
                 .filter(isNotIgnoredBinary)
                 .filter(isNotReferencedDependency)
@@ -183,8 +203,12 @@ export class DependencyDeputy {
                 .filter(isNotIgnoredBinary)
                 .filter(isNotReferencedDependency)
                 .forEach(symbol => devDependencyIssues.push({ type: 'devDependencies', filePath: manifestPath, symbol }));
+            od.filter(isNotIgnoredDependency)
+                .filter(isNotIgnoredBinary)
+                .filter(p => isReferencedDependency(p))
+                .forEach(symbol => optionalPeerDependencyIssues.push({ type: 'optionalPeerDependencies', filePath: manifestPath, symbol }));
         }
-        return { dependencyIssues, devDependencyIssues };
+        return { dependencyIssues, devDependencyIssues, optionalPeerDependencyIssues };
     }
     getConfigurationHints() {
         const configurationHints = new Set();
@@ -199,12 +223,13 @@ export class DependencyDeputy {
             const dependencies = this.isStrict
                 ? this.getProductionDependencies(workspaceName)
                 : [...this.getProductionDependencies(workspaceName), ...this.getDevDependencies(workspaceName)];
+            const peerDependencies = this.getPeerDependencies(workspaceName);
             const isReferencedDep = (name) => referencedDependencies?.has(name) && dependencies.includes(name);
             const isReferencedBin = (name) => referencedBinaries?.has(name) && installedBinaries?.has(name);
             ignoreDependencies
                 .filter(packageName => IGNORED_DEPENDENCIES.includes(packageName) ||
                 (workspaceName !== ROOT_WORKSPACE_NAME && this.ignoreDependencies.includes(packageName)) ||
-                isReferencedDep(packageName))
+                (!peerDependencies.includes(packageName) && isReferencedDep(packageName)))
                 .forEach(identifier => configurationHints.add({ workspaceName, identifier, type: 'ignoreDependencies' }));
             ignoreBinaries
                 .filter(binaryName => IGNORED_GLOBAL_BINARIES.includes(binaryName) ||
@@ -216,11 +241,13 @@ export class DependencyDeputy {
         const dependencies = this.isStrict
             ? this.getProductionDependencies(ROOT_WORKSPACE_NAME)
             : [...this.getProductionDependencies(ROOT_WORKSPACE_NAME), ...this.getDevDependencies(ROOT_WORKSPACE_NAME)];
+        const peerDependencies = this.getPeerDependencies(ROOT_WORKSPACE_NAME);
         Object.keys(rootIgnoreBinaries)
             .filter(key => IGNORED_GLOBAL_BINARIES.includes(key) || (rootIgnoreBinaries[key] !== 0 && installedBinaries?.has(key)))
             .forEach(identifier => configurationHints.add({ workspaceName: ROOT_WORKSPACE_NAME, identifier, type: 'ignoreBinaries' }));
         Object.keys(rootIgnoreDependencies)
-            .filter(key => IGNORED_DEPENDENCIES.includes(key) || (rootIgnoreDependencies[key] !== 0 && dependencies.includes(key)))
+            .filter(key => IGNORED_DEPENDENCIES.includes(key) ||
+            (rootIgnoreDependencies[key] !== 0 && !peerDependencies.includes(key) && dependencies.includes(key)))
             .forEach(identifier => configurationHints.add({ workspaceName: ROOT_WORKSPACE_NAME, identifier, type: 'ignoreDependencies' }));
         return { configurationHints };
     }

package/dist/ProjectPrincipal.d.ts

@@ -60,7 +60,5 @@ export declare class ProjectPrincipal {
     };
     findUnusedMembers(filePath: string, members: ExportItemMember[]): string[];
     private findReferences;
-    isPublicExport(exportedItem: ExportItem): boolean;
-    getJSDocTags(exportedItem: ExportItem): string[];
 }
 export {};

package/dist/ProjectPrincipal.js

@@ -2,7 +2,7 @@ import { isGitIgnoredSync } from 'globby';
 import ts from 'typescript';
 import { DEFAULT_EXTENSIONS } from './constants.js';
 import { IGNORED_FILE_EXTENSIONS } from './constants.js';
-import { isInModuleBlock } from './typescript/ast-helpers.js';
+import { getJSDocTags, isInModuleBlock } from './typescript/ast-helpers.js';
 import { createHosts } from './typescript/createHosts.js';
 import { getImportsAndExports } from './typescript/getImportsAndExports.js';
 import { SourceFileManager } from './typescript/SourceFileManager.js';
@@ -178,7 +178,7 @@ export class ProjectPrincipal {
     findUnusedMembers(filePath, members) {
         return members
             .filter(member => {
-            if (this.isPublicExport(member))
+            if (getJSDocTags(member.node).includes('@public'))
                 return false;
             const referencedSymbols = this.findReferences(filePath, member.pos);
             const files = referencedSymbols
@@ -194,11 +194,4 @@ export class ProjectPrincipal {
     findReferences(filePath, pos) {
         return this.backend.lsFindReferences(filePath, pos) ?? [];
     }
-    isPublicExport(exportedItem) {
-        const tags = this.getJSDocTags(exportedItem);
-        return tags.includes('@public');
-    }
-    getJSDocTags(exportedItem) {
-        return ts.getJSDocTags(exportedItem.node).map(node => node.getText().match(/@\S+/)[0]);
-    }
 }

package/dist/binaries/bash-parser.js

@@ -15,7 +15,7 @@ export const getBinariesFromScript = (script, { cwd, manifest, knownGlobalsOnly
                 if (commandExpansions.length > 0) {
                     return commandExpansions.flatMap(expansion => getBinariesFromNodes(expansion.commandAST.commands)) ?? [];
                 }
-                if (!binary || binary === '.' || binary === 'source')
+                if (!binary || binary === '.' || binary === 'source' || binary === '[')
                     return [];
                 if (binary.startsWith('-') || binary.startsWith('"') || binary.startsWith('..'))
                     return [];
@@ -34,13 +34,15 @@ export const getBinariesFromScript = (script, { cwd, manifest, knownGlobalsOnly
             case 'LogicalExpression':
                 return getBinariesFromNodes([node.left, node.right]);
             case 'If':
-                return getBinariesFromNodes([...node.clause.commands, ...node.then.commands, ...(node.else?.commands ?? [])]);
+                return getBinariesFromNodes([node.clause, node.then, ...(node.else ? [node.else] : [])]);
             case 'For':
                 return getBinariesFromNodes(node.do.commands);
             case 'CompoundList':
                 return getBinariesFromNodes(node.commands);
             case 'Pipeline':
                 return getBinariesFromNodes(node.commands);
+            case 'Function':
+                return getBinariesFromNodes(node.body.commands);
             default:
                 return [];
         }

package/dist/binaries/resolvers/pnpm.js

@@ -53,7 +53,7 @@ const commands = [
 ];
 export const resolve = (_binary, args, { manifest }) => {
     const scripts = manifest.scripts ? Object.keys(manifest.scripts) : [];
-    const parsed = parseArgs(args, {});
+    const parsed = parseArgs(args, { alias: { recursive: 'r' }, boolean: ['recursive'] });
     const [command, binary] = parsed._;
     if (scripts.includes(command) || commands.includes(command))
         return [];

package/dist/constants.js

@@ -60,6 +60,7 @@ export const ISSUE_TYPES = [
     'files',
     'dependencies',
     'devDependencies',
+    'optionalPeerDependencies',
     'unlisted',
     'binaries',
     'unresolved',
@@ -75,6 +76,7 @@ export const ISSUE_TYPE_TITLE = {
     files: 'Unused files',
     dependencies: 'Unused dependencies',
     devDependencies: 'Unused devDependencies',
+    optionalPeerDependencies: 'Referenced optional peerDependencies',
     unlisted: 'Unlisted dependencies',
     binaries: 'Unlisted binaries',
     unresolved: 'Unresolved imports',

package/dist/index.js

@@ -208,8 +208,10 @@ export const main = async (unresolvedConfiguration) => {
                     }
                 }
                 duplicate.forEach(symbols => {
-                    const symbol = symbols.join('|');
-                    collector.addIssue({ type: 'duplicates', filePath, symbol, symbols });
+                    if (symbols.length > 1) {
+                        const symbol = symbols.join('|');
+                        collector.addIssue({ type: 'duplicates', filePath, symbol, symbols });
+                    }
                 });
                 external.forEach(specifier => {
                     const packageName = getPackageNameFromModuleSpecifier(specifier);
@@ -244,6 +246,15 @@ export const main = async (unresolvedConfiguration) => {
         const unusedFiles = principal.getUnreferencedFiles();
         collector.addFilesIssues(unusedFiles);
         collector.addFileCounts({ processed: analyzedFiles.size, unused: unusedFiles.length });
+        const isSymbolImported = (symbol, importingModule) => {
+            if (!importingModule)
+                return false;
+            if (importingModule.symbols.has(symbol))
+                return true;
+            const { isReExport, isReExportedBy } = importingModule;
+            const hasSymbol = (file) => isSymbolImported(symbol, importedSymbols.get(file));
+            return isReExport ? Array.from(isReExportedBy).some(hasSymbol) : false;
+        };
         const isExportedInEntryFile = (importedModule) => {
             if (!importedModule)
                 return false;
@@ -265,15 +276,14 @@ export const main = async (unresolvedConfiguration) => {
             for (const [filePath, exportItems] of exportedSymbols.entries()) {
                 if (!isIncludeEntryExports && principal.entryPaths.has(filePath))
                     continue;
-                const importedModule = importedSymbols.get(filePath);
+                const importingModule = importedSymbols.get(filePath);
                 for (const [symbol, exportedItem] of exportItems.entries()) {
-                    const jsDocTags = principal.getJSDocTags(exportedItem);
-                    if (jsDocTags.includes('@public') || jsDocTags.includes('@beta'))
+                    if (exportedItem.jsDocTags.includes('@public') || exportedItem.jsDocTags.includes('@beta'))
                         continue;
-                    if (isIgnoreInternal && jsDocTags.includes('@internal'))
+                    if (isIgnoreInternal && exportedItem.jsDocTags.includes('@internal'))
                         continue;
-                    if (importedModule?.symbols.has(symbol)) {
-                        if (importedModule.isReExport && isExportedInEntryFile(importedModule))
+                    if (importingModule && isSymbolImported(symbol, importingModule)) {
+                        if (importingModule.isReExport && isExportedInEntryFile(importingModule))
                             continue;
                         if (report.enumMembers && exportedItem.type === 'enum' && exportedItem.members) {
                             if (isProduction)
@@ -289,8 +299,8 @@ export const main = async (unresolvedConfiguration) => {
                         }
                         continue;
                     }
-                    const isStar = Boolean(importedModule?.isStar);
-                    const isReExportedByEntryFile = !isIncludeEntryExports && isStar && isExportedInEntryFile(importedModule);
+                    const isStar = Boolean(importingModule?.isStar);
+                    const isReExportedByEntryFile = !isIncludeEntryExports && isStar && isExportedInEntryFile(importingModule);
                     if (!isReExportedByEntryFile && !isExportedItemReferenced(exportedItem, filePath)) {
                         if (['enum', 'type', 'interface'].includes(exportedItem.type)) {
                             if (isProduction)
@@ -308,11 +318,12 @@ export const main = async (unresolvedConfiguration) => {
         }
     }
     if (isReportDependencies) {
-        const { dependencyIssues, devDependencyIssues } = deputy.settleDependencyIssues();
+        const { dependencyIssues, devDependencyIssues, optionalPeerDependencyIssues } = deputy.settleDependencyIssues();
         const { configurationHints } = deputy.getConfigurationHints();
         dependencyIssues.forEach(issue => collector.addIssue(issue));
         if (!isProduction)
             devDependencyIssues.forEach(issue => collector.addIssue(issue));
+        optionalPeerDependencyIssues.forEach(issue => collector.addIssue(issue));
         configurationHints.forEach(hint => collector.addConfigurationHint(hint));
     }
     const unusedIgnoredWorkspaces = chief.getUnusedIgnoredWorkspaces();

package/dist/plugins/eslint/helpers.js

@@ -5,7 +5,7 @@ import { _resolve } from '../../util/require.js';
 import { fallback } from './fallback.js';
 const getDependencies = (config) => {
     const extendsSpecifiers = config.extends ? [config.extends].flat().map(resolveExtendSpecifier) : [];
-    if (extendsSpecifiers.includes('eslint-plugin-prettier'))
+    if (extendsSpecifiers.some(specifier => specifier?.startsWith('eslint-plugin-prettier')))
         extendsSpecifiers.push('eslint-config-prettier');
     const plugins = config.plugins ? config.plugins.map(resolvePluginSpecifier) : [];
     const parser = config.parser;

package/dist/plugins/husky/index.js

@@ -1,18 +1,13 @@
 import { readFileSync } from 'fs';
 import { _getDependenciesFromScripts } from '../../binaries/index.js';
+import { getGitHookPaths } from '../../util/git.js';
 import { timerify } from '../../util/Performance.js';
 import { hasDependency } from '../../util/plugin.js';
-import { getGitHooksPath } from './helpers.js';
 export const NAME = 'husky';
 export const ENABLERS = ['husky'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
-const gitHooksPath = getGitHooksPath();
-export const CONFIG_FILE_PATTERNS = [
-    `${gitHooksPath}/prepare-commit-msg`,
-    `${gitHooksPath}/commit-msg`,
-    `${gitHooksPath}/pre-{applypatch,commit,merge-commit,push,rebase,receive}`,
-    `${gitHooksPath}/post-{checkout,commit,merge,rewrite}`,
-];
+const gitHookPaths = getGitHookPaths('.husky');
+export const CONFIG_FILE_PATTERNS = [...gitHookPaths];
 const findHuskyDependencies = async (configFilePath, { cwd, manifest }) => {
     const script = readFileSync(configFilePath);
     return _getDependenciesFromScripts(String(script), {

package/dist/plugins/lefthook/index.js

@@ -1,20 +1,27 @@
+import { readFileSync } from 'fs';
 import { _getDependenciesFromScripts } from '../../binaries/index.js';
+import { fromBinary } from '../../binaries/util.js';
+import { getGitHookPaths } from '../../util/git.js';
 import { getValuesByKeyDeep } from '../../util/object.js';
 import { timerify } from '../../util/Performance.js';
 import { hasDependency, load } from '../../util/plugin.js';
 export const NAME = 'Lefthook';
 export const ENABLERS = ['lefthook', '@arkweid/lefthook'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
-export const CONFIG_FILE_PATTERNS = ['lefthook.yml'];
+const gitHookPaths = getGitHookPaths();
+export const CONFIG_FILE_PATTERNS = ['lefthook.yml', ...gitHookPaths];
 const findLefthookDependencies = async (configFilePath, { cwd, manifest }) => {
-    const config = await load(configFilePath);
-    if (!config)
-        return [];
-    const scripts = getValuesByKeyDeep(config, 'run').filter((value) => typeof value === 'string');
-    return _getDependenciesFromScripts(scripts, {
-        cwd,
-        manifest,
-        knownGlobalsOnly: true,
-    });
+    if (configFilePath.endsWith('.yml')) {
+        const config = await load(configFilePath);
+        if (!config)
+            return [];
+        const scripts = getValuesByKeyDeep(config, 'run').filter((value) => typeof value === 'string');
+        return _getDependenciesFromScripts(scripts, { cwd, manifest, knownGlobalsOnly: true });
+    }
+    const script = readFileSync(configFilePath, 'utf8');
+    const scriptDependencies = _getDependenciesFromScripts([script], { cwd, manifest, knownGlobalsOnly: false });
+    const dependencies = manifest.devDependencies ? Object.keys(manifest.devDependencies) : [];
+    const matches = scriptDependencies.find(dep => dependencies.includes(fromBinary(dep)));
+    return matches ? [matches] : [];
 };
 export const findDependencies = timerify(findLefthookDependencies);

package/dist/reporters/json.js

@@ -22,6 +22,7 @@ export default async ({ report, issues, options }) => {
             ...(report.files && { files: false }),
             ...(report.dependencies && { dependencies: [] }),
             ...(report.devDependencies && { devDependencies: [] }),
+            ...(report.optionalPeerDependencies && { optionalPeerDependencies: [] }),
             ...(report.unlisted && { unlisted: [] }),
             ...(report.unresolved && { unresolved: [] }),
             ...((report.exports || report.nsExports) && { exports: [] }),

package/dist/types/exports.d.ts

@@ -7,6 +7,7 @@ export type ExportItem = {
     pos: number;
     type: SymbolType;
     members?: ExportItemMember[];
+    jsDocTags?: string[];
 };
 export type ExportItemMember = {
     node: ts.Node;
@@ -14,6 +15,6 @@ export type ExportItemMember = {
     pos: number;
     type: SymbolType;
 };
-export type ExportItems = Map<string, ExportItem>;
+export type ExportItems = Map<string, Required<ExportItem>>;
 export type Exports = Map<FilePath, ExportItems>;
 export {};

package/dist/types/issues.d.ts

@@ -22,6 +22,7 @@ export type Issues = {
     files: IssueSet;
     dependencies: IssueRecords;
     devDependencies: IssueRecords;
+    optionalPeerDependencies: IssueRecords;
     unlisted: IssueRecords;
     binaries: IssueRecords;
     unresolved: IssueRecords;

package/dist/types/workspace.d.ts

@@ -4,6 +4,7 @@ type WorkspaceManifest = {
     scripts: string[];
     dependencies: string[];
     peerDependencies: string[];
+    optionalPeerDependencies: string[];
     optionalDependencies: string[];
     devDependencies: string[];
     allDependencies: string[];

package/dist/typescript/ast-helpers.d.ts

@@ -23,4 +23,5 @@ export declare function findAncestor<T>(node: ts.Node | undefined, callback: (el
 export declare function findDescendants<T>(node: ts.Node | undefined, callback: (element: ts.Node) => boolean | 'STOP'): T[];
 export declare const isDeclarationFileExtension: (extension: string) => boolean;
 export declare const isInModuleBlock: (node: ts.Node) => boolean;
+export declare const getJSDocTags: (node: ts.Node) => string[];
 export {};

package/dist/typescript/ast-helpers.js

@@ -98,3 +98,4 @@ export const isInModuleBlock = (node) => {
     }
     return false;
 };
+export const getJSDocTags = (node) => ts.getJSDocTags(node).map(node => node.getText().match(/@\S+/)[0]);

package/dist/typescript/getImportsAndExports.js

@@ -3,7 +3,7 @@ import ts from 'typescript';
 import { getOrSet } from '../util/map.js';
 import { isMaybePackageName } from '../util/modules.js';
 import { isInNodeModules } from '../util/path.js';
-import { isDeclarationFileExtension, isAccessExpression, getAccessExpressionName } from './ast-helpers.js';
+import { isDeclarationFileExtension, isAccessExpression, getAccessExpressionName, getJSDocTags, } from './ast-helpers.js';
 import getExportVisitors from './visitors/exports/index.js';
 import { getJSXImplicitImportBase } from './visitors/helpers.js';
 import getImportVisitors from './visitors/imports/index.js';
@@ -86,20 +86,25 @@ export const getImportsAndExports = (sourceFile, options) => {
             }
         }
     };
-    const addExport = ({ node, identifier, type, pos, members }) => {
+    const addExport = ({ node, identifier, type, pos, members = [] }) => {
         if (options.skipExports)
             return;
+        const jsDocTags = getJSDocTags(node);
         if (exports.has(identifier)) {
             const item = exports.get(identifier);
-            exports.set(identifier, { ...item, node, type, pos, members });
+            const crew = [...item.members, ...members];
+            const tags = [...item.jsDocTags, ...jsDocTags];
+            exports.set(identifier, { ...item, node, type, pos, members: crew, jsDocTags: tags });
         }
         else {
-            exports.set(identifier, { node, type, pos, members });
+            exports.set(identifier, { node, type, pos, members, jsDocTags });
+        }
+        if (!jsDocTags.includes('@alias')) {
+            if (ts.isExportAssignment(node))
+                maybeAddAliasedExport(node.expression, 'default');
+            if (ts.isVariableDeclaration(node))
+                maybeAddAliasedExport(node.initializer, identifier);
         }
-        if (ts.isExportAssignment(node))
-            maybeAddAliasedExport(node.expression, 'default');
-        if (ts.isVariableDeclaration(node))
-            maybeAddAliasedExport(node.initializer, identifier);
     };
     const maybeAddAliasedExport = (node, alias) => {
         const identifier = node?.getText();

package/dist/util/cli-arguments.d.ts

@@ -1,4 +1,4 @@
-export declare const helpText = "\u2702\uFE0F  Find unused files, dependencies and exports in your JavaScript and TypeScript projects\n\nUsage: knip [options]\n\nOptions:\n  -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)\n  -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)\n  --workspace [dir]        Analyze a single workspace (default: analyze all configured workspaces)\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --include-entry-exports  Include entry files when reporting unused exports\n  -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)\n  --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated\n  --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-config-hints        Suppress configuration hints\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  -d, --debug              Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure count and running time of expensive functions and display stats table\n  -h, --help               Print this help text\n  -V, --version            Print version\n\n(1) Issue types: files, dependencies, unlisted, unresolved, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore documentation and bug reports: https://github.com/webpro/knip";
+export declare const helpText = "\u2702\uFE0F  Find unused files, dependencies and exports in your JavaScript and TypeScript projects\n\nUsage: knip [options]\n\nOptions:\n  -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)\n  -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)\n  -W, --workspace [dir]    Analyze a single workspace (default: analyze all configured workspaces)\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --include-entry-exports  Include entry files when reporting unused exports\n  -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)\n  --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated\n  --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-config-hints        Suppress configuration hints\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  -d, --debug              Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure count and running time of expensive functions and display stats table\n  -h, --help               Print this help text\n  -V, --version            Print version\n\n(1) Issue types: files, dependencies, unlisted, unresolved, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore documentation and bug reports: https://github.com/webpro/knip";
 declare const _default: {
     config: string | undefined;
     debug: boolean | undefined;

package/dist/util/cli-arguments.js

@@ -9,7 +9,7 @@ Options:
   --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
   --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)
   --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)
-  --workspace [dir]        Analyze a single workspace (default: analyze all configured workspaces)
+  -W, --workspace [dir]    Analyze a single workspace (default: analyze all configured workspaces)
   --no-gitignore           Don't use .gitignore
   --include                Report only provided issue type(s), can be comma-separated or repeated (1)
   --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)
@@ -68,7 +68,7 @@ try {
             strict: { type: 'boolean' },
             tsConfig: { type: 'string', short: 't' },
             version: { type: 'boolean', short: 'V' },
-            workspace: { type: 'string' },
+            workspace: { type: 'string', short: 'W' },
         },
     });
 }

package/dist/util/get-included-issue-types.js

@@ -1,7 +1,14 @@
 import { ISSUE_TYPES } from '../constants.js';
 export const getIncludedIssueTypes = (cliArgs, { include = [], exclude = [], isProduction = false } = {}) => {
     if (cliArgs.dependencies) {
-        cliArgs.include = [...cliArgs.include, 'dependencies', 'unlisted', 'binaries', 'unresolved'];
+        cliArgs.include = [
+            ...cliArgs.include,
+            'dependencies',
+            'optionalPeerDependencies',
+            'unlisted',
+            'binaries',
+            'unresolved',
+        ];
     }
     if (cliArgs.exports) {
         const exports = ['exports', 'nsExports', 'classMembers', 'types', 'nsTypes', 'enumMembers', 'duplicates'];
@@ -21,9 +28,9 @@ export const getIncludedIssueTypes = (cliArgs, { include = [], exclude = [], isP
     }
     else {
         if (_include.includes('dependencies'))
-            _include.push('devDependencies');
+            _include.push('devDependencies', 'optionalPeerDependencies');
         if (_exclude.includes('dependencies'))
-            _exclude.push('devDependencies');
+            _exclude.push('devDependencies', 'optionalPeerDependencies');
     }
     const included = (_include.length > 0 ? _include : ISSUE_TYPES).filter(group => !_exclude.includes(group));
     return ISSUE_TYPES.reduce((types, group) => ((types[group] = included.includes(group)), types), {});

package/dist/util/git.d.ts

@@ -0,0 +1 @@
+export declare const getGitHookPaths: (defaultPath?: string) => string[];

package/dist/util/git.js

@@ -0,0 +1,20 @@
+import { execSync } from 'child_process';
+import { join } from './path.js';
+const hookFileNames = [
+    `prepare-commit-msg`,
+    `commit-msg`,
+    `pre-{applypatch,commit,merge-commit,push,rebase,receive}`,
+    `post-{checkout,commit,merge,rewrite}`,
+];
+const getGitHooksPath = (defaultPath = '.git/hooks') => {
+    try {
+        return execSync('git config --get core.hooksPath', { encoding: 'utf8' }).trim();
+    }
+    catch (error) {
+        return defaultPath;
+    }
+};
+export const getGitHookPaths = (defaultPath = '.git/hooks') => {
+    const gitHooksPath = getGitHooksPath(defaultPath);
+    return hookFileNames.map(fileName => join(gitHooksPath, fileName));
+};

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.21.1";
+export declare const version = "2.22.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.21.1';
+export const version = '2.22.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.21.1",
+  "version": "2.22.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -25,7 +25,7 @@
     "pretest": "node rmdir.js tmp && swc src -d tmp/src && swc tests -d tmp/tests",
     "test": "node --no-warnings --test tmp",
     "coverage": "c8 --reporter html node --no-warnings --loader tsx --test tests/*.test.ts tests/*/*.test.ts",
-    "watch": "tsc --watch",
+    "watch": "rm $(which knip); npm link && tsc --watch",
     "prebuild": "node rmdir.js dist",
     "build": "tsc",
     "docs": "npm run docs:cli && npm run docs:plugins && npm run docs:format",
@@ -65,16 +65,16 @@
     "@npmcli/package-json": "5.0.0",
     "@release-it/bumper": "5.1.0",
     "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.80",
+    "@swc/core": "1.3.82",
     "@types/eslint": "8.44.2",
     "@types/js-yaml": "4.0.5",
     "@types/micromatch": "4.0.2",
     "@types/minimist": "1.2.2",
-    "@types/node": "20.5.7",
+    "@types/node": "20.5.9",
     "@types/npmcli__map-workspaces": "3.0.1",
     "@types/webpack": "5.28.2",
-    "@typescript-eslint/eslint-plugin": "6.5.0",
-    "@typescript-eslint/parser": "6.5.0",
+    "@typescript-eslint/eslint-plugin": "6.6.0",
+    "@typescript-eslint/parser": "6.6.0",
     "c8": "8.0.1",
     "eslint": "8.48.0",
     "eslint-import-resolver-typescript": "3.6.0",
@@ -84,7 +84,7 @@
     "release-it": "16.1.5",
     "remark-cli": "11.0.0",
     "remark-preset-webpro": "0.0.3",
-    "tsx": "3.12.7",
+    "tsx": "3.12.8",
     "type-fest": "4.3.1"
   },
   "engines": {

package/dist/plugins/husky/helpers.d.ts

@@ -1 +0,0 @@
-export declare const getGitHooksPath: () => string;

package/dist/plugins/husky/helpers.js

@@ -1,9 +0,0 @@
-import { execSync } from 'child_process';
-export const getGitHooksPath = () => {
-    try {
-        return execSync('git config --get core.hooksPath', { encoding: 'utf8' }).trim();
-    }
-    catch (error) {
-        return '.husky';
-    }
-};