@blumintinc/eslint-plugin-blumint 0.1.0 → 0.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 +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# eslint-plugin-blumint
|
|
1
|
+
# @blumintinc/eslint-plugin-blumint
|
|
2
2
|
|
|
3
3
|
Custom eslint rules for use at BluMint
|
|
4
4
|
|
|
@@ -10,20 +10,20 @@ You'll first need to install [ESLint](https://eslint.org/):
|
|
|
10
10
|
npm i eslint --save-dev
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Next, install
|
|
13
|
+
Next, install `@blumintinc/eslint-plugin-blumint`:
|
|
14
14
|
|
|
15
15
|
```sh
|
|
16
|
-
npm install eslint-plugin-blumint --save-dev
|
|
16
|
+
npm install @blumintinc/eslint-plugin-blumint --save-dev
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Usage
|
|
20
20
|
|
|
21
|
-
Add
|
|
21
|
+
Add `@blumintinc/blumint` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
|
|
22
22
|
|
|
23
23
|
```json
|
|
24
24
|
{
|
|
25
25
|
"plugins": [
|
|
26
|
-
"blumint"
|
|
26
|
+
"@blumintinc/blumint"
|
|
27
27
|
]
|
|
28
28
|
}
|
|
29
29
|
```
|
|
@@ -47,13 +47,13 @@ Then configure the rules you want to use under the rules section.
|
|
|
47
47
|
|
|
48
48
|
| Name | Description | 🔧 |
|
|
49
49
|
| :--------------------------------------------------------------------- | :---------------------------------------------------------------------------------------- | :- |
|
|
50
|
-
| [array-methods-this-context](docs/rules/array-methods-this-context.md) | Disallow async callbacks for Array.filter |
|
|
51
|
-
| [generic-starts-with-t](docs/rules/generic-starts-with-t.md) | Enforce TypeScript generic types to start with T |
|
|
52
|
-
| [no-async-array-filter](docs/rules/no-async-array-filter.md) | Disallow async callbacks for Array.filter |
|
|
53
|
-
| [no-filter-without-return](docs/rules/no-filter-without-return.md) | Disallow Array.filter callbacks without an explicit return (if part of a block statement) |
|
|
50
|
+
| [array-methods-this-context](docs/rules/array-methods-this-context.md) | Disallow async callbacks for Array.filter | |
|
|
51
|
+
| [generic-starts-with-t](docs/rules/generic-starts-with-t.md) | Enforce TypeScript generic types to start with T | |
|
|
52
|
+
| [no-async-array-filter](docs/rules/no-async-array-filter.md) | Disallow async callbacks for Array.filter | |
|
|
53
|
+
| [no-filter-without-return](docs/rules/no-filter-without-return.md) | Disallow Array.filter callbacks without an explicit return (if part of a block statement) | |
|
|
54
54
|
| [no-unpinned-dependencies](docs/rules/no-unpinned-dependencies.md) | Enforces pinned dependencies | 🔧 |
|
|
55
55
|
| [prefer-fragment-shorthand](docs/rules/prefer-fragment-shorthand.md) | Prefer <> shorthand for <React.Fragment> | 🔧 |
|
|
56
|
-
| [prefer-type-over-interface](docs/rules/prefer-type-over-interface.md) | Prefer using type alias over interface |
|
|
56
|
+
| [prefer-type-over-interface](docs/rules/prefer-type-over-interface.md) | Prefer using type alias over interface | |
|
|
57
57
|
|
|
58
58
|
<!-- end auto-generated rules list -->
|
|
59
59
|
|