Skip to content

Commit

Permalink
[web] Document the need for yarn classic (#745)
Browse files Browse the repository at this point in the history
People often run into issues with `yarn install` because they're using a
newer yarn. The situation is generally bad - we don't want to update to
Yarn v4 yet because it is marked experimental and is not the default
yarn that gets installed by node currently. We could add a
`packageManager` field to our package.json, but this will only fail the
build with a better (hopefully) error message, and will necessitate the
user to `corepack_enable`.

I'm not sure what's the best approach right now to make the initial
setup be seamless (I think we're using the approach that works for the
maximum of all the alternatives, but I'm not sure). At least, let me add
a note about it.

Ref:
* yarnpkg/berry#5912
  • Loading branch information
mnvr authored Mar 8, 2024
2 parents 205dd30 + 9e4f4c4 commit 00f3a0c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
4 changes: 2 additions & 2 deletions web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ yarn dev

That's it. The web app will automatically hot reload when you make changes.

If you're new to web development and unsure about how to get started, see
[docs/new](docs/new.md).
If you're new to web development and unsure about how to get started, or are
facing some problems when running the above steps, see [docs/new](docs/new.md).

## Other apps

Expand Down
11 changes: 11 additions & 0 deletions web/docs/new.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,14 @@ development, here is a recommended workflow:
`yarn` comes with it.

That's it. Enjoy coding!

### Yarn

Note that we use Yarn classic

```
$ yarn --version
1.22.21
```

You should be seeing a 1.xx.xx version, otherwise your `yarn install` will fail.

0 comments on commit 00f3a0c

Please sign in to comment.