1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-06 09:20:43 +01:00
bitwarden-browser/README.md
Daniel James Smith 36b3aea758
Update README.md (#586)
* Update README.md

* Replace header Git diff with Git blame
2021-12-16 14:38:11 +01:00

1.2 KiB

Github Workflow build on master

Bitwarden JavaScript Library

Common code referenced across Bitwarden JavaScript projects.

Requirements

  • Node.js v16.13.1 or greater
  • NPM v8
  • Git
  • node-gyp

Windows

  • Microsoft Build Tools 2015 in Visual Studio Installer
  • Windows 10 SDK 17134 either by downloading it seperately or through the Visual Studio Installer.

Prettier

We recently migrated to using Prettier as code formatter. All previous branches will need to updated to avoid large merge conflicts using the following steps:

  1. Check out your local Branch
  2. Run git merge 8b2dfc6cdcb8ff5b604364c2ea6d343473aee7cd
  3. Resolve any merge conflicts, commit.
  4. Run npm run prettier
  5. Commit
  6. Run git merge -Xours 193434461dbd9c48fe5dcbad95693470aec422ac
  7. Push

Git blame

We also recommend that you configure git to ignore the prettier revision using:

git config blame.ignoreRevsFile .git-blame-ignore-revs