backstage/community-plugins

🔧 Repository: Use Knip

awanlin opened this issue · 3 comments

awanlin commented

📜 Description

Note: logging this here as it would impact all plugins.

We started to use Knip in the main Backstage repo and we also use it for the Demo site and it's terribly helpful at keeping things neat and tidy. We should implement it here as well.

I think the method used in the Backstage repo makes sense where it generates an report and is currently not causing things to fail. From there maybe we can look at a way to make it opt in per workspace and then mandatory over time.

👍 Expected behavior

We have tooling that will report on unused files, dependencies and exports.

👎 Current Behavior

We DO NOT have tooling that will report on unused files, dependencies and exports.

👟 Reproduction steps

N/A

📃 Provide the context for the Bug.

Having a tool like Knip in place just makes it easier to maintain your plugin as it let's you know what isn't being used easily and you can address it right away. This means plugins are in a better state and are just a bit better quality.

👀 Have you spent some time to check if this bug has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

No, I don't have time to work on this right now

awanlin commented

Contributions welcome! 🚀

04kash commented

@awanlin I'd like to take a look at this, can you assign it me?

  • 👍1
awanlin commented

There's a thread on Discord related to Knip that's worth reviewing: https://discord.com/channels/687207715902193673/1272567797976793149

  • 👍1