Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove example extensions that depend on npm #398

Open
wbamberg opened this issue Jan 4, 2019 · 5 comments
Open

Remove example extensions that depend on npm #398

wbamberg opened this issue Jan 4, 2019 · 5 comments
Labels
example New or updated example idle Issues and pull requests with no activity for three months.

Comments

@wbamberg
Copy link

wbamberg commented Jan 4, 2019

Several of the examples here pull in dependencies for stuff like react, babel, webpack, eslint. They are useful to show how WebExtensions can integrate these technologies, but I think they are outside the core scope of this repo, which is to show how to use the WebExtension APIs.

They are still useful and if they were zero-cost, then I'd be happy to keep them, but they are a significantly greater maintenance burden than extensions that just use the WebExtension APIs. So I'd propose we just remove these examples.

This applies to:

@chrisdavidmills
Copy link
Contributor

I agree with this.

@jwhitlock
Copy link

The example in react-es6-popup is the cause of 5 security alerts for the repository, two of them high severity (thanks @openjck). I'm a fan of removing that one first.

@irenesmith
Copy link
Contributor

I agree that the web extensions examples should focus on the WebExtension APIs.

@motin
Copy link

motin commented Jul 1, 2019

Removing to decrease maintenance seems like a great idea, but maybe they can still live on in one or many separate repos (which in turn can be archived and read-only in case they have no maintainers), or at least linked to from somewhere? Some are still useful despite being a bit outdated.

@kumar303
Copy link
Contributor

kumar303 commented Oct 9, 2019

These examples are really important because npm integration greatly enhances the development experience and most developers are already using it for complex extensions, anyway, especially in the Chrome ecosystem. Integrating with npm greatly simplifies dependency management, such as keeping webextension-polyfill up to date.

As an anecdote, I noticed an extension in the wild which suggested an npm install step and a manual step of installing web-ext. This is unnecessary because one could just alias npm start to the web-ext command as the react-es6-popup showed.

If the security vulnerabilities are bothersome I suggest disabling them entirely. The goal of this repo is not to ship production-ready code so I don't see how those are useful. The npm ecosystem moves quickly, sure, but an outdated example will still be very helpful to someone who is starting a new project when they are familiar with npm. They would know to update the dependencies on a new project.

As a side note, there is no way someone could discover an example of using React in an extension now. This is not straightforward which is why I think an example was very helpful. React is a very popular framework for building UIs so we should provide a smooth transition into webextensions for those developers.

@github-actions github-actions bot added the idle Issues and pull requests with no activity for three months. label Jan 4, 2023
@rebloor rebloor added the example New or updated example label Jun 24, 2023
@github-actions github-actions bot removed the idle Issues and pull requests with no activity for three months. label Jun 25, 2023
@github-actions github-actions bot added the idle Issues and pull requests with no activity for three months. label Jul 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
example New or updated example idle Issues and pull requests with no activity for three months.
Projects
None yet
Development

No branches or pull requests

7 participants