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

Scripts variant in README to support the Yarn inclined #208

Open
TheRealFlyingCoder opened this issue Sep 7, 2023 · 1 comment
Open

Comments

@TheRealFlyingCoder
Copy link

Have you experienced this bug with the latest version of the template?

Yes

Steps to Reproduce

So this less a Bug more of a little annoyance, which could be helpful to include in the README for anyone who'd prefer yarn?

Specifically this is around setting up the package scripts to support yarn

  1. Yarn install instead of NPM
  2. Update npm run to yarn run in the scripts (To follow protocol, even though we'll ignore this down below)

Expected Behavior

yarn run dev starts the dev server as normal

Actual Behavior

You hit a few roadbloacks:

  1. run-p dev:* fails with the error: No matches found: "dev:*"

Solution: Wrap dev:* in quotes -> run-p 'dev:*'

  1. dev:server fails with the error: Invalid build flag: "--"

Solution: revert back to npm run build:server (Keen to know why this is 👀)

Technically it's only 1 roadblock with a simple solution if you keep npm run in your yarn project, but at the end of the day if you are using yarn there are reasons to keep yarn run around... I just dont have a simple solution for #2

Just thinking this could be an easy sentence in the README if you think it's worth having ^

@machour
Copy link
Collaborator

machour commented May 17, 2024

Hey @TheRealFlyingCoder 👋🏼

Almost all remix README / docs use npm.. I'm not sure we should start showing how to use yarn, pnpm, and other pms.. wdyt ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants