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

theoludwig · Oct 8, 2024 · a578bb8 · a578bb8
1 parent e32847f
commit a578bb8
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/README.md b/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
+// @ts-check
+
 import typescriptESLint from "typescript-eslint"
-import eslintConfigConventions from "eslint-config-conventions"
+import configConventions from "eslint-config-conventions"
 
-export default typescriptESLint.config(...eslintConfigConventions)
+export default typescriptESLint.config(...configConventions)
 ```
 
 #### Configuration with [Prettier](https://prettier.io/) (recommended)

diff --git a/eslint.config.js b/eslint.config.js
@@ -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"

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -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/*"],
 })