@rightcapital/eslint-plugin 64.1.1-release.4966.1.0 → 64.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -0
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,5 +1,44 @@
|
|
|
1
1
|
# @rightcapital/eslint-plugin
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@rightcapital/eslint-plugin)
|
|
4
|
+
|
|
5
|
+
Custom ESLint rules used at RightCapital.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
pnpm add -D @rightcapital/eslint-plugin
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
> [!NOTE]
|
|
14
|
+
> If you use [`@rightcapital/eslint-config`](https://www.npmjs.com/package/@rightcapital/eslint-config), this plugin is already included — no separate installation needed.
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
If you're using `@rightcapital/eslint-config`, the plugin's recommended rules are enabled automatically. For manual configuration:
|
|
19
|
+
|
|
20
|
+
```js
|
|
21
|
+
import rightcapitalPlugin from '@rightcapital/eslint-plugin';
|
|
22
|
+
|
|
23
|
+
export default [
|
|
24
|
+
{
|
|
25
|
+
plugins: {
|
|
26
|
+
'@rightcapital': rightcapitalPlugin,
|
|
27
|
+
},
|
|
28
|
+
rules: {
|
|
29
|
+
'@rightcapital/jsx-no-unused-expressions': 'error',
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
];
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Configs
|
|
36
|
+
|
|
37
|
+
- `recommended-jsx` — recommended rules for JSX files.
|
|
38
|
+
- `recommended-react` — recommended rules for React files (includes `recommended-jsx`).
|
|
39
|
+
|
|
40
|
+
## Rules
|
|
41
|
+
|
|
3
42
|
<!-- begin auto-generated rules list -->
|
|
4
43
|
|
|
5
44
|
💼 Configurations enabled in.\
|
|
@@ -12,5 +51,10 @@
|
|
|
12
51
|
| [jsx-no-unused-expressions](src/rules/jsx-no-unused-expressions/jsx-no-unused-expressions.md) | Disallow unused JSX expressions | ☑️ ✅ | |
|
|
13
52
|
| [no-explicit-type-on-function-component-identifier](src/rules/no-explicit-type-on-function-component-identifier/no-explicit-type-on-function-component-identifier.md) | Disallow explicitly specifying type for function component identifier. (This rule requires `typescript-eslint`) | | 🔧 |
|
|
14
53
|
| [no-ignore-return-value-of-react-hooks](src/rules/no-ignore-return-value-of-react-hooks/no-ignore-return-value-of-react-hooks.md) | Disallow ignoring return value of React hooks. | ✅ | |
|
|
54
|
+
| [require-named-wrapped-component](src/rules/require-named-wrapped-component/require-named-wrapped-component.md) | Require wrapped components passed to HOCs to be named functions | | 🔧 |
|
|
15
55
|
|
|
16
56
|
<!-- end auto-generated rules list -->
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
[MIT License](./LICENSE) © 2023-Present
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rightcapital/eslint-plugin",
|
|
3
|
-
"version": "64.1.1
|
|
3
|
+
"version": "64.1.1",
|
|
4
4
|
"description": "ESLint plugin for RightCapital",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eslint",
|
|
@@ -27,11 +27,11 @@
|
|
|
27
27
|
"@typescript-eslint/rule-tester": "8.56.0",
|
|
28
28
|
"@vitest/coverage-v8": "4.0.16",
|
|
29
29
|
"@vitest/ui": "4.0.16",
|
|
30
|
-
"eslint": "10.0.
|
|
30
|
+
"eslint": "10.0.2",
|
|
31
31
|
"eslint-doc-generator": "3.1.0",
|
|
32
32
|
"typescript": "5.9.3",
|
|
33
33
|
"vitest": "4.0.16",
|
|
34
|
-
"@rightcapital/tsconfig": "1.2.
|
|
34
|
+
"@rightcapital/tsconfig": "1.2.18"
|
|
35
35
|
},
|
|
36
36
|
"peerDependencies": {
|
|
37
37
|
"eslint": "9.x || 10.x"
|
|
@@ -48,6 +48,6 @@
|
|
|
48
48
|
"clean": "tsc --build tsconfig.lib.json --clean",
|
|
49
49
|
"test": "vitest --coverage",
|
|
50
50
|
"test:ui": "vitest --ui",
|
|
51
|
-
"update:eslint-docs": "
|
|
51
|
+
"update:eslint-docs": "nx build && eslint-doc-generator && pnpm run -w fix:prettier"
|
|
52
52
|
}
|
|
53
53
|
}
|