webpro-nl / knip

✂️ Find unused files, dependencies and exports in your JavaScript and TypeScript projects. Knip it before you ship it!
https://knip.dev
ISC License
6.52k stars 150 forks source link

Request new plugins here #483

Open webpro opened 7 months ago

webpro commented 7 months ago

Please add one comment per plugin (please link to website/repo/docs), which others can then upvote using reactions like 👍 (not more comments).

The idea is that you can request/upvote plugins here. Contributors/me can implement them.

Please make sure the plugin isn't already available/listed on https://knip.dev/reference/plugins

webpro commented 7 months ago

Ladle (https://github.com/webpro/knip/issues/268)

webpro commented 7 months ago

Vike (https://github.com/webpro/knip/issues/275)

birtles commented 7 months ago

React cosmos

Includes:

/cc @ovidiuch

Faithfinder commented 7 months ago

NestJS, maybe?

It's very class based, so it would be focused on classMembers rules.

It would need to detect usage of class members by decorators, basically - e.g, something decorated with @ResolveField is used.

webpro commented 7 months ago

WebdriverIO (#464)

justingrant commented 7 months ago

Not sure if this is a plugin or core, but support for .mdx files. (used by Storybook and other docs generators)

webpro commented 7 months ago

@justingrant Please file a separate issue for this (as it's not a plugin).

netner-d commented 7 months ago

Serverless framework (1 183 585 downloads a week). It uses serverless.yml files for config and includes :

webpro commented 7 months ago

Please don't dump words here. It'll be a lot more convincing if you'd be more precise and provide one or two links to the library and/or configuration pages to avoid any ambiguity.

netner-d commented 7 months ago

Please don't dump words here. It'll be a lot more convincing if you'd be more precise and provide one or two links to the library and/or configuration pages to avoid any ambiguity.

Yeah, absolutely sorry about that, I thought it was the method to collect people opinion as I saw similar comments above... I'm rectifying

webpro commented 5 months ago

tsd (#535)

DaniFoldi commented 5 months ago

wrangler ideas: find wrangler.toml/json and set main as entrypoint, and exclude from unused dependencies

webpro commented 5 months ago

Just saying, for anyone interested, it's now more fun and easier than ever to write a plugin: https://knip.dev/guides/writing-a-plugin

guy-borderless commented 5 months ago

is deno compat a plugin? If so, what would it take? Deno uses the web standard import_map.json

sifferhans commented 5 months ago

Would it be possible to create a Nuxt plugin? Nuxt heavily uses auto-imports, so I imagine it could be harder to trace down what is being used.

auvred commented 4 months ago

Docusaurus - https://docusaurus.io/

webpro commented 4 months ago

Ionic (https://github.com/webpro/knip/issues/604)

bbeesley commented 4 months ago

I was gonna request xo, but I've just opened a PR for it instead since I was interested in how they work. https://github.com/webpro/knip/pull/621

webpro commented 4 months ago

Plugins added recently:

emmanuelchucks commented 4 months ago

Expo (expo.dev)

tmm commented 3 months ago

size-limit (and related packages @size-limit/*)

webpro commented 3 months ago

For everyone interested in support for Expo, please see https://github.com/webpro-nl/knip/issues/126. Looking for feedback!

jerone commented 3 months ago

lockfile linting

lint lockfiles for improved security and trust policies

https://github.com/lirantal/lockfile-lint https://github.com/lirantal/lockfile-lint/blob/main/packages/lockfile-lint/README.md

webpro commented 3 months ago

lockfile linting

lint lockfiles for improved security and trust policies

https://github.com/lirantal/lockfile-lint https://github.com/lirantal/lockfile-lint/blob/main/packages/lockfile-lint/README.md

I guess a file-based configuration for the lockfile-lint package potentially leaves e.g. lockfile-lint.js as an unused file. The lockfile-lint configuration doesn't seem to contain options that can reference other packages or files, so a plugin doesn't add much other than Knip users not having to add !lockfile-lint.js to project: [] (or alternatively not having to add lockfile-lint.js to ignore: []). Maybe Knip should have another more light-weight type of plugins that basically just ignores this type of configuration files.

(For completeness sake: the act of linting lockfiles is outside the scope of Knip, and apparently there's a package that does exactly that.)

jerone commented 3 months ago

I guess a file-based configuration for the lockfile-lint package potentially leaves e.g. lockfile-lint.js as an unused file.

Correct. That was the reason for creating this suggestion.

The lockfile-lint configuration doesn't seem to contain options that can reference other packages or files [..]

Also correct. It's just an configuration file. It references no other dependencies/extension/extends/plugins/etc...

[..] so a plugin doesn't add much other than Knip users not having to add !lockfile-lint.js to project: [] (or alternatively not having to add lockfile-lint.js to ignore: []).

Yes, adding it to the ignore setting is my current "work-around".

Maybe Knip should have another more light-weight type of plugins that basically just ignores this type of configuration files.

Lockfile-linting uses https://github.com/cosmiconfig/cosmiconfig (v8) for their config file, as do many other tooling. Maybe these config files can be ignored by default somehow.

Sadly, custom local plugins are not on the roadmap. But the ignore setting is sufficient in this case.

Keep up the great work! 🇳🇱

webpro commented 2 months ago

Knip v5.21.0 contains a few new plugins:

Especially the latter is a bit rudimentary, feel free to open issues if you have any!

shawnmcknight commented 2 months ago

I'd like to request support for rspack. Since rspack's configuration is roughly equivalent to webpack's configuration, it's possible that the webpack plugin could either be cloned or just tweaked to accommodate rspack instead.

I actually tried just changing the knip.json file to have the webpack plugin point to the rspack configuration file and it worked fine with one exception. The rspack configuration allows specification of a builtin: prefix on the loader property (see here) and an "Unlisted dependency" of builtin:swc-loader is being reported by knip.

So, I think it's possible that the webpack plugin could simply be adjusted to:

Suver1 commented 2 months ago

Similar to rspack, I'd like plugin support for rsbuild: https://rsbuild.dev/guide/start/index https://github.com/web-infra-dev/rsbuild

webpro commented 1 month ago

Since some of you have requested plugins for React Cosmos and Rspack, let's make it happen. Would be great if you could share and show some support with a one-time sponsorship? 🙏 I can work on the 2 plugins in the coming weekend.

Rsbuild should have lower threshold after that.

birtles commented 1 month ago

Since some of you have requested plugins for React Cosmos and Rspack, let's make it happen. Would be great if you could share and show some support with a one-time sponsorship?

@birchill has just made a one time sponsorship to see this happen. Hopefully others can join in too!

shawnmcknight commented 1 month ago

Since some of you have requested plugins for React Cosmos and Rspack, let's make it happen. Would be great if you could share and show some support with a one-time sponsorship? 🙏 I can work on the 2 plugins in the coming weekend.

@storis does its sponsorships as recurring monthly rather than one-time. A monthly recurring contribution through open collective has been added, although there's no condition for that with respect to the plugin request.

webpro commented 1 month ago

@birtles @birchill @shawnmcknight @STORIS Thank you so much! Truly appreciated.

webpro commented 1 month ago

Added plugins:

Not yet GA. Can be tested with npm i -D https://pkg.pr.new/knip@2de3924 (or any package manager). Would be very useful if you could try it out to increase coverage and improve the plugins.

Please file bugs in new GitHub issues.

birtles commented 1 month ago

Can be tested with npm i -D https://pkg.pr.new/knip@2de3924 (or any package manager). Would be very useful if you could try it out to increase coverage and improve the plugins.

Works great for me. Thank you!

silverwind commented 1 month ago

Makefile:

lint:
    npx eslint

Should mark eslint as used. I would say this should be core functionality, e.g not a plugin.

BMFreed commented 1 month ago

@webpro I know this was already requested, but are there plans to add a Nuxt plugin?

webpro commented 1 month ago

Re. Nuxt plugin: Usually "auto-imports" might be hard to track indeed during static or even dynamic analysis.

In general not doing much of new features myself at the moment. Sponsored might be an option (DM me). Open to pull requests!

BMFreed commented 1 month ago

Re. Nuxt plugin: Usually "auto-imports" might be hard to track indeed during static or even dynamic analysis.

In general not doing much of new features myself at the moment. Sponsored might be an option (DM me). Open to pull requests!

Thank you for your reply!

with-heart commented 4 weeks ago

preconstruct allows multiple entrypoints to be defined in a package's package.json file. Standalone entrypoints currently have to be manually defined using entry.

webpro commented 2 weeks ago

VitePress (Site Config)

webpro commented 2 weeks ago

Karma (Configuration File)

webpro commented 1 week ago

Added a few plugins in v5.28.0:

NOTE: the Nuxt plugin has no support for auto-import magic, except for defineNuxtConfig (to prevent insta-throw/offs). Should probably add a warning on the plugin page.