Skip to content

Commit 4cc60f8

Browse files
authored
docs: fix JSDoc annotation for ESLint flat configs of basic example (#10089)
### Description This is a very minor change I noticed when copying the basic example. The JSDoc annotation for the ESLint flat configs is incorrect, indicating a config object instead of an array of config objects, which prevents the IDE from providing proper autocomplete. ### Testing Instructions The IDE autocomplete feature allows to very quickly validate the change.
1 parent 726785f commit 4cc60f8

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

examples/basic/packages/eslint-config/base.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import onlyWarn from "eslint-plugin-only-warn";
77
/**
88
* A shared ESLint configuration for the repository.
99
*
10-
* @type {import("eslint").Linter.Config}
10+
* @type {import("eslint").Linter.Config[]}
1111
* */
1212
export const config = [
1313
js.configs.recommended,

examples/basic/packages/eslint-config/next.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { config as baseConfig } from "./base.js";
1010
/**
1111
* A custom ESLint configuration for libraries that use Next.js.
1212
*
13-
* @type {import("eslint").Linter.Config}
13+
* @type {import("eslint").Linter.Config[]}
1414
* */
1515
export const nextJsConfig = [
1616
...baseConfig,

examples/basic/packages/eslint-config/react-internal.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { config as baseConfig } from "./base.js";
99
/**
1010
* A custom ESLint configuration for libraries that use React.
1111
*
12-
* @type {import("eslint").Linter.Config} */
12+
* @type {import("eslint").Linter.Config[]} */
1313
export const config = [
1414
...baseConfig,
1515
js.configs.recommended,

0 commit comments

Comments
 (0)