1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 01:39:44 +01:00
metamask-extension/docs
Mark Stacey 1fd3dc9ecf
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.
2019-07-30 15:36:23 -03:00
..
components Added visual documentation of the account menu component (#6775) 2019-07-05 10:24:30 -02:30
extension_description Add extension store description for easy reference 2016-10-05 11:10:04 -07:00
add-to-chrome.md Update add-to-chrome.md 2018-03-17 20:33:20 +00:00
add-to-firefox.md Rename add-to-firef.md to add-to-firefox.md 2017-09-11 22:53:33 -07:00
adding-new-networks.md Folder restructure (#6304) 2019-03-21 20:33:30 -02:30
architecture.png Rename accountManager usages (#6790) 2019-07-10 16:31:48 -02:30
bumping_version.md Switch from npm to yarn (#6843) 2019-07-30 15:36:23 -03:00
creating-metrics-events.md MetaMetrics documentation (#6624) 2019-05-20 15:02:26 -02:30
design-system.md add link to design system 2019-04-24 16:30:50 -07:00
developing-on-deps.md Switch from npm to yarn (#6843) 2019-07-30 15:36:23 -03:00
development-visualization.md Break docs up into individual files 2017-06-05 13:55:48 -07:00
form_persisting_architecture.md Update persistient-form docs 2016-08-25 14:03:34 -07:00
limited_site_access.md Added Chrome limited site access solution doc (#6422) 2019-04-10 22:56:47 -02:30
multi_vault_planning.md Add to doc 2016-10-11 15:06:09 -07:00
porting_to_new_environment.md Remove unused unlockAccountMessage callback (#6905) 2019-07-24 23:40:22 -03:00
publishing.md Switch from npm to yarn (#6843) 2019-07-30 15:36:23 -03:00
QA_Guide.md Update QA_Guide.md 2018-04-05 16:15:55 -07:00
README.md Remove outdated development tools and documentation (#6845) 2019-07-15 14:24:37 -03:00
secret-preferences.md Enable mobile sync (#6332) 2019-03-21 12:43:10 -07:00
send-screen-QA-checklist.md Adds description to send-screen-QA-checklist.md 2018-05-16 12:45:06 -02:30
sensitive-release.md Update publishing doc to reflect automation (#6899) 2019-07-30 10:53:04 -02:30
state_dump.md Fix typos (#5471) 2018-10-09 09:29:51 -02:30
team.md Fix spelling typo 2018-04-16 15:08:43 -07:00
transaction-flow.png [ImgBot] Optimize images (#1) (#6829) 2019-07-10 11:37:20 -03:00
translating-guide.md Fix typos (#5471) 2018-10-09 09:29:51 -02:30
trezor-emulator.md added TREZOR simulator instructions 2018-07-13 20:31:40 -04:00
video_script.txt Updated script for what I recorded. 2016-07-11 12:06:58 -07:00

Documentation

These docs relate to how to contribute to the MetaMask project itself.

You can find the latest version of MetaMask on our official website.

For help using MetaMask, visit our User Support Site.

For up to the minute news, follow our Twitter or Medium pages.

To learn how to develop MetaMask-compatible applications, visit our Developer Docs.