Skip to content

Commit 58888be

Browse files
committed
docs: improve format
1 parent c4367b1 commit 58888be

File tree

4 files changed

+13
-16
lines changed

4 files changed

+13
-16
lines changed

packages/plugins/eslint-plugin-naming-convention/src/rules/component-name.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ export const MyComponent = () => {
3535
## Rule Options
3636

3737
- `rule`: The rule to apply to the file name. Can be one of the following:
38-
- `PascalCase`: PascalCase
39-
- `CONSTANT_CASE`: CONSTANT_CASE
38+
1. `PascalCase`: PascalCase
39+
2. `CONSTANT_CASE`: CONSTANT_CASE
4040
- `excepts`: List of component names that should be ignored by this rule.
4141

4242
```json

packages/plugins/eslint-plugin-naming-convention/src/rules/filename-extension.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ This rule enforces consistent file extensions for JSX files.
1515
## Rule Options
1616

1717
- `allow`: When to allow a JSX filename extension.
18-
- `"always"`: (default) allow all file use JSX file extension.
19-
- `"as-needed"`: allow JSX file extension only if the file contains JSX syntax.
18+
1. `"always"`: (default) allow all file use JSX file extension.
19+
2. `"as-needed"`: allow JSX file extension only if the file contains JSX syntax.
2020
- `extensions`: List of file extensions that should be checked by this rule. By default, it checks `.jsx`, `.tsx` files.
2121

2222
```json

packages/plugins/eslint-plugin-naming-convention/src/rules/filename.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ src/components/example-component.tsx
5858
## Rule Options
5959

6060
- `rule`: The rule to apply to the file name. Can be one of the following:
61-
- `PascalCase`: PascalCase
62-
- `camelCase`: camelCase
63-
- `kebab-case`: kebab-case
64-
- `snake_case`: snake_case
61+
1. `PascalCase`: PascalCase
62+
2. `camelCase`: camelCase
63+
3. `kebab-case`: kebab-case
64+
4. `snake_case`: snake_case
6565
- `excepts`: List of file names that should be ignored by this rule.
6666
- `extensions`: List of file extensions that should be checked by this rule. By default, it checks `.jsx`, `.tsx` files.
6767

website/pages/docs/configuration.mdx

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,11 @@ import { Config, ESLintConfig } from "#/components/eslint-config";
1010

1111
You can configure `@eslint-react/eslint-plugin` by adding a `eslintReact` property to the `settings` field of your ESLint configuration.
1212

13-
- `jsx`
14-
- `pragma` - Pragma to use, default to `"React"`.
15-
- `fragment` - Fragment to use, default to `"Fragment"`.
16-
- `extensions` - An Array of file extensions to be considered as JSX, default to `[".jsx", ".tsx"]`.
17-
- `react`
18-
- `version` - React version to use, default to `"detect"`.
19-
- `reactHooks`
20-
- `alias` - An object of alias of React's built-in Hooks, ESLint React will treat them as same as the built-in Hooks, default to `{}`. (e.g. `{ useState: ["useLocalStorageState"] }`)
13+
- `jsx.pragma` - Pragma to use, default to `"React"`.
14+
- `jsx.fragment` - Fragment to use, default to `"Fragment"`.
15+
- `jsx.extensions` - An Array of file extensions to be considered as JSX, default to `[".jsx", ".tsx"]`.
16+
- `react.version` - React version to use, default to `"detect"`.
17+
- `reactHooks.alias` - An object of alias of React's built-in Hooks, ESLint React will treat them as same as the built-in Hooks, default to `{}`. (e.g. `{ useState: ["useLocalStorageState"] }`)
2118

2219
## Example
2320

0 commit comments

Comments
 (0)