diff options
| author | Mark Stacey <markjstacey@gmail.com> | 2019-07-31 02:36:23 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-07-31 02:36:23 +0800 |
| commit | 1fd3dc9ecf16f00d721078e114138e529a7b8e16 (patch) | |
| tree | eec89c15e0ab57173f24931ba286f972c4c97936 /docs | |
| parent | 618c1caf407d5497f4c7ba793f9163640b007e03 (diff) | |
| download | tangerine-wallet-browser-1fd3dc9ecf16f00d721078e114138e529a7b8e16.tar.gz tangerine-wallet-browser-1fd3dc9ecf16f00d721078e114138e529a7b8e16.tar.zst tangerine-wallet-browser-1fd3dc9ecf16f00d721078e114138e529a7b8e16.zip | |
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/bumping_version.md | 4 | ||||
| -rw-r--r-- | docs/developing-on-deps.md | 8 | ||||
| -rw-r--r-- | docs/publishing.md | 2 |
3 files changed, 7 insertions, 7 deletions
diff --git a/docs/bumping_version.md b/docs/bumping_version.md index df38369a2..5b4ca40a6 100644 --- a/docs/bumping_version.md +++ b/docs/bumping_version.md @@ -1,7 +1,7 @@ # How to Bump MetaMask's Version Automatically ``` -npm run version:bump patch +yarn version:bump patch ``` MetaMask publishes using a loose [semver](https://semver.org/) interpretation. We divide the three segments of our version into three types of version bump: @@ -20,7 +20,7 @@ Means a fix for a bug, or correcting something that should have been assumed to # Bumping the version -`npm run version:bump $BUMP_TYPE` where `$BUMP_TYPE` is one of `major`, `minor`, or `patch`. +`yarn version:bump $BUMP_TYPE` where `$BUMP_TYPE` is one of `major`, `minor`, or `patch`. This will increment the version in the `app/manifest.json` and `CHANGELOG.md` files according to our current protocol, where the manifest's version is updated, and any line items currently under the changelog's "master" section are now under the new dated version section. diff --git a/docs/developing-on-deps.md b/docs/developing-on-deps.md index e2e07cb4e..20c0f7c97 100644 --- a/docs/developing-on-deps.md +++ b/docs/developing-on-deps.md @@ -3,7 +3,7 @@ To enjoy the live-reloading that `gulp dev` offers while working on the dependencies: 1. Clone the dependency locally. - 2. `npm install` in its folder. - 3. Run `npm link` in its folder. - 4. Run `npm link $DEP_NAME` in this project folder. - 5. Next time you `npm start` it will watch the dependency for changes as well! + 2. `npm install` or `yarn install` in its folder. + 3. Run `yarn link` in its folder. + 4. Run `yarn link $DEP_NAME` in this project folder. + 5. Next time you `yarn start` it will watch the dependency for changes as well! diff --git a/docs/publishing.md b/docs/publishing.md index cc3e5cc3a..17192ee8a 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -41,7 +41,7 @@ With each pull request, the @MetaMaskBot will comment with a build of that new p 3. Publish to [firefox addon marketplace](http://addons.mozilla.org/en-us/firefox/addon/ether-metamask). 4. Publish to [Opera store](https://addons.opera.com/en/extensions/details/metamask/). 5. Post on [Github releases](https://github.com/MetaMask/metamask-extension/releases) page. -6. Run the `npm run announce` script, and post that announcement in our public places. +6. Run the `yarn announce` script, and post that announcement in our public places. ## Hotfix Differences |