Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas-Avery committed Nov 29, 2023
1 parent a725cd3 commit 97ee36a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ Install the dependencies
$ npm install
```

Build the typescript and package it for distribution
Run formatter and lint

```bash
$ npm run build && npm run pack
$ npm run prettier && npm run lint
```

Run the tests :heavy_check_mark:
Expand All @@ -127,10 +127,8 @@ $ npm test

GitHub recommends using a tool called [@vercel/ncc](https://github.com/vercel/ncc) to compile code and modules into one file used for distribution.

The alternative being to check in the node_modules directory which is known to cause problems.

- Compile dependencies into ./dist/index.js
- Package the TypeScript for distribution

```bash
$ npm run dist
$ npm run bundle
```
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"node": ">=20"
},
"scripts": {
"all": "npm run dist && npm run prettier && npm run lint && npm test",
"all": "npm run prettier && npm run lint && npm test && npm run dist",
"bundle": "npm run prettier && npm run lint && npm run dist",
"lint": "eslint src/**/*.ts && prettier --check '**/*.ts'",
"lint:fix": "eslint src/**/*.ts --fix",
"dist": "pwsh ./pack.ps1 && ncc build src/index.ts --license licenses.txt --external @bitwarden/sdk-napi",
Expand Down

0 comments on commit 97ee36a

Please sign in to comment.