Skip to content

Commit

Permalink
Updated README for 4.x (#953)
Browse files Browse the repository at this point in the history
  • Loading branch information
CatChen authored May 5, 2024
1 parent 15e3e56 commit 862acd5
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ jobs:
request-changes: true # optional
fail-check: false # optional
github-token: ${{ secrets.GITHUB_TOKEN }} # optional
directory: './' #optional
targets: '.' #optional
eslint-lib-path: './node_modules/eslint/lib/api.js' #optional
eslint-bin-path: 'node_modules/.bin/eslint' # optional
directory: './' # optional
targets: '.' # optional
eslint-lib-path: './node_modules/eslint/lib/api.js' # optional
config-path: '' # optional
```
Save the file to `.github/workflows/eslint.yml`. It will start working on new Pull Requests.
Expand Down Expand Up @@ -86,10 +86,14 @@ The default value is `"."`. For example, it could be `"src"` or `"src/**/*.ts"`

The default value is `"./node_modules/eslint/lib/api.js"`. This action uses the ESLint installed in your project. This makes sure that it's using your project's ESLint version. It gets to know your project's ESLint library location from this value.

### `eslint-bin-path`
### `eslint-bin-path` (deprecated)

The default value is `"node_modules/.bin/eslint"`. This action uses the ESLint installed in your project. This makes sure that it's using your project's ESLint version. It gets to know your project's ESLint binary location from this value.

### `config-path`

The default value is an empty string. This action uses ESLint's default config file when this value is empty. That means `.eslintrc.json` or `.eslintrc.js` for ESLint up to 8.56.0, and `eslint.config.json` for ESLint 8.57.0 or 9+. If you name your config file differently you can set it here.

## FAQ

### What is the difference between a fix and a suggestion in ESLint?
Expand Down

0 comments on commit 862acd5

Please sign in to comment.