question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

🚀 Feature: Add the ability to generate a web-library plugin with backstage-cli

See original GitHub issue

🔖 Feature description

backstage-cli can bundle different kinds of Backstage plugins. You can see a complete list of available package roles in the source code. There are several packages that use this role: @backstage/theme and @backstage/version-bridge .

Unfortunately, backstage-cli doesn’t support creating a plugin with a web-library role.

🎤 Context

One of our clients has new contributors to their inner source Backstage portal. They would like to be able to create web-library plugins. They would like to be able to tell their developers to use the CLI, but this is not currently possible.

✌️ Possible Implementation

This conversation came up in Discord where @Rugvip suggested that to implement this, we need to add a factory and a template.

Several existing factories can be used for inspiration. There are also existing templates that can be found here.

👀 Have you checked if this feature request has been raised before?

  • I checked and didn’t find a similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes, I am willing to submit a PR!

Issue Analytics

  • State:closed
  • Created a year ago
  • Reactions:2
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
tarascommented, Nov 24, 2022

@kurtaking 👋 thank you for picking this up.

@backstage/plugin-explore-react is a good example of a minimal web-library.

A good place to start could be to include the following,

  • /package.json
  • /README.md
  • /.eslintrc.js
  • /src/index.ts
  • /src/setupTests.ts

@Rugvip do we need to add anything else?

0reactions
jhaalscommented, Dec 19, 2022

👏 Thanks!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Commands - Backstage Demo
This page lists all commands provided by the Backstage CLI, what they're for, and where to use them. The documentation for each command...
Read more >
Backstage Plugins by Example: Part 1 - John Tucker - Medium
The most powerful feature of Backstage, however, is the ability to relatively easily create new features using Backstage Plugins. Backstage plugins provide ...
Read more >
@backstage/cli - npm
CLI for developing Backstage plugins and apps. ... Start using @backstage/cli in your project by running `npm i @backstage/cli`.
Read more >
Pulse · backstage/backstage · GitHub
Update dependency @roadiehq/backstage-plugin-github-insights to v2.1.3 ... #15077 opened 3 days ago. 🚀 Feature: Add plugin-react template to backstage-cli.
Read more >
Last issues related to backstage/backstage project - PullAnswer
New Snyk vulnerability that originated from backstage/cli latest version ... Feature: Add the ability to generate a web-library plugin with backstage-cli.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found