stencil-community / stencil-eslint

ESLint rules specific to Stencil JS projects
MIT License
61 stars 34 forks source link

feat: Clarify which NPM package to use #88

Closed niklas2810 closed 1 year ago

niklas2810 commented 1 year ago

Prerequisites

Describe the Feature Request

Hey there! I am opening this as a feature request since this is something which I think needs change, but is not a bug per se.

I noticed that the eslint plugin was moved to the stencil-community organization (#76 ), and with that there is a new name associated: @stencil-community/eslint-plugin.

That makes sense, but in my mind its very confusing that the original package @stencil/eslint-plugin (https://www.npmjs.com/package/@stencil/eslint-plugin) is still online, without any notice in its package info. The link is also still the ionic-team one, even though it automatically redirects to this repo.

Describe the Use Case

I'm not very experienced with publishing NPM packages - so please forgive me if there is no easy solution for that - but is there a way we could add some kind of deprecation warning to the original package on npmjs.com? Otherwise you have to check the link to the GitHub repo to find out that the package has moved.

Describe Preferred Solution

Add a deprecation warning to the original package.

Describe Alternatives

Add a hint in the README of this repository, so that at least anyone visiting from npmjs.com immediately sees that the package has moved.

Related Code

No response

Additional Information

No response

raphaelpor commented 1 year ago

@rwaskiewicz Can we do something about it in the original package?

rwaskiewicz commented 1 year ago

👍 I've marked the original package as deprecated in NPM: Screenshot 2023-02-13 at 8 06 00 AM

raphaelpor commented 1 year ago

Big thanks @rwaskiewicz! I will close this issue then. :)

niklas2810 commented 1 year ago

Thank you very much to you two! :)