mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2024-12-18 21:45:04 +01:00
docs: add // @ts-check
to config example
This commit is contained in:
parent
e32847fa3d
commit
a578bb80ba
12
README.md
12
README.md
@ -40,8 +40,8 @@ npm install --save-dev \
|
||||
eslint-plugin-unicorn@^56.0.0 \
|
||||
eslint-plugin-import-x@^4.3.1 \
|
||||
globals@^15.10.0 \
|
||||
"typescript@~5.5.4" \
|
||||
"typescript-eslint@^8.8.0" \
|
||||
typescript@~5.5.4 \
|
||||
typescript-eslint@^8.8.0 \
|
||||
eslint-config-conventions@latest
|
||||
```
|
||||
|
||||
@ -62,10 +62,12 @@ Dependencies are:
|
||||
#### `eslint.config.js` (JavaScript and TypeScript)
|
||||
|
||||
```js
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import eslintConfigConventions from "eslint-config-conventions"
|
||||
// @ts-check
|
||||
|
||||
export default typescriptESLint.config(...eslintConfigConventions)
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import configConventions from "eslint-config-conventions"
|
||||
|
||||
export default typescriptESLint.config(...configConventions)
|
||||
```
|
||||
|
||||
#### Configuration with [Prettier](https://prettier.io/) (recommended)
|
||||
|
@ -1,3 +1,5 @@
|
||||
// @ts-check
|
||||
|
||||
import promise from "eslint-plugin-promise"
|
||||
import unicorn from "eslint-plugin-unicorn"
|
||||
import importX from "eslint-plugin-import-x"
|
||||
|
@ -1,8 +1,8 @@
|
||||
// @ts-check
|
||||
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import eslintConfigConventions from "./eslint.config.js"
|
||||
import configConventions from "./eslint.config.js"
|
||||
|
||||
export default typescriptESLint.config(...eslintConfigConventions, {
|
||||
export default typescriptESLint.config(...configConventions, {
|
||||
ignores: ["test/fixtures/*"],
|
||||
})
|
||||
|
Loading…
Reference in New Issue
Block a user