knip 1.0.2 → 1.1.0

package/README.md

@@ -97,6 +97,8 @@ Use `npm run knip` to analyze the project and output unused files, dependencies
       --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)
+      --dependencies           Shortcut for --include dependencies,unlisted
+      --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates
       --no-progress            Don't show dynamic progress updates
       --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
       --reporter-options       Pass extra options to the reporter (as JSON string, see example)
@@ -159,6 +161,8 @@ Use `--exclude` to ignore reports you're not interested in:
 
     knip --include files --exclude classMembers,enumMembers
 
+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.
 
@@ -404,7 +408,7 @@ how many dependencies are used and how much the project diverges from the defaul
 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.
 
-### How do I handle too much output/false positives?
+### How do I handle too many output/false positives?
 
 #### Too many unused files
 
@@ -430,6 +434,17 @@ When the project is a library and the exports are meant to be used by consumers
 1.  By default, unused exports of `entry` files are not reported, so you can add the containing file to it.
 2.  The exported values or types can be marked [using the JSDoc `@public` tag][42].
 
+### 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:
+
+- 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 `ignore` (for files and directories) and `ignoreDependencies` to filter out some problematic areas.
+
+All of this is hiding problems, so please make sure to plan for fixing them and/or open issues here for false positives.
+
 ## Comparison
 
 This table is an ongoing comparison. Based on their docs (please report any mistakes):
@@ -460,14 +475,14 @@ This table is an ongoing comparison. Based on their docs (please report any mist
 The following commands are similar:
 
     depcheck
-    knip --include dependencies,unlisted
+    knip --dependencies
 
 ### unimported
 
 The following commands are similar:
 
     unimported
-    knip --production --include files,dependencies,unlisted
+    knip --production --dependencies --include files
 
 Also see [production mode][48].
 
@@ -477,6 +492,7 @@ The following commands are similar:
 
     ts-unused-exports
     knip --include exports,types,nsExports,nsTypes
+    knip --exports  # Adds unused enum and class members
 
 ### ts-prune
 
@@ -484,6 +500,7 @@ The following commands are similar:
 
     ts-prune
     knip --include exports,types
+    knip --exports  # Adds unused exports/types in namespaces and unused enum/class members
 
 ## TypeScript language services
 

package/dist/configuration-chief.js

@@ -11,7 +11,7 @@ import { findFile, loadJSON } from './util/fs.js';
 import { ensurePosixPath } from './util/glob.js';
 import { resolveIncludedIssueTypes } from './util/resolve-included-issue-types.js';
 import { byPathDepth } from './util/workspace.js';
-const { values: { config: rawConfigArg, workspace: rawWorkspaceArg, include = [], exclude = [] }, } = parsedArgs;
+const { values: { config: rawConfigArg, workspace: rawWorkspaceArg, include = [], exclude = [], dependencies = false, exports = false, }, } = parsedArgs;
 const defaultWorkspaceConfig = {
     entry: ['index.{js,ts,tsx}!', 'src/index.{js,ts,tsx}!'],
     project: ['**/*.{js,ts,tsx}!'],
@@ -209,7 +209,12 @@ export default class ConfigurationChief {
         return { entry: [], project: [], ignore: [] };
     }
     resolveIncludedIssueTypes() {
-        return resolveIncludedIssueTypes(include, exclude, {
+        return resolveIncludedIssueTypes({
+            include,
+            exclude,
+            dependencies,
+            exports,
+        }, {
             include: this.config.include ?? [],
             exclude: this.config.exclude ?? [],
             isProduction: this.isProduction,

package/dist/index.js

@@ -29,7 +29,7 @@ export const main = async (unresolvedConfiguration) => {
         .map(workspace => workspace.dir)
         .sort(byPathDepth)
         .reverse();
-    const lab = new SourceLab({ report, workspaceDirs });
+    const lab = new SourceLab({ report, workspaceDirs, isIncludeEntryExports });
     const principal = new ProjectPrincipal();
     for (const { name, dir, config, ancestors } of workspaces) {
         const isRoot = name === ROOT_WORKSPACE_NAME;

package/dist/source-lab.d.ts

@@ -3,15 +3,17 @@ import type { Report, Issue } from './types/issues.js';
 type FileLabOptions = {
     report: Report;
     workspaceDirs: string[];
+    isIncludeEntryExports: boolean;
 };
 export default class SourceLab {
     report: Report;
     workspaceDirs: string[];
+    isIncludeEntryExports: boolean;
     skipExportsAnalysis: Set<unknown>;
     isReportExports: boolean;
     isReportValues: boolean;
     isReportTypes: boolean;
-    constructor({ report, workspaceDirs }: FileLabOptions);
+    constructor({ report, workspaceDirs, isIncludeEntryExports }: FileLabOptions);
     skipExportsAnalysisFor(filePath: string | string[]): void;
     analyzeSourceFile(sourceFile: SourceFile): Set<Issue>;
     private analyzeExports;

package/dist/source-lab.js

@@ -5,13 +5,15 @@ import { getType } from './util/type.js';
 export default class SourceLab {
     report;
     workspaceDirs;
+    isIncludeEntryExports;
     skipExportsAnalysis;
     isReportExports;
     isReportValues;
     isReportTypes;
-    constructor({ report, workspaceDirs }) {
+    constructor({ report, workspaceDirs, isIncludeEntryExports }) {
         this.report = report;
         this.workspaceDirs = workspaceDirs;
+        this.isIncludeEntryExports = isIncludeEntryExports;
         this.skipExportsAnalysis = new Set();
         this.isReportValues = report.exports || report.nsExports || report.classMembers;
         this.isReportTypes = report.types || report.nsTypes || report.enumMembers;
@@ -104,7 +106,13 @@ export default class SourceLab {
                     else {
                         if (hasExternalReferences(refs, filePath))
                             return;
-                        if (_findReferencingNamespaceNodes(sourceFile).length > 0) {
+                        const referencingNodes = _findReferencingNamespaceNodes(sourceFile);
+                        if (referencingNodes.length > 0) {
+                            if (!this.isIncludeEntryExports && referencingNodes.length === 1) {
+                                const referencingSourceFile = referencingNodes.at(0)?.getSourceFile().getFilePath();
+                                if (this.skipExportsAnalysis.has(referencingSourceFile))
+                                    return;
+                            }
                             if (type) {
                                 issues.add({ type: 'nsTypes', filePath, symbol: identifierText, symbolType: type });
                             }

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

@@ -1,10 +1,12 @@
-export declare const helpText = "knip [options]\n\nOptions:\n  -c/--config [file]       Configuration file path (default: knip.json, knip.jsonc 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  --workspace              Analyze a single workspace (default: analyze all configured workspaces)\n  --include-entry-exports  Include unused exports in entry files (without `@public`)\n  --ignore                 Ignore files matching this glob pattern, can be repeated\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  --no-progress            Don't show dynamic progress updates\n  --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\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  --debug                  Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure running time of expensive functions and display stats table\n\n(1) Issue types: files, dependencies, unlisted, 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 info: https://github.com/webpro/knip";
+export declare const helpText = "knip [options]\n\nOptions:\n  -c/--config [file]       Configuration file path (default: knip.json, knip.jsonc 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  --workspace              Analyze a single workspace (default: analyze all configured workspaces)\n  --include-entry-exports  Include unused exports in entry files (without `@public`)\n  --ignore                 Ignore files matching this glob pattern, can be repeated\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\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --no-progress            Don't show dynamic progress updates\n  --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\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  --debug                  Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure running time of expensive functions and display stats table\n\n(1) Issue types: files, dependencies, unlisted, 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 info: https://github.com/webpro/knip";
 declare const _default: {
     values: {
         config: string | undefined;
         debug: boolean | undefined;
         'debug-file-filter': string | undefined;
+        dependencies: boolean | undefined;
         exclude: string[] | undefined;
+        exports: boolean | undefined;
         help: boolean | undefined;
         ignore: string[] | undefined;
         'include-entry-exports': boolean | undefined;

package/dist/util/cli-arguments.js

@@ -12,6 +12,8 @@ Options:
   --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)
+  --dependencies           Shortcut for --include dependencies,unlisted
+  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates
   --no-progress            Don't show dynamic progress updates
   --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
   --reporter-options       Pass extra options to the reporter (as JSON string, see example)
@@ -38,7 +40,9 @@ export default parseArgs({
         config: { type: 'string', short: 'c' },
         debug: { type: 'boolean' },
         'debug-file-filter': { type: 'string' },
+        dependencies: { type: 'boolean' },
         exclude: { type: 'string', multiple: true },
+        exports: { type: 'boolean' },
         help: { type: 'boolean', short: 'h' },
         ignore: { type: 'string', multiple: true },
         'include-entry-exports': { type: 'boolean' },

package/dist/util/resolve-included-issue-types.d.ts

@@ -1,8 +1,16 @@
 import type { Report } from '../types/issues.js';
+type CLIArguments = {
+    include: string[];
+    exclude: string[];
+    dependencies: boolean;
+    exports: boolean;
+};
 type Options = {
     isProduction?: boolean;
     include?: string[];
     exclude?: string[];
+    dependencies?: boolean;
+    exports?: boolean;
 };
-export declare const resolveIncludedIssueTypes: (includeArg: string[], excludeArg: string[], { include, exclude, isProduction }?: Options) => Report;
+export declare const resolveIncludedIssueTypes: (cliArgs: CLIArguments, { include, exclude, isProduction }?: Options) => Report;
 export {};

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

@@ -1,7 +1,14 @@
 import { ISSUE_TYPES } from '../constants.js';
-export const resolveIncludedIssueTypes = (includeArg, excludeArg, { include = [], exclude = [], isProduction = false } = {}) => {
-    const normalizedIncludesArg = includeArg.map(value => value.split(',')).flat();
-    const normalizedExcludesArg = excludeArg.map(value => value.split(',')).flat();
+export const resolveIncludedIssueTypes = (cliArgs, { include = [], exclude = [], isProduction = false } = {}) => {
+    if (cliArgs.dependencies) {
+        cliArgs.include = [...cliArgs.include, 'dependencies', 'unlisted'];
+    }
+    if (cliArgs.exports) {
+        const exports = ['exports', 'nsExports', 'classMembers', 'types', 'nsTypes', 'enumMembers', 'duplicates'];
+        cliArgs.include = [...cliArgs.include, ...exports];
+    }
+    const normalizedIncludesArg = cliArgs.include.map(value => value.split(',')).flat();
+    const normalizedExcludesArg = cliArgs.exclude.map(value => value.split(',')).flat();
     const excludes = exclude.filter(exclude => !normalizedIncludesArg.includes(exclude));
     const includes = include.filter(include => !normalizedExcludesArg.includes(include));
     const _include = [normalizedIncludesArg, includes].flat();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",