knip 2.2.4 → 2.3.0

package/README.md

@@ -54,9 +54,19 @@ Knip has good defaults and you can run it without any configuration. Here's the
 }
 ```
 
-_Actually_, here's the full list of default extensions: `js`, `mjs`, `cjs`, `jsx`, `ts`, `mts`, `cts` and `tsx`.
+To be honest, here's the full list of default extensions: `js`, `mjs`, `cjs`, `jsx`, `ts`, `mts`, `cts` and `tsx`.
 
-If this matches your project, you don't need any configuration. Not even a `knip.json` file.
+### Entry Files
+
+Knip looks for entry files at the default locations above, but also in other places:
+
+- The `main`, `bin` and `exports` fields of `package.json`.
+- [Plugins][2] such as for Next.js, Remix, Gatsby or Svelte define entry files so you don't have to.
+- The `scripts` in package.json may also provide entry files that Knip can use.
+- Knip does this for each [workspace][1] it finds.
+
+In other words, Knip looks in many places and you may not need much configuration. When everything is according to
+defaults you don't even need a `knip.json` file.
 
 Larger projects tend to have more things customized, and therefore probably get more out of Knip with a configuration
 file. Let's say you are using `.ts` files excusively and have all source files only in the `src` directory:
@@ -645,6 +655,12 @@ Many thanks to some of the early adopters of Knip:
 Knip is Dutch for a "cut". A Dutch expression is "to be ge**knip**t for something", which means to be perfectly suited
 for the job. I'm motivated to make knip perfectly suited for the job of cutting projects to perfection! ✂️
 
+## Contributors
+
+Special thanks to the wonderful people who have contributed to this project:
+
+[![Contributors][30]][29]
+
 [1]: #workspaces-monorepos
 [2]: #plugins
 [3]: #compilers
@@ -673,6 +689,8 @@ for the job. I'm motivated to make knip perfectly suited for the job of cutting
 [26]: https://github.com/RebeccaStevens/is-immutable-type
 [27]: https://github.com/release-it/release-it
 [28]: https://github.com/JoshuaKGoldberg/template-typescript-node-package
+[29]: https://github.com/webpro/knip/graphs/contributors
+[30]: https://contrib.rocks/image?repo=webpro/knip
 [plugin-ava]: ./src/plugins/ava
 [plugin-babel]: ./src/plugins/babel
 [plugin-capacitor]: ./src/plugins/capacitor

package/dist/binaries/resolvers/fallback.js

@@ -5,6 +5,7 @@ const withPositional = parsed => [parsed._[0], parsed.require].flat();
 const withoutPositional = parsed => [parsed.require].flat();
 const argFilters = {
     'babel-node': withPositional,
+    esbuild: withPositional,
     nodemon: withPositional,
     'ts-node': withPositional,
     zx: withPositional,

package/dist/index.js

@@ -10,7 +10,7 @@ import { debugLogObject, debugLogArray, debugLog } from './util/debug.js';
 import { LoaderError } from './util/errors.js';
 import { findFile } from './util/fs.js';
 import { _glob } from './util/glob.js';
-import { getPackageNameFromFilePath, getPackageNameFromModuleSpecifier } from './util/modules.js';
+import { getEntryPathFromManifest, getPackageNameFromFilePath, getPackageNameFromModuleSpecifier, } from './util/modules.js';
 import { dirname, isInNodeModules, join, isInternal, isAbsolute } from './util/path.js';
 import { _resolveSpecifier, _tryResolve } from './util/require.js';
 import { _require } from './util/require.js';
@@ -95,6 +95,9 @@ export const main = async (unresolvedConfiguration) => {
         });
         await worker.init();
         const sharedGlobOptions = { cwd, workingDir: dir, gitignore, ignore: worker.getIgnorePatterns() };
+        const entryPathsFromManifest = await getEntryPathFromManifest(dir, manifest);
+        debugLogArray(`Found entry paths from manifest (${name})`, entryPathsFromManifest);
+        principal.addEntryPaths(entryPathsFromManifest);
         if (isProduction) {
             {
                 const patterns = worker.getProductionEntryFilePatterns();

package/dist/plugins/eslint/helpers.js

@@ -48,11 +48,13 @@ export const getDependenciesDeep = async (configFilePath, dependencies = new Set
     return dependencies;
 };
 const resolvePackageName = (namespace, pluginName) => {
-    return pluginName.startsWith('@')
-        ? pluginName.includes('/')
-            ? pluginName.replace(/\//, `/${namespace}-`)
-            : `${pluginName}/${namespace}`
-        : `${namespace}-${pluginName}`;
+    return pluginName.includes(namespace)
+        ? pluginName
+        : pluginName.startsWith('@')
+            ? pluginName.includes('/')
+                ? pluginName.replace(/\//, `/${namespace}-`)
+                : `${pluginName}/${namespace}`
+            : `${namespace}-${pluginName}`;
 };
 export const resolvePluginPackageName = (pluginName) => resolvePackageName('eslint-plugin', pluginName);
 const resolveExtendsSpecifier = (specifier) => {

package/dist/util/glob.d.ts

@@ -7,13 +7,13 @@ interface BaseGlobOptions {
     cwd: string;
     patterns: string[];
     ignore?: string[];
+    gitignore?: boolean;
 }
 interface GlobOptions extends BaseGlobOptions {
     workingDir?: string;
-    gitignore?: boolean;
 }
 export declare const _glob: ({ cwd, workingDir, patterns, ignore, gitignore }: GlobOptions) => Promise<string[]>;
-export declare const _pureGlob: ({ cwd, patterns, ignore }: BaseGlobOptions) => Promise<string[]>;
+export declare const _pureGlob: ({ cwd, patterns, ignore, gitignore }: BaseGlobOptions) => Promise<string[]>;
 export declare const _firstGlob: ({ cwd, patterns }: BaseGlobOptions) => Promise<string | Buffer | undefined>;
 export declare const _dirGlob: ({ cwd, patterns }: BaseGlobOptions) => Promise<string[]>;
 export {};

package/dist/util/glob.js

@@ -29,9 +29,10 @@ const glob = async ({ cwd, workingDir = cwd, patterns, ignore = [], gitignore =
         dot: true,
     });
 };
-const pureGlob = async ({ cwd, patterns, ignore = [] }) => globby(patterns, {
+const pureGlob = async ({ cwd, patterns, ignore = [], gitignore = true }) => globby(patterns, {
     cwd,
     ignore: [...ignore, '**/node_modules/**'],
+    gitignore,
     absolute: true,
 });
 const firstGlob = async ({ cwd, patterns }) => {

package/dist/util/modules.d.ts

@@ -1,6 +1,8 @@
+import type { PackageJson } from '@npmcli/package-json';
 export declare const getPackageNameFromModuleSpecifier: (moduleSpecifier: string) => string;
 export declare const getPackageNameFromFilePath: (value: string) => string;
 export declare const stripBinary: (command: string) => string;
 export declare const isDefinitelyTyped: (packageName: string) => boolean;
 export declare const getDefinitelyTypedFor: (packageName: string) => string;
 export declare const getPackageFromDefinitelyTyped: (typedDependency: string) => string;
+export declare const getEntryPathFromManifest: (dir: string, manifest: PackageJson) => Promise<string[]>;

package/dist/util/modules.js

@@ -1,3 +1,5 @@
+import { _pureGlob } from './glob.js';
+import { getStringValues } from './object.js';
 import { toPosix } from './path.js';
 export const getPackageNameFromModuleSpecifier = (moduleSpecifier) => {
     const parts = moduleSpecifier.split('/').slice(0, 2);
@@ -28,3 +30,24 @@ export const getPackageFromDefinitelyTyped = (typedDependency) => {
     }
     return typedDependency;
 };
+export const getEntryPathFromManifest = (dir, manifest) => {
+    const { main, bin, exports } = manifest;
+    const entryPaths = new Set();
+    if (typeof main === 'string')
+        entryPaths.add(main);
+    if (bin) {
+        if (typeof bin === 'string')
+            entryPaths.add(bin);
+        if (typeof bin === 'object')
+            Object.values(bin).forEach(bin => entryPaths.add(bin));
+    }
+    if (exports) {
+        if (typeof exports === 'string') {
+            entryPaths.add(exports);
+        }
+        else {
+            getStringValues(exports).forEach(item => entryPaths.add(item));
+        }
+    }
+    return _pureGlob({ cwd: dir, patterns: Array.from(entryPaths) });
+};

package/dist/util/object.d.ts

@@ -1 +1,2 @@
 export declare const getValuesByKeyDeep: (obj: any, key: string) => unknown[];
+export declare const getStringValues: (obj: any) => string[];

package/dist/util/object.js

@@ -13,3 +13,17 @@ export const getValuesByKeyDeep = (obj, key) => {
     }
     return objects;
 };
+export const getStringValues = (obj) => {
+    let values = [];
+    for (const prop in obj) {
+        if (obj[prop]) {
+            if (typeof obj[prop] === 'string') {
+                values.push(obj[prop]);
+            }
+            else if (typeof obj[prop] === 'object') {
+                values = values.concat(getStringValues(obj[prop]));
+            }
+        }
+    }
+    return values;
+};

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.2.4";
+export declare const version = "2.3.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.2.4';
+export const version = '2.3.0';

package/package.json

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