5c88dcf0cc | ||
---|---|---|
.github | ||
.husky | ||
.vscode | ||
angular | ||
common | ||
components | ||
electron | ||
node | ||
shared | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.json | ||
.git-blame-ignore-revs | ||
.gitattributes | ||
.gitignore | ||
.prettierignore | ||
.prettierrc.json | ||
CONTRIBUTING.md | ||
LICENSE.txt | ||
README.md | ||
SECURITY.md | ||
jest.config.js | ||
package-lock.json | ||
package.json | ||
tsconfig.json | ||
tsconfig.spec.json |
README.md
Repository Reorganization in Progress
We are currently migrating some projects over to a mono repository. For existing PR's we will be providing documentation on how to move/migrate them. To minimize the overhead we are actively reviewing open PRs. If possible please ensure any pending comments are resolved as soon as possible.
New pull requests created during this transition period may not get addressed —if needed, please create a new PR after the reorganization is complete.
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.
We're Hiring!
Interested in contributing in a big way? Consider joining our team! We're hiring for many positions. Please take a look at our Careers page to see what opportunities are currently open as well as what it's like to work at Bitwarden.
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:
- Check out your local Branch
- Run
git merge 8b2dfc6cdcb8ff5b604364c2ea6d343473aee7cd
- Resolve any merge conflicts, commit.
- Run
npm run prettier
- Commit
- Run
git merge -Xours 193434461dbd9c48fe5dcbad95693470aec422ac
- Push
Git blame
We also recommend that you configure git to ignore the prettier revision using:
git config blame.ignoreRevsFile .git-blame-ignore-revs