bitwarden-browser/libs/README.md

[![Github Workflow build on master](https://github.com/bitwarden/jslib/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/bitwarden/jslib/actions/workflows/build.yml?query=branch:master)

# Bitwarden JavaScript Library

Common code referenced across Bitwarden JavaScript projects.

## Requirements

- [Node.js](https://nodejs.org) v16.13.1 or greater
- NPM v8
- Git
- node-gyp

### Windows

- _Microsoft Build Tools 2015_ in Visual Studio Installer
- [Windows 10 SDK 17134](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive/)
  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](https://bitwarden.com/careers/) 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:

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:

```bash
git config blame.ignoreRevsFile .git-blame-ignore-revs
```
Replaced appveyor build badge with one from Github Workflow (#319) * Deleted appveyor.yml * Removed Appveyor check in karma.conf.js * Modified build badge to use Github workflow * Fixed missing parenthesis in README.md 2021-04-05 21:25:45 +02:00			`[![Github Workflow build on master](https://github.com/bitwarden/jslib/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/bitwarden/jslib/actions/workflows/build.yml?query=branch:master)`
Update README.md 2018-04-17 22:25:01 +02:00
Uppercase Bitwarden 2018-02-27 20:19:31 +01:00			`# Bitwarden JavaScript Library`

			`Common code referenced across Bitwarden JavaScript projects.`
Desktop biometrics support (#119) * Initial work on windows hello support * Switch to use windows.security.credentials.ui UserConsentVerifier * Fix linting warnings * Remove unessesary supportsBiometric from lock screen * Rename biometric.main to windows.biometric.main. Add abstraction for biometric. * Add support for dynamic biometric text. * Add untested darwin implementation * Rename fingerprintUnlock to biometric * Add new functions to cliPlatformUtils.service.ts. * Hide login if biometric is not supported * Export default for biometric..main.ts Remove @nodert-win10-rs4/windows.security.credentials * Add build requirements to readme * Auto prompt biometric when starting the application. * Ensure we support biometric before trying to auto prompt. * Fix review comments and linting errors 2020-07-23 19:32:20 +02:00
			`## Requirements`
Apply Prettier (#581) 2021-12-16 13:36:21 +01:00
Bump node to 16 and npm (#575) * Bump engines required to node 16 and npm 8 * Bump @types/node to 16 The dep on node 14.18 will get cleaned up once we bump electron * Modify build.yml to build with node 16 and npm 8 * Update requirements in README.md * Remove install step for npm 8 npm v8.1.2 is included in node v16 * Rename install step * Fixed typo 2021-12-13 11:43:10 +01:00			`- [Node.js](https://nodejs.org) v16.13.1 or greater`
			`- NPM v8`
Desktop biometrics support (#119) * Initial work on windows hello support * Switch to use windows.security.credentials.ui UserConsentVerifier * Fix linting warnings * Remove unessesary supportsBiometric from lock screen * Rename biometric.main to windows.biometric.main. Add abstraction for biometric. * Add support for dynamic biometric text. * Add untested darwin implementation * Rename fingerprintUnlock to biometric * Add new functions to cliPlatformUtils.service.ts. * Hide login if biometric is not supported * Export default for biometric..main.ts Remove @nodert-win10-rs4/windows.security.credentials * Add build requirements to readme * Auto prompt biometric when starting the application. * Ensure we support biometric before trying to auto prompt. * Fix review comments and linting errors 2020-07-23 19:32:20 +02:00			`- Git`
			`- node-gyp`

			`### Windows`

			`- _Microsoft Build Tools 2015_ in Visual Studio Installer`
			`- [Windows 10 SDK 17134](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive/)`
			`either by downloading it seperately or through the Visual Studio Installer.`
Add .git-blame-ignore-revs and prettier instructions (#585) 2021-12-16 14:10:11 +01:00
We're Hiring (#692) Added link to README.md for Bitwarden Careers page. 2022-02-22 14:03:54 +01:00			`## 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](https://bitwarden.com/careers/) to see what opportunities are currently open as well as what it's like to work at Bitwarden.`

Add .git-blame-ignore-revs and prettier instructions (#585) 2021-12-16 14:10:11 +01:00			`## 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.`
Update README.md (#586) * Update README.md * Replace header Git diff with Git blame 2021-12-16 14:38:11 +01:00			4. Run `npm run prettier`
Add .git-blame-ignore-revs and prettier instructions (#585) 2021-12-16 14:10:11 +01:00			`5. Commit`
			6. Run `git merge -Xours 193434461dbd9c48fe5dcbad95693470aec422ac`
			`7. Push`

Update README.md (#586) * Update README.md * Replace header Git diff with Git blame 2021-12-16 14:38:11 +01:00			`### Git blame`
Add .git-blame-ignore-revs and prettier instructions (#585) 2021-12-16 14:10:11 +01:00
			`We also recommend that you configure git to ignore the prettier revision using:`

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