theoludwig/eslint-config-conventions
theoludwig/eslint-config-conventions
1
1
Fork 0
mirror of https://github.com/theoludwig/eslint-config-conventions.git synced 2024-12-18 21:45:04 +01:00
Code Issues Releases Activity

docs: add // @ts-check to config example

Browse Source
This commit is contained in:
Théo LUDWIG 2024-10-08 08:10:28 +02:00
parent e32847fa3d
commit a578bb80ba
Signed by: theoludwig
GPG Key ID: ADFE5A563D718F3B
3 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -40,8 +40,8 @@ npm install --save-dev \
eslint-plugin-unicorn@^56.0.0 \ eslint-plugin-unicorn@^56.0.0 \
eslint-plugin-import-x@^4.3.1 \ eslint-plugin-import-x@^4.3.1 \
globals@^15.10.0 \ globals@^15.10.0 \
"typescript@~5.5.4" \ typescript@~5.5.4 \
"typescript-eslint@^8.8.0" \ typescript-eslint@^8.8.0 \
eslint-config-conventions@latest eslint-config-conventions@latest
``` ```
@ -62,10 +62,12 @@ Dependencies are:
#### `eslint.config.js` (JavaScript and TypeScript) #### `eslint.config.js` (JavaScript and TypeScript)
```js ```js
import typescriptESLint from "typescript-eslint" // @ts-check
import eslintConfigConventions from "eslint-config-conventions"
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) #### Configuration with [Prettier](https://prettier.io/) (recommended)

2
eslint.config.js
View File

@ -1,3 +1,5 @@
// @ts-check
import promise from "eslint-plugin-promise" import promise from "eslint-plugin-promise"
import unicorn from "eslint-plugin-unicorn" import unicorn from "eslint-plugin-unicorn"
import importX from "eslint-plugin-import-x" import importX from "eslint-plugin-import-x"

4
eslint.config.mjs
View File

@ -1,8 +1,8 @@
// @ts-check // @ts-check
import typescriptESLint from "typescript-eslint" 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/*"], ignores: ["test/fixtures/*"],
}) })