knip 1.4.0 → 1.5.0

package/README.md

@@ -234,26 +234,27 @@ Knip contains a growing list of plugins:
 - [ESLint][15]
 - [Gatsby][16]
 - [GitHub Actions][17]
-- [Jest][18]
-- [lint-staged][19]
-- [markdownlint][20]
-- [Mocha][21]
-- [Next.js][22]
-- [npm-package-json-lint][23]
-- [Nx][24]
-- [nyc][25]
-- [Playwright][26]
-- [PostCSS][27]
-- [Prettier][28]
-- [Release It][29]
-- [Remark][30]
-- [Remix][31]
-- [Rollup][32]
-- [Sentry][33]
-- [Storybook][34]
-- [Stryker][35]
-- [TypeScript][36]
-- [Webpack][37]
+- [husky][18]
+- [Jest][19]
+- [lint-staged][20]
+- [markdownlint][21]
+- [Mocha][22]
+- [Next.js][23]
+- [npm-package-json-lint][24]
+- [Nx][25]
+- [nyc][26]
+- [Playwright][27]
+- [PostCSS][28]
+- [Prettier][29]
+- [Release It][30]
+- [Remark][31]
+- [Remix][32]
+- [Rollup][33]
+- [Sentry][34]
+- [Storybook][35]
+- [Stryker][36]
+- [TypeScript][37]
+- [Webpack][38]
 
 Plugins are automatically activated, no need to enable anything. Each plugin is automatically enabled based on simple
 heuristics. Most of them check whether one or one of a few (dev) dependencies are listed in `package.json`. Once
@@ -261,7 +262,7 @@ enabled, they add a set of configuration and/or entry files for Knip to analyze.
 
 Most plugins use one or both of the following file types:
 
-- `config` - custom dependency resolvers are applied to the [config files][38]
+- `config` - custom dependency resolvers are applied to the [config files][39]
 - `entry` - files to include with the analysis of the rest of the source code
 
 See each plugin's documentation for its default values.
@@ -341,10 +342,10 @@ locations. The more plugins Knip will have, the more projects can be analyzed ou
 
 Knip provides the following built-in reporters:
 
-- [`codeowners`][39]
-- [`compact`][40]
-- [`json`][41]
-- [`symbol`][42] (default)
+- [`codeowners`][40]
+- [`compact`][41]
+- [`json`][42]
+- [`symbol`][43] (default)
 
 The `compact` reporter shows the sorted files first, and then a list of symbols:
 
@@ -371,7 +372,7 @@ 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][43].
+Find more details and ideas in [custom reporters][44].
 
 ## Libraries and "unused" exports
 
@@ -428,14 +429,14 @@ 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][44].
+When the dependencies don't have a Knip plugin yet, please file an issue or [create a new plugin][45].
 
 #### Too many unused exports
 
 When the project is a library and the exports are meant to be used by consumers of the library, there are two options:
 
 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][45].
+2.  The exported values or types can be marked [using the JSDoc `@public` tag][46].
 
 ### How to start using Knip in CI while having too many issues to sort out?
 
@@ -452,7 +453,7 @@ 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][46] | [unimported][47] | [ts-unused-exports][48] | [ts-prune][49] |
+| Feature                            | **knip** | [depcheck][47] | [unimported][48] | [ts-unused-exports][49] | [ts-prune][50] |
 | :--------------------------------- | :------: | :------------: | :--------------: | :---------------------: | :------------: |
 | Unused files                       |    ✅    |       -        |        ✅        |            -            |       -        |
 | Unused dependencies                |    ✅    |       ✅       |        ✅        |            -            |       -        |
@@ -466,7 +467,7 @@ This table is an ongoing comparison. Based on their docs (please report any mist
 | Custom reporters                   |    ✅    |       -        |        -         |            -            |       -        |
 | JavaScript support                 |    ✅    |       ✅       |        ✅        |            -            |       -        |
 | Configure entry files              |    ✅    |       ❌       |        ✅        |           ❌            |       ❌       |
-| [Support workspaces/monorepos][50] |    ✅    |       ❌       |        ❌        |            -            |       -        |
+| [Support workspaces/monorepos][51] |    ✅    |       ❌       |        ❌        |            -            |       -        |
 | ESLint plugin available            |    -     |       -        |        -         |           ✅            |       -        |
 
 ✅ = Supported, ❌ = Not supported, - = Out of scope
@@ -487,7 +488,7 @@ The following commands are similar:
     unimported
     knip --production --dependencies --include files
 
-Also see [production mode][51].
+Also see [production mode][52].
 
 ### ts-unused-exports
 
@@ -534,37 +535,38 @@ for the job. I'm motivated to make knip perfectly suited for the job of cutting
 [15]: ./src/plugins/eslint
 [16]: ./src/plugins/gatsby
 [17]: ./src/plugins/github-actions
-[18]: ./src/plugins/jest
-[19]: ./src/plugins/lint-staged
-[20]: ./src/plugins/markdownlint
-[21]: ./src/plugins/mocha
-[22]: ./src/plugins/next
-[23]: ./src/plugins/npm-package-json-lint
-[24]: ./src/plugins/nx
-[25]: ./src/plugins/nyc
-[26]: ./src/plugins/playwright
-[27]: ./src/plugins/postcss
-[28]: ./src/plugins/prettier
-[29]: ./src/plugins/release-it
-[30]: ./src/plugins/remark
-[31]: ./src/plugins/remix
-[32]: ./src/plugins/rollup
-[33]: ./src/plugins/sentry
-[34]: ./src/plugins/storybook
-[35]: ./src/plugins/stryker
-[36]: ./src/plugins/typescript
-[37]: ./src/plugins/webpack
-[38]: #config
-[39]: #code-owners
-[40]: #compact
-[41]: #json
-[42]: #symbol-default
-[43]: ./docs/custom-reporters.md
-[44]: #create-a-new-plugin
-[45]: #libraries-and-unused-exports
-[46]: https://github.com/depcheck/depcheck
-[47]: https://github.com/smeijer/unimported
-[48]: https://github.com/pzavolinsky/ts-unused-exports
-[49]: https://github.com/nadeesha/ts-prune
-[50]: #workspaces--monorepos
-[51]: #production-mode
+[18]: ./src/plugins/husky
+[19]: ./src/plugins/jest
+[20]: ./src/plugins/lint-staged
+[21]: ./src/plugins/markdownlint
+[22]: ./src/plugins/mocha
+[23]: ./src/plugins/next
+[24]: ./src/plugins/npm-package-json-lint
+[25]: ./src/plugins/nx
+[26]: ./src/plugins/nyc
+[27]: ./src/plugins/playwright
+[28]: ./src/plugins/postcss
+[29]: ./src/plugins/prettier
+[30]: ./src/plugins/release-it
+[31]: ./src/plugins/remark
+[32]: ./src/plugins/remix
+[33]: ./src/plugins/rollup
+[34]: ./src/plugins/sentry
+[35]: ./src/plugins/storybook
+[36]: ./src/plugins/stryker
+[37]: ./src/plugins/typescript
+[38]: ./src/plugins/webpack
+[39]: #config
+[40]: #code-owners
+[41]: #compact
+[42]: #json
+[43]: #symbol-default
+[44]: ./docs/custom-reporters.md
+[45]: #create-a-new-plugin
+[46]: #libraries-and-unused-exports
+[47]: https://github.com/depcheck/depcheck
+[48]: https://github.com/smeijer/unimported
+[49]: https://github.com/pzavolinsky/ts-unused-exports
+[50]: https://github.com/nadeesha/ts-prune
+[51]: #workspaces--monorepos
+[52]: #production-mode

package/dist/plugins/github-actions/index.js

@@ -1,4 +1,3 @@
-import { EOL } from 'os';
 import { getBinariesFromScripts } from '../../util/binaries/index.js';
 import { _firstGlob } from '../../util/glob.js';
 import { _load } from '../../util/loader.js';
@@ -14,7 +13,7 @@ const findGithubActionsDependencies = async (configFilePath, { manifest, rootCon
         return [];
     const scripts = getValuesByKeyDeep(config, 'run')
         .filter((value) => typeof value === 'string')
-        .flatMap(script => script.split(EOL))
+        .flatMap(script => script.split('\n'))
         .map(script => script.trim());
     const binaries = getBinariesFromScripts(scripts, {
         manifest,

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

@@ -0,0 +1,6 @@
+import type { IsPluginEnabledCallback, GenericPluginCallback } from '../../types/plugins.js';
+export declare const NAME = "husky";
+export declare const ENABLERS: string[];
+export declare const isEnabled: IsPluginEnabledCallback;
+export declare const CONFIG_FILE_PATTERNS: string[];
+export declare const findDependencies: GenericPluginCallback;

package/dist/plugins/husky/index.js

@@ -0,0 +1,25 @@
+import { readFileSync } from 'fs';
+import { getBinariesFromScripts } from '../../util/binaries/index.js';
+import { timerify } from '../../util/performance.js';
+import { hasDependency } from '../../util/plugin.js';
+export const NAME = 'husky';
+export const ENABLERS = ['husky'];
+export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
+export const CONFIG_FILE_PATTERNS = [
+    '.husky/commit-msg',
+    '.husky/pre-{applypatch,commit,merge-commit,push,rebase,receive}',
+    '.husky/post-{checkout,commit,merge,rewrite}',
+];
+const findHuskyDependencies = async (configFilePath, { manifest, rootConfig }) => {
+    const script = readFileSync(configFilePath);
+    const scripts = String(script)
+        .split('\n')
+        .map(script => script.trim());
+    const binaries = getBinariesFromScripts(scripts, {
+        manifest,
+        ignore: rootConfig.ignoreBinaries,
+        knownGlobalsOnly: true,
+    });
+    return binaries;
+};
+export const findDependencies = timerify(findHuskyDependencies);

package/dist/plugins/index.d.ts

@@ -6,6 +6,7 @@ export * as cypress from './cypress/index.js';
 export * as eslint from './eslint/index.js';
 export * as gatsby from './gatsby/index.js';
 export * as githubActions from './github-actions/index.js';
+export * as husky from './husky/index.js';
 export * as jest from './jest/index.js';
 export * as lintStaged from './lint-staged/index.js';
 export * as markdownlint from './markdownlint/index.js';

package/dist/plugins/index.js

@@ -6,6 +6,7 @@ export * as cypress from './cypress/index.js';
 export * as eslint from './eslint/index.js';
 export * as gatsby from './gatsby/index.js';
 export * as githubActions from './github-actions/index.js';
+export * as husky from './husky/index.js';
 export * as jest from './jest/index.js';
 export * as lintStaged from './lint-staged/index.js';
 export * as markdownlint from './markdownlint/index.js';

package/package.json

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

package/schema.json

@@ -188,6 +188,10 @@
           "title": "github-actions plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/github-actions/README.md)",
           "$ref": "#/definitions/plugin"
         },
+        "husky": {
+          "title": "husky plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/husky/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
         "jest": {
           "title": "Jest plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/jest/README.md)",
           "$ref": "#/definitions/plugin"