Use yarn instead of npm in docs and scripts
#796
Conversation
CONTRIBUTING.md
Outdated
| @@ -23,6 +23,8 @@ inside the `MatrixEventProcessor` class. | |||
|
|
|||
| * You will need to [setup the bridge](https://github.com/Half-Shot/matrix-appservice-discord/tree/develop#setup-the-bridge) similarly to how we describe, | |||
| but you should setup a homeserver locally on your development machine. We would recommend [Synapse](https://github.com/matrix-org/synapse). | |||
| * We recommend using `yarn` for dependency management (v1 / Classic for the time being). | |||
There was a problem hiding this comment.
TIL that there are newer versions. Are there any known incompatibilities that could bite us/users?
There was a problem hiding this comment.
Yarn Berry installs in a completely different incompatible layout to Yarn Classic.
There was a problem hiding this comment.
Anyway, probably be a good idea to enforce node and yarn versions in package.json so users don't get bitten.
Signed-off-by: Andrew Ferrazzutti <andrewf@element.io>
Signed-off-by: Andrew Ferrazzutti <andrewf@element.io>
AndrewFerr
force-pushed
the
af/npm-to-yarn
branch
from
2ea8128 to
e09dba9
Compare
|
Enforcing Yarn was a lot more involved than I expected! This uses the recommendation from yarnpkg/yarn#4895 (comment) to tweak Since that doesn't actually install the required Yarn version, I added a package script to call handle that. It calls Note that the recommended solution from the Yarn team is to lock versions with Corepack, or to keep the Yarn binary in version control. Since Corepack is currently opt-in and checking in a script is cumbersome, I settled on using the |
Instead, just document how to install it Signed-off-by: Andrew Ferrazzutti <andrewf@element.io>
Signed-off-by: Andrew Ferrazzutti <andrewf@element.io>
This is on top of #794, which should be merged first.