knip 2.8.0 → 2.8.2

package/README.md

@@ -136,6 +136,7 @@ Using workspaces in a monorepo? Please see [workspaces][1] for more details abou
       -n, --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)
+      --no-config-hints        Suppress configuration hints
       --no-exit-code           Always exit with code zero (0)
       --max-issues             Maximum number of issues before non-zero exit code (default: 0)
       -d, --debug              Show debug output
@@ -171,17 +172,18 @@ This example shows more output related to unused and unlisted dependencies:
 
 The report contains the following types of issues:
 
-| Title          | Key                                 | Description                                           |
+| Key            | Title                               | Description                                           |
 | :------------- | :---------------------------------- | :---------------------------------------------------- |
 | `files`        | Unused files                        | unable to find references to this file                |
 | `dependencies` | Unused dependencies                 | unable to find references to this dependency          |
 | `dependencies` | Unused devDependencies              | unable to find references to this dependency          |
-| `unlisted`     | Unlisted dependencies               | used dependencies not listed in package.json _(1)_    |
+| `unlisted`     | Unlisted dependencies               | used dependencies not listed in package.json          |
+| `binaries`     | Unlisted binaries                   | binaries from dependencies not in package.json        |
 | `unresolved`   | Unresolved imports                  | unable to resolve this (import) specifier             |
 | `exports`      | Unused exports                      | unable to find references to this export              |
-| `nsExports`    | Unused exports in namespaces        | unable to find direct references to this export _(2)_ |
+| `nsExports`    | Unused exports in namespaces        | unable to find direct references to this export _(1)_ |
 | `types`        | Unused exported types               | unable to find references to this exported type       |
-| `nsTypes`      | Unused exported types in namespaces | unable to find direct references to this export _(2)_ |
+| `nsTypes`      | Unused exported types in namespaces | unable to find direct references to this export _(1)_ |
 | `enumMembers`  | Unused exported enum members        | unable to find references to this enum member         |
 | `classMembers` | Unused exported class members       | unable to find references to this class member        |
 | `duplicates`   | Duplicate exports                   | the same thing is exported more than once             |
@@ -190,10 +192,7 @@ When an issue type has zero issues, it is not shown.
 
 Getting too many reported issues and false positives? Read more about [handling issues][8].
 
-_(1)_ If an unlisted dependency is prefixed with `bin:` it means the dependency containing that binary is unlisted. This
-often equals the package name, but not always (e.g. `tsc` of `typescript` or `webpack` from `webpack-cli`).
-
-_(2)_ The variable or type is not referenced directly and has become a member of a namespace. Knip can't find a
+_(1)_ 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

package/dist/DependencyDeputy.js

@@ -166,7 +166,7 @@ export class DependencyDeputy {
                 .filter(isNotIgnoredBinary)
                 .filter(isNotReferencedDependency)
                 .forEach(symbol => devDependencyIssues.push({ type: 'devDependencies', filePath: manifestPath, symbol }));
-            const isReferencedDep = (name) => ![...pd, ...dd].includes(name) && referencedDependencies?.has(name);
+            const isReferencedDep = (name) => !([...pd, ...dd].includes(name) && referencedDependencies?.has(name));
             const isReferencedBin = (name) => !installedBinaries?.has(name) && referencedBinaries?.has(name);
             ignoreDependencies
                 .filter(packageName => IGNORED_DEPENDENCIES.includes(packageName) || !isReferencedDep(packageName))

package/dist/cli.js

@@ -9,7 +9,7 @@ import { cwd, resolve } from './util/path.js';
 import { Performance } from './util/Performance.js';
 import { version } from './version.js';
 import { main } from './index.js';
-const { debug: isDebug = false, help: isHelp, 'max-issues': maxIssues = '0', 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, performance: isObservePerf = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, version: isVersion, } = parsedArgValues;
+const { debug: isDebug = false, help: isHelp, 'max-issues': maxIssues = '0', 'no-config-hints': noConfigHints = false, 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, performance: isObservePerf = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, version: isVersion, } = parsedArgValues;
 if (isHelp) {
     console.log(helpText);
     process.exit(0);
@@ -31,7 +31,15 @@ const run = async () => {
             isProduction,
             isShowProgress,
         });
-        await printReport({ report, issues, configurationHints, cwd, isProduction, options: reporterOptions });
+        await printReport({
+            report,
+            issues,
+            configurationHints,
+            noConfigHints,
+            cwd,
+            isProduction,
+            options: reporterOptions,
+        });
         const totalErrorCount = Object.keys(report)
             .filter(reportGroup => report[reportGroup] && rules[reportGroup] === 'error')
             .reduce((errorCount, reportGroup) => errorCount + counters[reportGroup], 0);

package/dist/constants.js

@@ -66,7 +66,7 @@ export const ISSUE_TYPE_TITLE = {
     dependencies: 'Unused dependencies',
     devDependencies: 'Unused devDependencies',
     unlisted: 'Unlisted dependencies',
-    binaries: 'Unresolved binaries',
+    binaries: 'Unlisted binaries',
     unresolved: 'Unresolved imports',
     exports: 'Unused exports',
     nsExports: 'Unused exports in namespaces',

package/dist/reporters/index.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    symbols: ({ report, issues, configurationHints }: import("../index.js").ReporterOptions) => void;
+    symbols: ({ report, issues, configurationHints, noConfigHints }: import("../index.js").ReporterOptions) => void;
     compact: ({ report, issues }: import("../index.js").ReporterOptions) => void;
     codeowners: ({ report, issues, options }: import("../index.js").ReporterOptions) => void;
     json: ({ report, issues, options }: import("../index.js").ReporterOptions) => Promise<void>;

package/dist/reporters/symbols.d.ts

@@ -1,3 +1,3 @@
 import type { ReporterOptions } from '../types/issues.js';
-declare const _default: ({ report, issues, configurationHints }: ReporterOptions) => void;
+declare const _default: ({ report, issues, configurationHints, noConfigHints }: ReporterOptions) => void;
 export default _default;

package/dist/reporters/symbols.js

@@ -17,7 +17,7 @@ const logIssueRecord = (issues) => {
     });
     console.log(table.sort(['filePath', 'parentSymbol', 'symbol']).print().trim());
 };
-export default ({ report, issues, configurationHints }) => {
+export default ({ report, issues, configurationHints, noConfigHints }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
     let totalIssues = 0;
     for (const [reportType, isReportType] of Object.entries(report)) {
@@ -39,7 +39,7 @@ export default ({ report, issues, configurationHints }) => {
             totalIssues = totalIssues + issuesForType.length;
         }
     }
-    if (configurationHints.size > 0) {
+    if (!noConfigHints && configurationHints.size > 0) {
         logTitle('Configuration issues', configurationHints.size);
         configurationHints.forEach(hint => {
             const { type, workspaceName, identifier } = hint;

package/dist/types/issues.d.ts

@@ -43,6 +43,7 @@ export type ReporterOptions = {
     report: Report;
     issues: Issues;
     configurationHints: ConfigurationHints;
+    noConfigHints: boolean;
     cwd: string;
     workingDir: string;
     isProduction: boolean;

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  --workspace              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  -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  -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  --workspace              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  -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-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;
@@ -9,6 +9,7 @@ declare const _default: {
     help: boolean | undefined;
     include: string[] | undefined;
     'max-issues': string | undefined;
+    'no-config-hints': boolean | undefined;
     'no-exit-code': boolean | undefined;
     'no-gitignore': boolean | undefined;
     'no-progress': boolean | undefined;

package/dist/util/cli-arguments.js

@@ -17,6 +17,7 @@ Options:
   -n, --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)
+  --no-config-hints        Suppress configuration hints
   --no-exit-code           Always exit with code zero (0)
   --max-issues             Maximum number of issues before non-zero exit code (default: 0)
   -d, --debug              Show debug output
@@ -50,6 +51,7 @@ try {
             help: { type: 'boolean', short: 'h' },
             include: { type: 'string', multiple: true },
             'max-issues': { type: 'string' },
+            'no-config-hints': { type: 'boolean' },
             'no-exit-code': { type: 'boolean' },
             'no-gitignore': { type: 'boolean' },
             'no-progress': { type: 'boolean', short: 'n' },

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.8.0";
+export declare const version = "2.8.2";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.8.0';
+export const version = '2.8.2';

package/package.json

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