Skip to content

Commit

Permalink
docs(readme): mention v9 changes
Browse files Browse the repository at this point in the history
BREAKING CHANGE: enabled experimental Yarn 2+ lockfiles support
  • Loading branch information
antongolub committed Dec 11, 2021
1 parent 84b0243 commit 6c0ae5c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
[![Downloads](https://img.shields.io/npm/dt/yarn-audit-fix)](https://www.npmjs.com/package/yarn-audit-fix)
[![npm (tag)](https://img.shields.io/npm/v/yarn-audit-fix)](https://www.npmjs.com/package/yarn-audit-fix)

Apply `npm audit fix` logic to `yarn.lock`
The missing `yarn audit --fix`

- [Digest](#digest)
- [Problem](#problem)
Expand All @@ -29,6 +29,7 @@ Apply `npm audit fix` logic to `yarn.lock`
- [ENV](#env)
- [JS API](#js-api)
- [Migration notes](#migration-notes)
- [^9.0.0](#900)
- [^8.0.0](#800)
- [^7.0.0](#700)
- [^6.0.0](#600)
Expand Down Expand Up @@ -164,6 +165,9 @@ await run({}, flow)
```

## Migration notes
### ^9.0.0
v9 brings experimental Yarn 2+ lockfiles support, so the previous behaviour (when `yaf` parsing failure may be used to detect them) has been changed.

### ^8.0.0
From v8 the library does not contain **npm** dependency, so the system default is used instead. If necessary you can:
* Install the required npm version and provide a custom path via [CLI](#cli) / [ENV](#env) / [JS API](#js-api)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "8.0.1",
"private": false,
"type": "module",
"description": "Apply `npm audit fix` logic to `yarn.lock`",
"description": "The missing `yarn audit --fix`",
"bin": {
"yarn-audit-fix": "./target/es6/cli.js"
},
Expand Down

0 comments on commit 6c0ae5c

Please sign in to comment.