Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
lvjiaxuan committed Feb 2, 2024
1 parent 76bbe67 commit 0a9aa91
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ All rules inherit from [@antfu/eslint-config](https://github.com/antfu/eslint-co
2. Try to detect `tsconfig.json` if TypeScript is enabled, which means enabling type-aware rules.
3. Add my [eslint-plugin-oxlint](https://github.com/lvjiaxuan/eslint-config/tree/main/packages/eslint-plugin-oxlint/src/index.ts).

> [!NOTE]
> *Why not just set `typescript.tsconfigPath` ?<br />*
> I have just encountered the Q. Perhaps a forced way of saying it is that the `tsconfig.json` is guaranteed to exists. :frowning:
# Usage

Follow [antfu's](https://github.com/antfu/eslint-config).
Expand Down Expand Up @@ -45,7 +49,7 @@ Modify lint scritp:
{
"scripts": {
- "lint": "eslint ."
+ "lint": "oxlint . && eslint ." // `oxlint` installed, otherwise use alternative `npx oxlint`.
+ "lint": "oxlint . && eslint ." // The `oxlint` has been installed, otherwise use alternative `npx oxlint`.
}
}
```

0 comments on commit 0a9aa91

Please sign in to comment.