plugin(npm): create a standalone demo application for npm plugin

[karthikjeeyar]

This PR adds a standalone npm demo application.

How to test:

1. navigate into the workspaces/npm/plugins/npm folder
2. run yarn start

✔️ Checklist

• A changeset describing the change and affected packages. (more info)
• Added or updated documentation
• Tests for new functionality and regression tests for bug fixes
• Screenshots attached (for UI changes)
• All your commits have a Signed-off-by line in the message. (more info)

[backstage-goalie]

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
app	workspaces/npm/packages/app	none	v0.0.1
@backstage-community/plugin-npm	workspaces/npm/plugins/npm	patch	v1.0.0

[backstage-goalie]

Thanks for the contribution!
All commits need to be DCO signed before they are reviewed. Please refer to the the DCO section in CONTRIBUTING.md or the DCO status for more info.

[christoph-jerolimov]

Some tiny code style ideas :)

[christoph-jerolimov]

Thanks for that change. Lgtm!

[karthikjeeyar]

cc: @nickboldt

[awanlin]

Thanks for the adjustments @karthikjeeyar, just one change needed around the changeset config 👍

[karthikjeeyar]

This PR now contains only the standalone demo application, I have removed all the release related changes.

[christoph-jerolimov]

Thanks @karthikjeeyar, lgtm!

[awanlin]

Hi @karthikjeeyar, thanks for the changes to match things going on outside this PR impacting you. 🙏

Looking over this again and I left a comment about the exports in your plugin.ts, you also need to add a changeset as the code is changing and you'll want a new package version published to NPM.

[awanlin]

Solid! Thanks again @karthikjeeyar 🚀

[christoph-jerolimov]

Solid! Thanks again @karthikjeeyar 🚀

Actually, this breaks the existing code because it changes the exported names. :-/

The direction is fine, of course; the usage of createComponentExtension is great!

And I'm thankful for the code improvement and review!

But at the same moment, it's a bit sad that I didn't had "the chance" to review this.

[awanlin]

Hi @christoph-jerolimov, sorry, you are absolutely correct. In this case I moved too fast. How best should we move forward? I'm willing to put a PR together if needed.

[christoph-jerolimov]

It's fine! I don't expect any users at the moment 😏 🤷‍♂️

I just wanted share "that feeling" and thanks that you accepting the feedback. 🤗

Moving fast, breaking things and fixing them is fine.

I will look into that report.api.md issue and raise a PR later today, but we don't need to rush on that for me.

[awanlin]

Thanks, it for sure was not intentional, I had some time to review and this looked ready to go.

There are 117 downloads for this package, people are using it and for them this would be a breaking change. Do you want me to at least update the changelog to match that reality?

[awanlin]

I have the code change waiting in a branch here: main...awanlin:community-plugins:topic/npm-changelog-correction, if you want me to make a PR just let me know.

[christoph-jerolimov]

Fine for me. I thought about exporting Entity*Card as *Card as well, and marking it as deprecated. (Work in progress)

[awanlin]

It's your plugin and I'm tryin to correct my mistake, if the deprecated path if the one you want to take I'm fine with that 👍

[awanlin]

How does this look to you? main...awanlin:community-plugins:topic/npm-correction

[christoph-jerolimov]

You're fast :) I worked on a similar idea, wdyt about #1751?

[christoph-jerolimov]

Actually, I'm confused why the renaming was required. Last week, when I checked this with Karthik we both had issues with the api exports which I couldn't reproduce..

And I'm not sure if its a best practice to prefix entity Cards with Entity*

[awanlin]

#1751 looks good to me, I've approved but leaving it to you to tell me when to merge.

As for the Entity prefix it's been a common convention used for a long time by various plugins but it's not something you have to do. My quick scan I saw it at about 50/50 in the 4 plugins I looked at. The idea was that it helps identify that it "needs" to be used in the Catalog as part of an entity as the component likely uses useEntity.

[karthikjeeyar]

Actually, I'm confused why the renaming was required. Last week, when I checked this with Karthik we both had issues with the api exports which I couldn't reproduce..

And I'm not sure if its a best practice to prefix entity Cards with Entity*

Apologies for introducing breaking changes, my intent was to follow Entity* naming convention which helps to clarify that these component needs to be wrapped inside EntityProvider for it to work. To resolve the api exports issue, I replaced the regular function exports with arrow function exports.