Skip to content

Commit 54264e5

Browse files
committed
docs: add "See Also" sections to naming convention rules
1 parent faa9377 commit 54264e5

File tree

5 files changed

+22
-2
lines changed

5 files changed

+22
-2
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,8 @@ function MyComponent() {
7777

7878
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/component-name.ts)
7979
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/component-name.spec.ts)
80+
81+
## See Also
82+
83+
- [`context-name`](./naming-convention-context-name)\
84+
Enforces naming conventions for context providers.

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,8 @@ const ThemeContext = createContext({});
4040

4141
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/context-name.ts)
4242
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/context-name.spec.ts)
43+
44+
## See Also
45+
46+
- [`component-name`](./naming-convention-component-name)\
47+
Enforces naming conventions for components.

packages/plugins/eslint-plugin-react-naming-convention/src/rules/context-name.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ export default createRule<[], MessageID>({
1919
meta: {
2020
type: "problem",
2121
docs: {
22-
description: "enforce context name to end with `Context`.",
22+
description: "enforce context name to end with 'Context'",
2323
},
2424
messages: {
25-
contextName: "Context name must end with `Context`.",
25+
contextName: "Context name must end with 'Context'.",
2626
},
2727
schema: [],
2828
},

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,8 @@ export default [
9292
9393
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename-extension.ts)
9494
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename-extension.spec.ts)
95+
96+
## See Also
97+
98+
- [`filename`](./naming-convention-filename)\
99+
Enforces consistent file naming conventions.

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,3 +129,8 @@ export default [
129129
130130
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename.ts)
131131
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename.spec.ts)
132+
133+
## See Also
134+
135+
- [`filename-extension`](./filename-extension):
136+
Enforces consistent use of the JSX file extension.

0 commit comments

Comments
 (0)