knip 1.15.0 → 1.17.0

package/README.md

@@ -271,39 +271,43 @@ Here's some example output when running Knip in a workspace:
 
 Knip contains a growing list of plugins:
 
-- [Babel][13]
-- [Capacitor][14]
-- [Changesets][15]
-- [commitlint][16]
-- [cspell][17]
-- [Cypress][18]
-- [ESLint][19]
-- [Gatsby][20]
-- [GitHub Actions][21]
-- [husky][22]
-- [Jest][23]
-- [Lefthook][24]
-- [lint-staged][25]
-- [markdownlint][26]
-- [Mocha][27]
-- [Next.js][28]
-- [npm-package-json-lint][29]
-- [Nx][30]
-- [nyc][31]
-- [Playwright][32]
-- [PostCSS][33]
-- [Prettier][34]
-- [Release It][35]
-- [Remark][36]
-- [Remix][37]
-- [Rollup][38]
-- [Sentry][39]
-- [Storybook][40]
-- [Stryker][41]
-- [TypeDoc][42]
-- [TypeScript][43]
-- [Vitest][44]
-- [Webpack][45]
+- [Ava][plugin-ava]
+- [Babel][plugin-babel]
+- [Capacitor][plugin-capacitor]
+- [Changesets][plugin-changesets]
+- [Commitizen][plugin-commitizen]
+- [commitlint][plugin-commitlint]
+- [cspell][plugin-cspell]
+- [Cypress][plugin-cypress]
+- [ESLint][plugin-eslint]
+- [Gatsby][plugin-gatsby]
+- [GitHub Actions][plugin-github-actions]
+- [husky][plugin-husky]
+- [Jest][plugin-jest]
+- [Lefthook][plugin-lefthook]
+- [lint-staged][plugin-lint-staged]
+- [markdownlint][plugin-markdownlint]
+- [Mocha][plugin-mocha]
+- [Next.js][plugin-next]
+- [npm-package-json-lint][plugin-npm-package-json-lint]
+- [Nx][plugin-nx]
+- [nyc][plugin-nyc]
+- [Playwright][plugin-playwright]
+- [PostCSS][plugin-postcss]
+- [Prettier][plugin-prettier]
+- [Release It][plugin-release-it]
+- [Remark][plugin-remark]
+- [Remix][plugin-remix]
+- [Rollup][plugin-rollup]
+- [Semantic Release][plugin-semantic-release]
+- [Sentry][plugin-sentry]
+- [Storybook][plugin-storybook]
+- [Stryker][plugin-stryker]
+- [Tailwind][plugin-tailwind]
+- [TypeDoc][plugin-typedoc]
+- [TypeScript][plugin-typescript]
+- [Vitest][plugin-vitest]
+- [Webpack][plugin-webpack]
 
 Plugins are automatically activated. 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 enabled, they add a set of
@@ -311,7 +315,7 @@ configuration and/or entry files for Knip to analyze. These defaults can be over
 
 Most plugins use one or both of the following file types:
 
-- `config` - custom dependency resolvers are applied to the [config files][46]
+- `config` - custom dependency resolvers are applied to the [config files][13]
 - `entry` - files to include with the analysis of the rest of the source code
 
 See each plugin's documentation for its default values.
@@ -337,7 +341,7 @@ Other configuration files use `require` or `import` statements to use dependenci
 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
-(see [TEST_FILE_PATTERNS in constants.ts][47]):
+(see [TEST_FILE_PATTERNS in constants.ts][14]):
 
 - `**/*.{test,spec}.{js,jsx,ts,tsx,mjs,cjs}`
 - `**/__tests__/**/*.{js,jsx,ts,tsx,mjs,cjs}`
@@ -419,10 +423,10 @@ Each workspace can also have its own `paths` configured. Note that Knip `paths`
 
 Knip provides the following built-in reporters:
 
-- [`codeowners`][48]
-- [`compact`][49]
-- [`json`][50]
-- [`symbol`][51] (default)
+- `codeowners`
+- `compact`
+- `json`
+- `symbol` (default)
 
 The `compact` reporter shows the sorted files first, and then a list of symbols:
 
@@ -449,7 +453,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][52].
+Find more details and ideas in [custom reporters][15].
 
 ## Libraries and "unused" exports
 
@@ -503,11 +507,11 @@ instance by ignoring specific folders that are not related to the source code im
 Dependencies that are only imported in unused files are also marked as unused. So a long list of unused files would be
 good to remedy first.
 
-When unused dependencies are related to dependencies having a Knip [plugin][1], maybe the `config` and/or `entry` files
+When unused dependencies are related to dependencies having a Knip [plugin][2], maybe the `config` and/or `entry` files
 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][53].
+When the dependencies don't have a Knip plugin yet, please file an issue or [create a new plugin][16].
 
 #### Too many unused exports
 
@@ -515,7 +519,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][54].
+2.  The exported values or types can be marked [using the JSDoc `@public` tag][17].
 
 ### How to start using Knip in CI while having too many issues to sort out?
 
@@ -535,22 +539,22 @@ 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][55] | [unimported][56] | [ts-unused-exports][57] | [ts-prune][58] |
-| :--------------------------------- | :------: | :------------: | :--------------: | :---------------------: | :------------: |
-| 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][18] | [unimported][19] | [ts-unused-exports][20] | [ts-prune][21] |
+| :-------------------------------- | :------: | :------------: | :--------------: | :---------------------: | :------------: |
+| Unused files                      |    ✅    |       -        |        ✅        |            -            |       -        |
+| Unused dependencies               |    ✅    |       ✅       |        ✅        |            -            |       -        |
+| Unlisted dependencies             |    ✅    |       ✅       |        ✅        |            -            |       -        |
+| [Plugins][2]                      |    ✅    |       ✅       |        ❌        |            -            |       -        |
+| 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
 
@@ -570,7 +574,7 @@ The following commands are similar:
     unimported
     knip --production --dependencies --include files
 
-Also see [production mode][59].
+Also see [production mode][22].
 
 ### ts-unused-exports
 
@@ -600,6 +604,12 @@ userland territory, much like code linters.
 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][24]][23]
+
 [1]: #workspaces--monorepos
 [2]: #plugins
 [3]: #reporters
@@ -612,50 +622,52 @@ for the job. I'm motivated to make knip perfectly suited for the job of cutting
 [10]: https://github.com/webpro/knip/issues
 [11]: #faq
 [12]: #ignore
-[13]: ./src/plugins/babel
-[14]: ./src/plugins/capacitor
-[15]: ./src/plugins/changesets
-[16]: ./src/plugins/commitlint
-[17]: ./src/plugins/cspell
-[18]: ./src/plugins/cypress
-[19]: ./src/plugins/eslint
-[20]: ./src/plugins/gatsby
-[21]: ./src/plugins/github-actions
-[22]: ./src/plugins/husky
-[23]: ./src/plugins/jest
-[24]: ./src/plugins/lefthook
-[25]: ./src/plugins/lint-staged
-[26]: ./src/plugins/markdownlint
-[27]: ./src/plugins/mocha
-[28]: ./src/plugins/next
-[29]: ./src/plugins/npm-package-json-lint
-[30]: ./src/plugins/nx
-[31]: ./src/plugins/nyc
-[32]: ./src/plugins/playwright
-[33]: ./src/plugins/postcss
-[34]: ./src/plugins/prettier
-[35]: ./src/plugins/release-it
-[36]: ./src/plugins/remark
-[37]: ./src/plugins/remix
-[38]: ./src/plugins/rollup
-[39]: ./src/plugins/sentry
-[40]: ./src/plugins/storybook
-[41]: ./src/plugins/stryker
-[42]: ./src/plugins/typedoc
-[43]: ./src/plugins/typescript
-[44]: ./src/plugins/vitest
-[45]: ./src/plugins/webpack
-[46]: #config
-[47]: https://github.com/webpro/knip/blob/main/src/constants.ts
-[48]: #code-owners
-[49]: #compact
-[50]: #json
-[51]: #symbol-default
-[52]: ./docs/custom-reporters.md
-[53]: #create-a-new-plugin
-[54]: #libraries-and-unused-exports
-[55]: https://github.com/depcheck/depcheck
-[56]: https://github.com/smeijer/unimported
-[57]: https://github.com/pzavolinsky/ts-unused-exports
-[58]: https://github.com/nadeesha/ts-prune
-[59]: #production-mode
+[13]: #config
+[14]: https://github.com/webpro/knip/blob/main/src/constants.ts
+[15]: ./docs/custom-reporters.md
+[16]: #create-a-new-plugin
+[17]: #libraries-and-unused-exports
+[18]: https://github.com/depcheck/depcheck
+[19]: https://github.com/smeijer/unimported
+[20]: https://github.com/pzavolinsky/ts-unused-exports
+[21]: https://github.com/nadeesha/ts-prune
+[22]: #production-mode
+[23]: https://github.com/webpro/knip/graphs/contributors
+[24]: https://contrib.rocks/image?repo=webpro/knip
+[plugin-ava]: ./src/plugins/ava
+[plugin-babel]: ./src/plugins/babel
+[plugin-capacitor]: ./src/plugins/capacitor
+[plugin-changesets]: ./src/plugins/changesets
+[plugin-commitizen]: ./src/plugins/commitizen
+[plugin-commitlint]: ./src/plugins/commitlint
+[plugin-cspell]: ./src/plugins/cspell
+[plugin-cypress]: ./src/plugins/cypress
+[plugin-eslint]: ./src/plugins/eslint
+[plugin-gatsby]: ./src/plugins/gatsby
+[plugin-github-actions]: ./src/plugins/github-actions
+[plugin-husky]: ./src/plugins/husky
+[plugin-jest]: ./src/plugins/jest
+[plugin-lefthook]: ./src/plugins/lefthook
+[plugin-lint-staged]: ./src/plugins/lint-staged
+[plugin-markdownlint]: ./src/plugins/markdownlint
+[plugin-mocha]: ./src/plugins/mocha
+[plugin-next]: ./src/plugins/next
+[plugin-npm-package-json-lint]: ./src/plugins/npm-package-json-lint
+[plugin-nx]: ./src/plugins/nx
+[plugin-nyc]: ./src/plugins/nyc
+[plugin-playwright]: ./src/plugins/playwright
+[plugin-postcss]: ./src/plugins/postcss
+[plugin-prettier]: ./src/plugins/prettier
+[plugin-release-it]: ./src/plugins/release-it
+[plugin-remark]: ./src/plugins/remark
+[plugin-remix]: ./src/plugins/remix
+[plugin-rollup]: ./src/plugins/rollup
+[plugin-semantic-release]: ./src/plugins/semantic-release
+[plugin-sentry]: ./src/plugins/sentry
+[plugin-storybook]: ./src/plugins/storybook
+[plugin-stryker]: ./src/plugins/stryker
+[plugin-tailwind]: ./src/plugins/tailwind
+[plugin-typedoc]: ./src/plugins/typedoc
+[plugin-typescript]: ./src/plugins/typescript
+[plugin-vitest]: ./src/plugins/vitest
+[plugin-webpack]: ./src/plugins/webpack