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
7.03k stars 174 forks source link

💡 Add documentation for how a given plugin works #824

Closed thoughtsunificator closed 1 week ago

thoughtsunificator commented 3 weeks ago

Looking at the documentation:

Screenshot ![knip dev_reference_plugins_eslint](https://github.com/user-attachments/assets/2addc559-30ed-48cd-a587-d8f9dbd22f0b)

We can see that it does not say anything about what this plugin does.

I would suggest that Knip tries:

This holds true for any plugin listed at https://knip.dev/reference/plugins.

webpro commented 3 weeks ago

Thanks for the suggestions. Let's go over each of them:

To explain what a certain plugin does

What information would you be looking for? Each plugin links to https://knip.dev/explanations/plugins, this is what all plugins do. Explaining what each plugin individually does would take up too much time, but we could link to implementation/source code to see exactly what it does currently.

List related ongoing issues

Currently I'm not tagging issues in GitHub to link to particular plugins.

Linkify config and entry options.

What do you mean by this?

webpro commented 1 week ago

Somehow I feel this conversation isn't gonna be fruitful.