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

docs: try to prevent "remix" package footgun #9433

Merged

Conversation

kisaragi-hiu
Copy link
Contributor

Inspired by https://twitter.com/ryanflorence/status/1790041089778373076.

The remix package on npm is the first thing that comes up when one searches "remix" (as the exact match), appears updated regularly, and has no indication that it's no longer used. To hopefully mitigate this, this PR adds an explanation to point people to places they probably intended to go to.

This confusion is probably quite bad: of the 9 public dependents (npm says there are 11 but only lists 9, so I'm assuming the other 2 are private): one (remix-redis-session) has ~4000 weekly downloads (it depends on 1.3), the others all have 2 or 1 digit weekly downloads. That leaves about 18000 new downloads stepping into the footgun, which is comparatively about 4x (remix divided by @remix-run/server-runtime) or 0.5x (remix divided by @remix-run/router) as bad as the biome / @biomejs/biome situation judging by the ratios of weekly downloads.

Copy link

changeset-bot bot commented May 13, 2024

⚠️ No Changeset found

Latest commit: 449b176

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented May 13, 2024

Hi @kisaragi-hiu,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented May 13, 2024

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@brophdawg11 brophdawg11 merged commit f3a7178 into remix-run:main May 20, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants