Skip to content

Commit e53918b

Browse files
RebeccaStevensRebeccaStevens
committed
docs: fix eslint docs
1 parent cecd290 commit e53918b

21 files changed

+77
-55
lines changed

‎README.md

Lines changed: 49 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The [below section](#rules) gives details on which rules are enabled by each rul
9595
💼 Configurations enabled in.\
9696
⚠️ Configurations set to warn in.\
9797
🚫 Configurations disabled in.\
98-
🌐 Set in the `all` configuration.\
98+
☑️ Set in the `lite` configuration.\
9999
✅ Set in the `recommended` configuration.\
100100
🔒 Set in the `strict` configuration.\
101101
🎨 Set in the `stylistic` configuration.\
@@ -104,34 +104,60 @@ The [below section](#rules) gives details on which rules are enabled by each rul
104104
💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).\
105105
❌ Deprecated.
106106

107-
| Name                          | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
108-
| :--------------------------------------------------------------------------- | :------------------------------------------------------------------------ | :---------------------------------------------------- | :---- | :------------------------------------------------------------- | :- | :- | :- | :- |
109-
| [functional-parameters](docs/rules/functional-parameters.md) | Enforce functional parameters. | 🌐 ✅ 🔒 ![badge-currying][] ![badge-lite][] | | ![badge-off][] | | | | |
110-
| [immutable-data](docs/rules/immutable-data.md) | Enforce treating data as immutable. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-mutations][] | | ![badge-disable-type-checked][] ![badge-off][] | | | 💭 | |
111-
| [no-classes](docs/rules/no-classes.md) | Disallow classes. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-other-paradigms][] | | ![badge-off][] | | | | |
112-
| [no-conditional-statements](docs/rules/no-conditional-statements.md) | Disallow conditional statements. | 🌐 ✅ 🔒 ![badge-no-statements][] | | ![badge-disable-type-checked][] ![badge-lite][] ![badge-off][] | | | 💭 | |
113-
| [no-expression-statements](docs/rules/no-expression-statements.md) | Disallow expression statements. | 🌐 ✅ 🔒 ![badge-no-statements][] | | ![badge-disable-type-checked][] ![badge-lite][] ![badge-off][] | | | 💭 | |
114-
| [no-let](docs/rules/no-let.md) | Disallow mutable variables. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-mutations][] | | ![badge-off][] | | | | |
115-
| [no-loop-statements](docs/rules/no-loop-statements.md) | Disallow imperative loops. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-statements][] | | ![badge-off][] | | | | |
116-
| [no-mixed-types](docs/rules/no-mixed-types.md) | Restrict types so that only members of the same kind are allowed in them. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-other-paradigms][] | | ![badge-disable-type-checked][] ![badge-off][] | | | 💭 | |
117-
| [no-promise-reject](docs/rules/no-promise-reject.md) | Disallow rejecting promises. | 🌐 | | ![badge-off][] | | | | |
118-
| [no-return-void](docs/rules/no-return-void.md) | Disallow functions that don't return anything. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-statements][] | | ![badge-disable-type-checked][] ![badge-off][] | | | 💭 | |
119-
| [no-this-expressions](docs/rules/no-this-expressions.md) | Disallow this access. | 🌐 🔒 ![badge-no-other-paradigms][] | | ✅ ![badge-lite][] ![badge-off][] | | | | |
120-
| [no-throw-statements](docs/rules/no-throw-statements.md) | Disallow throwing exceptions. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-exceptions][] | | ![badge-off][] | | | | |
121-
| [no-try-statements](docs/rules/no-try-statements.md) | Disallow try-catch[-finally] and try-finally patterns. | 🌐 🔒 ![badge-no-exceptions][] | | ✅ ![badge-lite][] ![badge-off][] | | | | |
122-
| [prefer-immutable-types](docs/rules/prefer-immutable-types.md) | Require function parameters to be typed as certain immutability | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-mutations][] | | ![badge-disable-type-checked][] ![badge-off][] | 🔧 | 💡 | 💭 | |
123-
| [prefer-property-signatures](docs/rules/prefer-property-signatures.md) | Prefer property signatures over method signatures. | 🌐 🎨 | | ![badge-disable-type-checked][] ![badge-off][] | | | 💭 | |
124-
| [prefer-readonly-type](docs/rules/prefer-readonly-type.md) | Prefer readonly types over mutable types. | | | ![badge-disable-type-checked][] ![badge-off][] | 🔧 | | 💭 | ❌ |
125-
| [prefer-tacit](docs/rules/prefer-tacit.md) | Replaces `x => f(x)` with just `f`. | | 🌐 🎨 | ![badge-disable-type-checked][] ![badge-off][] | | 💡 | 💭 | |
126-
| [readonly-type](docs/rules/readonly-type.md) | Require consistently using either `readonly` keywords or `Readonly<T>` | 🌐 🎨 | | ![badge-disable-type-checked][] ![badge-off][] | 🔧 | | 💭 | |
127-
| [type-declaration-immutability](docs/rules/type-declaration-immutability.md) | Enforce the immutability of types based on patterns. | 🌐 ✅ 🔒 ![badge-lite][] ![badge-no-mutations][] | | ![badge-disable-type-checked][] ![badge-off][] | 🔧 | | 💭 | |
107+
### Currying
108+
109+
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
110+
| :----------------------------------------------------------- | :----------------------------- | :-------------------------- | :- | :- | :- | :- | :- | :- |
111+
| [functional-parameters](docs/rules/functional-parameters.md) | Enforce functional parameters. | ☑️ ✅ 🔒 ![badge-currying][] | | | | | | |
112+
113+
### No Exceptions
114+
115+
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
116+
| :------------------------------------------------------- | :----------------------------------------------------- | :------------------------------- | :- | :--- | :- | :- | :- | :- |
117+
| [no-promise-reject](docs/rules/no-promise-reject.md) | Disallow rejecting promises. | | | | | | | |
118+
| [no-throw-statements](docs/rules/no-throw-statements.md) | Disallow throwing exceptions. | ☑️ ✅ 🔒 ![badge-no-exceptions][] | | | | | | |
119+
| [no-try-statements](docs/rules/no-try-statements.md) | Disallow try-catch[-finally] and try-finally patterns. | 🔒 ![badge-no-exceptions][] | | ☑️ ✅ | | | | |
120+
121+
### No Mutations
122+
123+
| Name                          | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
124+
| :--------------------------------------------------------------------------- | :-------------------------------------------------------------- | :------------------------------ | :- | :- | :- | :- | :- | :- |
125+
| [immutable-data](docs/rules/immutable-data.md) | Enforce treating data as immutable. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | | | 💭 | |
126+
| [no-let](docs/rules/no-let.md) | Disallow mutable variables. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | | | | |
127+
| [prefer-immutable-types](docs/rules/prefer-immutable-types.md) | Require function parameters to be typed as certain immutability | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | 🔧 | 💡 | 💭 | |
128+
| [prefer-readonly-type](docs/rules/prefer-readonly-type.md) | Prefer readonly types over mutable types. | | | | 🔧 | | 💭 | ❌ |
129+
| [type-declaration-immutability](docs/rules/type-declaration-immutability.md) | Enforce the immutability of types based on patterns. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | 🔧 | | 💭 | |
130+
131+
### No Other Paradigms
132+
133+
| Name                | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
134+
| :------------------------------------------------------- | :------------------------------------------------------------------------ | :------------------------------------ | :- | :--- | :- | :- | :- | :- |
135+
| [no-classes](docs/rules/no-classes.md) | Disallow classes. | ☑️ ✅ 🔒 ![badge-no-other-paradigms][] | | | | | | |
136+
| [no-mixed-types](docs/rules/no-mixed-types.md) | Restrict types so that only members of the same kind are allowed in them. | ☑️ ✅ 🔒 ![badge-no-other-paradigms][] | | | | | 💭 | |
137+
| [no-this-expressions](docs/rules/no-this-expressions.md) | Disallow this access. | 🔒 ![badge-no-other-paradigms][] | | ☑️ ✅ | | | | |
138+
139+
### No Statements
140+
141+
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
142+
| :------------------------------------------------------------------- | :--------------------------------------------- | :------------------------------- | :- | :- | :- | :- | :- | :- |
143+
| [no-conditional-statements](docs/rules/no-conditional-statements.md) | Disallow conditional statements. | ✅ 🔒 ![badge-no-statements][] | | ☑️ | | | 💭 | |
144+
| [no-expression-statements](docs/rules/no-expression-statements.md) | Disallow expression statements. | ✅ 🔒 ![badge-no-statements][] | | ☑️ | | | 💭 | |
145+
| [no-loop-statements](docs/rules/no-loop-statements.md) | Disallow imperative loops. | ☑️ ✅ 🔒 ![badge-no-statements][] | | | | | | |
146+
| [no-return-void](docs/rules/no-return-void.md) | Disallow functions that don't return anything. | ☑️ ✅ 🔒 ![badge-no-statements][] | | | | | 💭 | |
147+
148+
### Stylistic
149+
150+
| Name                       | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
151+
| :--------------------------------------------------------------------- | :--------------------------------------------------------------------- | :- | :- | :- | :- | :- | :- | :- |
152+
| [prefer-property-signatures](docs/rules/prefer-property-signatures.md) | Prefer property signatures over method signatures. | 🎨 | | | | | 💭 | |
153+
| [prefer-tacit](docs/rules/prefer-tacit.md) | Replaces `x => f(x)` with just `f`. | | 🎨 | | | 💡 | 💭 | |
154+
| [readonly-type](docs/rules/readonly-type.md) | Require consistently using either `readonly` keywords or `Readonly<T>` | 🎨 | | | 🔧 | | 💭 | |
128155

129156
<!-- end auto-generated rules list -->
130157
<!-- markdownlint-restore -->
131158
<!-- prettier-ignore-end -->
132159

133160
[badge-currying]: https://img.shields.io/badge/-currying-red.svg
134-
[badge-lite]: https://img.shields.io/badge/-lite-green.svg
135161
[badge-no-exceptions]: https://img.shields.io/badge/-no--exceptions-blue.svg
136162
[badge-no-mutations]: https://img.shields.io/badge/-no--mutations-orange.svg
137163
[badge-no-other-paradigms]: https://img.shields.io/badge/-no--other--paradigms-yellow.svg

‎docs/rules/functional-parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Enforce functional parameters (`functional/functional-parameters`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `currying`, `lite`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `off` config.
3+
💼 This rule is enabled in the following configs: `currying`, ☑️ `lite`, ✅ `recommended`, 🔒 `strict`.
44

55
<!-- end auto-generated rule header -->
66

‎docs/rules/immutable-data.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Enforce treating data as immutable (`functional/immutable-data`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `lite`, `no-mutations`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the following configs: `disable-type-checked`, `off`.
3+
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-mutations`, ✅ `recommended`, 🔒 `strict`.
44

55
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
66

@@ -132,28 +132,28 @@ For example:
132132
```jsonc
133133
{
134134
// Ignore all reassigning to object properties that are prefixed with "mutable_".
135-
"ignoreAccessorPattern": "**.mutable_*"
135+
"ignoreAccessorPattern": "**.mutable_*",
136136
}
137137
```
138138

139139
```jsonc
140140
{
141141
// Ignore all shallow mutations made to object properties that are prefixed with "mutable_".
142-
"ignoreAccessorPattern": "**.mutable_*.*"
142+
"ignoreAccessorPattern": "**.mutable_*.*",
143143
}
144144
```
145145

146146
```jsonc
147147
{
148148
// Ignore all deep mutations made to object properties that are prefixed with "mutable_".
149-
"ignoreAccessorPattern": "**.mutable_*.*.**"
149+
"ignoreAccessorPattern": "**.mutable_*.*.**",
150150
}
151151
```
152152

153153
```jsonc
154154
{
155155
// Ignore all deep mutations and reassigning to object properties that are prefixed with "mutable_".
156-
"ignoreAccessorPattern": "**.mutable_*.**"
156+
"ignoreAccessorPattern": "**.mutable_*.**",
157157
// This is the same as `"ignoreAccessorPattern": ["**.mutable_*", "**.mutable_*.*.**"]`
158158
}
159159
```

‎docs/rules/no-classes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow classes (`functional/no-classes`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `lite`, `no-other-paradigms`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `off` config.
3+
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-other-paradigms`, ✅ `recommended`, 🔒 `strict`.
44

55
<!-- end auto-generated rule header -->
66

‎docs/rules/no-conditional-statements.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow conditional statements (`functional/no-conditional-statements`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the following configs: `disable-type-checked`, `lite`, `off`.
3+
💼🚫 This rule is enabled in the following configs: `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the ☑️ `lite` config.
44

55
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
66

@@ -45,8 +45,8 @@ function foo(x, y) {
4545
return x === y // if
4646
? 0
4747
: x > y // else if
48-
? 1
49-
: -1; // else
48+
? 1
49+
: -1; // else
5050
}
5151
```
5252

‎docs/rules/no-expression-statements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow expression statements (`functional/no-expression-statements`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the following configs: `disable-type-checked`, `lite`, `off`.
3+
💼🚫 This rule is enabled in the following configs: `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the ☑️ `lite` config.
44

55
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
66

‎docs/rules/no-let.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow mutable variables (`functional/no-let`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `lite`, `no-mutations`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `off` config.
3+
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-mutations`, ✅ `recommended`, 🔒 `strict`.
44

55
<!-- end auto-generated rule header -->
66

‎docs/rules/no-loop-statements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow imperative loops (`functional/no-loop-statements`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `lite`, `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `off` config.
3+
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-statements`, ✅ `recommended`, 🔒 `strict`.
44

55
<!-- end auto-generated rule header -->
66

‎docs/rules/no-mixed-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Restrict types so that only members of the same kind are allowed in them (`functional/no-mixed-types`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `lite`, `no-other-paradigms`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the following configs: `disable-type-checked`, `off`.
3+
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-other-paradigms`, ✅ `recommended`, 🔒 `strict`.
44

55
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
66

‎docs/rules/no-promise-reject.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Disallow rejecting promises (`functional/no-promise-reject`)
22

3-
💼🚫 This rule is enabled in the 🌐 `all` config. This rule is _disabled_ in the `off` config.
4-
53
<!-- end auto-generated rule header -->
64

75
This rule disallows use of `Promise.reject()`.

‎docs/rules/no-return-void.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow functions that don't return anything (`functional/no-return-void`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `lite`, `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the following configs: `disable-type-checked`, `off`.
3+
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-statements`, ✅ `recommended`, 🔒 `strict`.
44

55
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
66

‎docs/rules/no-this-expressions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow this access (`functional/no-this-expressions`)
22

3-
💼🚫 This rule is enabled in the following configs: 🌐 `all`, `no-other-paradigms`, 🔒 `strict`. This rule is _disabled_ in the following configs: `lite`, `off`, ✅ `recommended`.
3+
💼🚫 This rule is enabled in the following configs: `no-other-paradigms`, 🔒 `strict`. This rule is _disabled_ in the following configs: ☑️ `lite`, ✅ `recommended`.
44

55
<!-- end auto-generated rule header -->
66

0 commit comments

Comments
 (0)