knip 2.0.0-alpha.1 → 2.0.0-alpha.2

package/README.md

@@ -196,8 +196,8 @@ 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. Also see the next section on how to [ignore][11] certain false positives:
+Still not happy with the results? Getting too much output/false positives? The [FAQ][10] may be useful. Feel free to
+open an issue and I'm happy to look into it. Also see the next section on how to [ignore][11] certain false positives:
 
 ## Ignore
 
@@ -345,6 +345,14 @@ rest to find which of those dependencies are unused or missing.
 Other configuration files use `require` or `import` statements to use dependencies, so they can be analyzed like the
 rest of the source files. These configuration files are also considered `entry` files.
 
+For plugins related to test files, it's good to know that the following glob patterns are always included by default:
+
+- `**/*.{test,spec}.{js,jsx,ts,tsx,mjs,cjs}`
+- `**/__tests__/**/*.{js,jsx,ts,tsx,mjs,cjs}`
+- `**/test/**/*.{js,jsx,ts,tsx,mjs,cjs}`
+
+Files matching these patterns are excluded in [production mode][45].
+
 ### Disable a plugin
 
 In case a plugin causes issues, it can be disabled by using `false` as its value (e.g. `"webpack": false`).
@@ -440,10 +448,10 @@ Each workspace can also have its own `paths` configured. Note that Knip `paths`
 
 Knip provides the following built-in reporters:
 
-- [`codeowners`][45]
-- [`compact`][46]
-- [`json`][47]
-- [`symbol`][48] (default)
+- codeowners
+- compact
+- json
+- symbol
 
 The `compact` reporter shows the sorted files first, and then a list of symbols:
 
@@ -470,13 +478,12 @@ type ReporterOptions = {
 
 The data can then be used to write issues to `stdout`, a JSON or CSV file, or sent to a service.
 
-Find more details and ideas in [custom reporters][49].
+Find more details and ideas in [custom reporters][46].
 
-## Libraries and "unused" exports
+## Public exports
 
-Libraries and applications are identical when it comes to files and dependencies: whatever is unused should be removed.
-Yet libraries usually have exports meant to be used by other libraries or applications. Such public variables and types
-in libraries can be marked with the JSDoc `@public` tag:
+Sometimes a file that's not an entry file has one or more exports that are public, and should not be reported as unused.
+Such variables and types can be marked with the JSDoc `@public` tag:
 
 ```js
 /**
@@ -528,7 +535,7 @@ When unused dependencies are related to dependencies having a Knip [plugin][1],
 for that dependency are at custom locations. The default values are at the plugin's documentation, and can be overridden
 to match the custom location(s).
 
-When the dependencies don't have a Knip plugin yet, please file an issue or [create a new plugin][50].
+When the dependencies don't have a Knip plugin yet, please file an issue or [create a new plugin][47].
 
 #### Too many unused exports
 
@@ -536,7 +543,7 @@ 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. 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][51].
+2.  The exported values or types can be marked [using the JSDoc `@public` tag][48]
 
 ### How to start using Knip in CI while having too many issues to sort out?
 
@@ -556,22 +563,23 @@ All of this is hiding problems, so please make sure to plan for fixing them and/
 
 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] |
-| :--------------------------------- | :------: | :------------: | :--------------: | :---------------------: | :------------: |
-| Unused files                       |    ✅    |       -        |        ✅        |            -            |       -        |
-| Unused dependencies                |    ✅    |       ✅       |        ✅        |            -            |       -        |
-| Unlisted dependencies              |    ✅    |       ✅       |        ✅        |            -            |       -        |
-| [Plugins][1]                       |    ✅    |       ✅       |        ❌        |            -            |       -        |
-| Unused exports                     |    ✅    |       -        |        -         |           ✅            |       ✅       |
-| Unused class members               |    ✅    |       -        |        -         |            -            |       -        |
-| Unused enum members                |    ✅    |       -        |        -         |            -            |       -        |
-| Duplicate exports                  |    ✅    |       -        |        -         |           ❌            |       ❌       |
-| Search namespaces                  |    ✅    |       -        |        -         |           ✅            |       ❌       |
-| Custom reporters                   |    ✅    |       -        |        -         |            -            |       -        |
-| JavaScript support                 |    ✅    |       ✅       |        ✅        |            -            |       -        |
-| Configure entry files              |    ✅    |       ❌       |        ✅        |           ❌            |       ❌       |
-| [Support workspaces/monorepos][52] |    ✅    |       ❌       |        ❌        |            -            |       -        |
-| ESLint plugin available            |    -     |       -        |        -         |           ✅            |       -        |
+| Feature                           | **knip** | [depcheck][49] | [unimported][50] | [ts-unused-exports][51] | [ts-prune][52] |
+| :-------------------------------- | :------: | :------------: | :--------------: | :---------------------: | :------------: |
+| Unused files                      |    ✅    |       -        |        ✅        |            -            |       -        |
+| Unused dependencies               |    ✅    |       ✅       |        ✅        |            -            |       -        |
+| Unlisted dependencies             |    ✅    |       ✅       |        ✅        |            -            |       -        |
+| [Plugins][2]                      |    ✅    |       ✅       |        ❌        |            -            |       -        |
+| [Compilers][3]                    |    ✅    |       -        |        -         |            -            |       -        |
+| Unused exports                    |    ✅    |       -        |        -         |           ✅            |       ✅       |
+| Unused class members              |    ✅    |       -        |        -         |            -            |       -        |
+| Unused enum members               |    ✅    |       -        |        -         |            -            |       -        |
+| Duplicate exports                 |    ✅    |       -        |        -         |           ❌            |       ❌       |
+| Search namespaces                 |    ✅    |       -        |        -         |           ✅            |       ❌       |
+| Custom reporters                  |    ✅    |       -        |        -         |            -            |       -        |
+| JavaScript support                |    ✅    |       ✅       |        ✅        |            -            |       -        |
+| Configure entry files             |    ✅    |       ❌       |        ✅        |           ❌            |       ❌       |
+| [Support workspaces/monorepos][1] |    ✅    |       ❌       |        ❌        |            -            |       -        |
+| ESLint plugin available           |    -     |       -        |        -         |           ✅            |       -        |
 
 ✅ = Supported, ❌ = Not supported, - = Out of scope
 
@@ -591,7 +599,7 @@ The following commands are similar:
     unimported
     knip --production --dependencies --include files
 
-Also see [production mode][56].
+Also see [production mode][45].
 
 ### ts-unused-exports
 
@@ -609,13 +617,6 @@ The following commands are similar:
     knip --include exports,types
     knip --exports  # Adds unused exports/types in namespaces and unused enum/class members
 
-## TypeScript language services
-
-TypeScript language services could play a major role in most of the "unused" areas, as they have an overview of the
-project as a whole. This powers things in VS Code like "Find references" or the "Module "./some" declares 'Thing'
-locally, but it is not exported" message. I think features like "duplicate exports" or "custom dependency resolvers" are
-userland territory, much like code linters.
-
 ## Knip?!
 
 Knip is Dutch for a "cut". A Dutch expression is "to be ge**knip**t for something", which means to be perfectly suited
@@ -665,15 +666,11 @@ for the job. I'm motivated to make knip perfectly suited for the job of cutting
 [42]: ./src/plugins/vitest
 [43]: ./src/plugins/webpack
 [44]: #config
-[45]: #code-owners
-[46]: #compact
-[47]: #json
-[48]: #symbol-default
-[49]: ./docs/custom-reporters.md
-[50]: #create-a-new-plugin
-[51]: #libraries-and-unused-exports
-[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]: #production-mode
+[45]: #production-mode
+[46]: ./docs/custom-reporters.md
+[47]: #create-a-new-plugin
+[48]: #public-exports
+[49]: https://github.com/depcheck/depcheck
+[50]: https://github.com/smeijer/unimported
+[51]: https://github.com/pzavolinsky/ts-unused-exports
+[52]: https://github.com/nadeesha/ts-prune

package/dist/configuration-chief.js

@@ -17,10 +17,10 @@ import { resolveIncludedIssueTypes } from './util/resolve-included-issue-types.j
 import { byPathDepth } from './util/workspace.js';
 const { config: rawConfigArg, workspace: rawWorkspaceArg, include = [], exclude = [], dependencies = false, exports = false, } = parsedArgs.values;
 const getDefaultWorkspaceConfig = (extensions) => {
-    const extsGlobStr = [...DEFAULT_EXTENSIONS, ...(extensions ?? [])].map(ext => ext.slice(1)).join(',');
+    const exts = [...DEFAULT_EXTENSIONS, ...(extensions ?? [])].map(ext => ext.slice(1)).join(',');
     return {
-        entry: [`index.{${extsGlobStr}}!`, `src/index.{${extsGlobStr}}!`],
-        project: [`**/*.{${extsGlobStr}}!`],
+        entry: [`index.{${exts}}!`, `src/index.{${exts}}!`],
+        project: [`**/*.{${exts}}!`],
         paths: {},
         ignore: [],
         ignoreBinaries: [],

package/dist/constants.js

@@ -1,7 +1,11 @@
 export const ROOT_WORKSPACE_NAME = '.';
 export const KNIP_CONFIG_LOCATIONS = ['knip.json', 'knip.jsonc', '.knip.json', '.knip.jsonc', 'knip.ts', 'knip.js'];
 export const DEFAULT_EXTENSIONS = ['.js', '.mjs', '.cjs', '.jsx', '.ts', '.tsx'];
-export const TEST_FILE_PATTERNS = ['**/*.{test,spec}.{js,jsx,ts,tsx}', '**/__tests__/**/*.{js,jsx,ts,tsx}'];
+export const TEST_FILE_PATTERNS = [
+    '**/*.{test,spec}.{js,jsx,ts,tsx,mjs,cjs}',
+    '**/__tests__/**/*.{js,jsx,ts,tsx,mjs,cjs}',
+    '**/test/**/*.{js,jsx,ts,tsx,mjs,cjs}',
+];
 export const IGNORED_GLOBAL_BINARIES = [
     'bun',
     'deno',

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

@@ -3,5 +3,5 @@ export declare const NAME = "Jest";
 export declare const ENABLERS: string[];
 export declare const isEnabled: IsPluginEnabledCallback;
 export declare const CONFIG_FILE_PATTERNS: string[];
-export declare const ENTRY_FILE_PATTERNS: string[];
+export declare const ENTRY_FILE_PATTERNS: never[];
 export declare const findDependencies: GenericPluginCallback;

package/dist/plugins/jest/index.js

@@ -9,7 +9,7 @@ export const NAME = 'Jest';
 export const ENABLERS = ['jest'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
 export const CONFIG_FILE_PATTERNS = ['jest.config.{js,ts,mjs,cjs,json}'];
-export const ENTRY_FILE_PATTERNS = ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'];
+export const ENTRY_FILE_PATTERNS = [];
 const join = (base, id) => (isAbsolute(id) ? id : path.join(path.dirname(base), id));
 const resolveExtensibleConfig = async (configFilePath) => {
     const config = await _load(configFilePath);

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

@@ -3,5 +3,5 @@ export declare const NAME = "Mocha";
 export declare const ENABLERS: string[];
 export declare const isEnabled: IsPluginEnabledCallback;
 export declare const CONFIG_FILE_PATTERNS: string[];
-export declare const ENTRY_FILE_PATTERNS: string[];
+export declare const ENTRY_FILE_PATTERNS: never[];
 export declare const findDependencies: GenericPluginCallback;

package/dist/plugins/mocha/index.js

@@ -6,7 +6,7 @@ export const NAME = 'Mocha';
 export const ENABLERS = ['mocha'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
 export const CONFIG_FILE_PATTERNS = ['.mocharc.{js,cjs,json,jsonc,yml,yaml}', 'package.json'];
-export const ENTRY_FILE_PATTERNS = ['test/**/*.{js,cjs,mjs}'];
+export const ENTRY_FILE_PATTERNS = [];
 const findMochaDependencies = async (configFilePath, { manifest }) => {
     const config = configFilePath.endsWith('package.json') ? manifest.mocha : await _load(configFilePath);
     if (config) {

package/dist/plugins/playwright/index.js

@@ -2,4 +2,4 @@ import { hasDependency } from '../../util/plugin.js';
 export const NAME = 'Playwright';
 export const ENABLERS = ['@playwright/test'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
-export const ENTRY_FILE_PATTERNS = ['playwright.config.{js,ts}', '.*{test,spec}.{js,ts,mjs}'];
+export const ENTRY_FILE_PATTERNS = ['playwright.config.{js,ts}'];

package/dist/plugins/typedoc/index.js

@@ -12,6 +12,6 @@ export const CONFIG_FILE_PATTERNS = [
 ];
 const findPluginDependencies = async (configFilePath) => {
     const config = await _load(configFilePath);
-    return config?.plugins ?? [];
+    return config?.plugin ?? [];
 };
 export const findDependencies = timerify(findPluginDependencies);

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

@@ -1,3 +1,3 @@
 export type PluginConfig = {
-    plugins?: string[];
+    plugin?: string[];
 };

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

@@ -3,5 +3,5 @@ export declare const NAME = "Vitest";
 export declare const ENABLERS: string[];
 export declare const isEnabled: IsPluginEnabledCallback;
 export declare const CONFIG_FILE_PATTERNS: string[];
-export declare const ENTRY_FILE_PATTERNS: string[];
+export declare const ENTRY_FILE_PATTERNS: never[];
 export declare const findDependencies: GenericPluginCallback;

package/dist/plugins/vitest/index.js

@@ -7,7 +7,7 @@ export const NAME = 'Vitest';
 export const ENABLERS = ['vitest'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
 export const CONFIG_FILE_PATTERNS = ['vitest.config.ts', 'vite.config.ts'];
-export const ENTRY_FILE_PATTERNS = ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'];
+export const ENTRY_FILE_PATTERNS = [];
 const findVitestDependencies = async (configFilePath) => {
     const config = await _load(configFilePath);
     if (!config || !config.test)

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.0.0-alpha.1";
+export declare const version = "2.0.0-alpha.2";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.0.0-alpha.1';
+export const version = '2.0.0-alpha.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0-alpha.2",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -22,7 +22,7 @@
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "format": "prettier scripts src test --with-node-modules --write --config .prettierrc",
-    "test": "globstar -- node --loader tsx --test \"test/**/*.test.ts\"",
+    "test": "globstar -- node --loader tsx --test \"tests/**/*.test.ts\"",
     "watch": "tsc --watch",
     "prebuild": "rm -rf dist",
     "build": "tsc",
@@ -30,6 +30,7 @@
     "docs:cli": "tsx ./scripts/update-cli-usage-in-readme.ts",
     "docs:plugins": "tsx ./scripts/generate-plugin-docs.ts",
     "docs:format": "remark README.md docs/*.md src/plugins/*/README.md -o",
+    "qa": "npm run lint && npm run build && npm run knip && npm run knip:production && npm test",
     "release": "release-it",
     "create-plugin": "tsx ./scripts/create-new-plugin.ts"
   },
@@ -57,24 +58,24 @@
     "zod": "^3.20.6"
   },
   "devDependencies": {
-    "@jest/types": "29.4.3",
+    "@jest/types": "29.5.0",
     "@npmcli/package-json": "3.0.0",
     "@release-it/bumper": "4.0.2",
     "@types/eslint": "8.21.1",
     "@types/js-yaml": "4.0.5",
     "@types/micromatch": "4.0.2",
     "@types/minimist": "1.2.2",
-    "@types/node": "18.14.2",
+    "@types/node": "18.14.6",
     "@types/npmcli__map-workspaces": "3.0.0",
     "@types/webpack": "5.28.0",
-    "@typescript-eslint/eslint-plugin": "5.54.0",
-    "@typescript-eslint/parser": "5.54.0",
+    "@typescript-eslint/eslint-plugin": "5.54.1",
+    "@typescript-eslint/parser": "5.54.1",
     "eslint": "8.35.0",
     "eslint-import-resolver-typescript": "3.5.3",
     "eslint-plugin-import": "2.27.5",
     "globstar": "1.0.0",
     "prettier": "2.8.4",
-    "release-it": "^15.6.1",
+    "release-it": "^15.7.0",
     "remark-cli": "11.0.0",
     "remark-preset-webpro": "0.0.1",
     "tsx": "3.12.3",