backstage/community-plugins

tech-insights: Move TechInsightCheck to @backstage-community/plugin-tech-insights-common

Opened this issue · 4 comments

mostafah commented

Plugin Name

tech-insights

🔖 Feature description

Actually, it is not a feature, but I could not find a more fitting plugin-related option when openning a new issue.

The type TechInsightCheck is exported from @backstage-community/plugin-tech-insights-node. But it has nothing that is exclusive to the node envionment. Moving it to @backstage-community/plugin-tech-insights-common makes it accessible in more places.

🎤 Context

Just to give a use case as an example, in our Backstage instance we have a -common isomorphic plugin for defining types and common values about our custom tech insights checks. Right now we have to copy TechInsightCheck to it so that we can extend it with our CustomTechInsightCheck type. This type includes extra information that can help UI (like grouping information, a short name for table views, …) so frontend application importes and uses CutomTechInsightCheck. That’s why this type should be in a -common package and that’s also the reason it is not possible to import TechInsightCheck from its current package.

✌️ Possible Implementation

I would be happy to create a PR if the change makes sense to you.

👀 Have you spent some time to check if this feature request 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?

Yes I am willing to submit a PR!

github-actions commented

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

awanlin commented

Hi @Xantier, any thoughts on this?

Xantier commented

The type may contain some information that is not serializable across the boundaries. I think it might be better to create a separate slimmed down type on the common package instead.

kurtaking commented

The type may contain some information that is not serializable across the boundaries. I think it might be better to create a separate slimmed down type on the common package instead.

I was going to recommend deprecating TechInsightsCheck in favor of Check. Can you elaborate more on what you mean here?

  • 👍1