Skip to content

Commit

Permalink
chore: apply review changes
Browse files Browse the repository at this point in the history
- Added `-i` flag details to README.md
- Retained the `prebuild` command
- Performed `npm audit fix` to address vulnerabilities
  • Loading branch information
Gaurav Chinawale committed Sep 3, 2024
1 parent ab6e44c commit a0eb2a1
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,14 @@ npm run audit

## Options

| Flag | Short | Description |
| ----------------- | ----- | ----------------------------------------------------------------------------------------------------- |
| `--exclude` | `-x` | Exceptions or the vulnerabilities ID(s) to exclude; the ID can be the numeric ID, CVE, CWE or GHSA ID |
| `--module-ignore` | `-m` | Names of modules to exclude |
| `--level` | `-l` | The minimum audit level to validate; Same as the original `--audit-level` flag |
| `--production` | `-p` | Skip the `devDependencies` |
| `--registry` | `-r` | The npm registry url to use |
| Flag | Short | Description |
| --------------------| ----- | ----------------------------------------------------------------------------------------------------- |
| `--exclude` | `-x` | Exceptions or the vulnerabilities ID(s) to exclude; the ID can be the numeric ID, CVE, CWE or GHSA ID |
| `--module-ignore` | `-m` | Names of modules to exclude |
| `--level` | `-l` | The minimum audit level to validate; Same as the original `--audit-level` flag |
| `--production` | `-p` | Skip the `devDependencies` |
| `--registry` | `-r` | The npm registry url to use |
| `--include-columns` | `-i` | Columns to include in report |

<br />

Expand Down
9 changes: 5 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"lint": "eslint .",
"qc": "npm run test && npm run lint",
"clean": "rimraf lib",

"prebuild": "npm run qc && npm run clean",
"build": "tsc",
"postbuild": "cp README.md lib && chmod +x ./lib/index.js",
"publish:live": "npm run build && npm publish ./lib --tag latest",
Expand Down

0 comments on commit a0eb2a1

Please sign in to comment.