Skip to content

Commit 6f322b9

Browse files
RebeccaStevensRebeccaStevens
committed
docs: mark which rules require type checking
1 parent 7ae6205 commit 6f322b9

23 files changed

+77
-41
lines changed

‎README.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -95,56 +95,57 @@ The [below section](#rules) gives details on which rules are enabled by each rul
9595
🎨 Set in the `stylistic` configuration.\
9696
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
9797
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
98+
💭 Requires type information.\
9899
❌ Deprecated.
99100

100101
### Currying
101102

102-
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
103-
| :----------------------------------------------------------- | :----------------------------- | :--------------------------- | :-- | :-- | :-- | :-- | :-- |
104-
| [functional-parameters](docs/rules/functional-parameters.md) | Enforce functional parameters. | ☑️ ✅ 🔒 ![badge-currying][] | | | | | |
103+
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
104+
| :----------------------------------------------------------- | :----------------------------- | :--------------------------- | :-- | :-- | :-- | :-- | :-- | :-- |
105+
| [functional-parameters](docs/rules/functional-parameters.md) | Enforce functional parameters. | ☑️ ✅ 🔒 ![badge-currying][] | | | | | | |
105106

106107
### No Exceptions
107108

108-
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
109-
| :------------------------------------------------------- | :----------------------------------------------------- | :-------------------------------- | :-- | :---- | :-- | :-- | :-- |
110-
| [no-promise-reject](docs/rules/no-promise-reject.md) | Disallow try-catch[-finally] and try-finally patterns. | | | | | | |
111-
| [no-throw-statements](docs/rules/no-throw-statements.md) | Disallow throwing exceptions. | ☑️ ✅ 🔒 ![badge-no-exceptions][] | | | | | |
112-
| [no-try-statements](docs/rules/no-try-statements.md) | Disallow try-catch[-finally] and try-finally patterns. | 🔒 ![badge-no-exceptions][] | | ☑️ ✅ | | | |
109+
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
110+
| :------------------------------------------------------- | :----------------------------------------------------- | :-------------------------------- | :-- | :---- | :-- | :-- | :-- | :-- |
111+
| [no-promise-reject](docs/rules/no-promise-reject.md) | Disallow try-catch[-finally] and try-finally patterns. | | | | | | | |
112+
| [no-throw-statements](docs/rules/no-throw-statements.md) | Disallow throwing exceptions. | ☑️ ✅ 🔒 ![badge-no-exceptions][] | | | | | | |
113+
| [no-try-statements](docs/rules/no-try-statements.md) | Disallow try-catch[-finally] and try-finally patterns. | 🔒 ![badge-no-exceptions][] | | ☑️ ✅ | | | | |
113114

114115
### No Mutations
115116

116-
| Name                          | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
117-
| :--------------------------------------------------------------------------- | :-------------------------------------------------------------- | :------------------------------- | :-- | :-- | :-- | :-- | :-- |
118-
| [immutable-data](docs/rules/immutable-data.md) | Enforce treating data as immutable. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | | | |
119-
| [no-let](docs/rules/no-let.md) | Disallow mutable variables. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | | | |
120-
| [prefer-immutable-types](docs/rules/prefer-immutable-types.md) | Require function parameters to be typed as certain immutability | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | 🔧 | 💡 | |
121-
| [prefer-readonly-type](docs/rules/prefer-readonly-type.md) | Prefer readonly types over mutable types. | | | | 🔧 | | ❌ |
122-
| [type-declaration-immutability](docs/rules/type-declaration-immutability.md) | Enforce the immutability of types based on patterns. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | 🔧 | | |
117+
| Name                          | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
118+
| :--------------------------------------------------------------------------- | :-------------------------------------------------------------- | :------------------------------- | :-- | :------------------------------ | :-- | :-- | :-- | :-- |
119+
| [immutable-data](docs/rules/immutable-data.md) | Enforce treating data as immutable. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | ![badge-disable-type-checked][] | | | 💭 | |
120+
| [no-let](docs/rules/no-let.md) | Disallow mutable variables. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | | | | | |
121+
| [prefer-immutable-types](docs/rules/prefer-immutable-types.md) | Require function parameters to be typed as certain immutability | ☑️ ✅ 🔒 ![badge-no-mutations][] | | ![badge-disable-type-checked][] | 🔧 | 💡 | 💭 | |
122+
| [prefer-readonly-type](docs/rules/prefer-readonly-type.md) | Prefer readonly types over mutable types. | | | ![badge-disable-type-checked][] | 🔧 | | 💭 | ❌ |
123+
| [type-declaration-immutability](docs/rules/type-declaration-immutability.md) | Enforce the immutability of types based on patterns. | ☑️ ✅ 🔒 ![badge-no-mutations][] | | ![badge-disable-type-checked][] | 🔧 | | 💭 | |
123124

124125
### No Other Paradigms
125126

126-
| Name                | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
127-
| :------------------------------------------------------- | :------------------------------------------------------------------------ | :------------------------------------- | :-- | :---- | :-- | :-- | :-- |
128-
| [no-classes](docs/rules/no-classes.md) | Disallow classes. | ☑️ ✅ 🔒 ![badge-no-other-paradigms][] | | | | | |
129-
| [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][] | | | | | |
130-
| [no-this-expressions](docs/rules/no-this-expressions.md) | Disallow this access. | 🔒 ![badge-no-other-paradigms][] | | ☑️ ✅ | | | |
127+
| Name                | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
128+
| :------------------------------------------------------- | :------------------------------------------------------------------------ | :------------------------------------- | :-- | :------------------------------ | :-- | :-- | :-- | :-- |
129+
| [no-classes](docs/rules/no-classes.md) | Disallow classes. | ☑️ ✅ 🔒 ![badge-no-other-paradigms][] | | | | | | |
130+
| [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][] | | ![badge-disable-type-checked][] | | | 💭 | |
131+
| [no-this-expressions](docs/rules/no-this-expressions.md) | Disallow this access. | 🔒 ![badge-no-other-paradigms][] | | ☑️ ✅ | | | | |
131132

132133
### No Statements
133134

134-
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
135-
| :------------------------------------------------------------------- | :--------------------------------------------- | :-------------------------------- | :-- | :-- | :-- | :-- | :-- |
136-
| [no-conditional-statements](docs/rules/no-conditional-statements.md) | Disallow conditional statements. | ✅ 🔒 ![badge-no-statements][] | | ☑️ | | | |
137-
| [no-expression-statements](docs/rules/no-expression-statements.md) | Disallow expression statements. | ✅ 🔒 ![badge-no-statements][] | | ☑️ | | | |
138-
| [no-loop-statements](docs/rules/no-loop-statements.md) | Disallow imperative loops. | ☑️ ✅ 🔒 ![badge-no-statements][] | | | | | |
139-
| [no-return-void](docs/rules/no-return-void.md) | Disallow functions that don't return anything. | ☑️ ✅ 🔒 ![badge-no-statements][] | | | | | |
135+
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
136+
| :------------------------------------------------------------------- | :--------------------------------------------- | :-------------------------------- | :-- | :--------------------------------- | :-- | :-- | :-- | :-- |
137+
| [no-conditional-statements](docs/rules/no-conditional-statements.md) | Disallow conditional statements. | ✅ 🔒 ![badge-no-statements][] | | ☑️ ![badge-disable-type-checked][] | | | 💭 | |
138+
| [no-expression-statements](docs/rules/no-expression-statements.md) | Disallow expression statements. | ✅ 🔒 ![badge-no-statements][] | | ☑️ ![badge-disable-type-checked][] | | | 💭 | |
139+
| [no-loop-statements](docs/rules/no-loop-statements.md) | Disallow imperative loops. | ☑️ ✅ 🔒 ![badge-no-statements][] | | | | | | |
140+
| [no-return-void](docs/rules/no-return-void.md) | Disallow functions that don't return anything. | ☑️ ✅ 🔒 ![badge-no-statements][] | | ![badge-disable-type-checked][] | | | 💭 | |
140141

141142
### Stylistic
142143

143-
| Name                       | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌ |
144-
| :--------------------------------------------------------------------- | :--------------------------------------------------------------------- | :-- | :-- | :-- | :-- | :-- | :-- |
145-
| [prefer-property-signatures](docs/rules/prefer-property-signatures.md) | Prefer property signatures over method signatures. | 🎨 | | | | | |
146-
| [prefer-tacit](docs/rules/prefer-tacit.md) | Replaces `x => f(x)` with just `f`. | | 🎨 | | | 💡 | |
147-
| [readonly-type](docs/rules/readonly-type.md) | Require consistently using either `readonly` keywords or `Readonly<T>` | 🎨 | | | 🔧 | | |
144+
| Name                       | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 | ❌ |
145+
| :--------------------------------------------------------------------- | :--------------------------------------------------------------------- | :-- | :-- | :------------------------------ | :-- | :-- | :-- | :-- |
146+
| [prefer-property-signatures](docs/rules/prefer-property-signatures.md) | Prefer property signatures over method signatures. | 🎨 | | ![badge-disable-type-checked][] | | | 💭 | |
147+
| [prefer-tacit](docs/rules/prefer-tacit.md) | Replaces `x => f(x)` with just `f`. | | 🎨 | ![badge-disable-type-checked][] | | 💡 | 💭 | |
148+
| [readonly-type](docs/rules/readonly-type.md) | Require consistently using either `readonly` keywords or `Readonly<T>` | 🎨 | | ![badge-disable-type-checked][] | 🔧 | | 💭 | |
148149

149150
<!-- end auto-generated rules list -->
150151

‎docs/rules/immutable-data.md

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

3-
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-mutations`, ✅ `recommended`, 🔒 `strict`.
3+
💼🚫 This rule is enabled in the following configs: ☑️ `lite`, `no-mutations`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `disable-type-checked` config.
4+
5+
💭 This rule requires type information.
46

57
<!-- end auto-generated rule header -->
68

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

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

3-
💼🚫 This rule is enabled in the following configs: `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the ☑️ `lite` config.
3+
💼🚫 This rule is enabled in the following configs: `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the following configs: `disable-type-checked`, ☑️ `lite`.
4+
5+
💭 This rule requires type information.
46

57
<!-- end auto-generated rule header -->
68

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

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

3-
💼🚫 This rule is enabled in the following configs: `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the ☑️ `lite` config.
3+
💼🚫 This rule is enabled in the following configs: `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the following configs: `disable-type-checked`, ☑️ `lite`.
4+
5+
💭 This rule requires type information.
46

57
<!-- end auto-generated rule header -->
68

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
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: ☑️ `lite`, `no-other-paradigms`, ✅ `recommended`, 🔒 `strict`.
3+
💼🚫 This rule is enabled in the following configs: ☑️ `lite`, `no-other-paradigms`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `disable-type-checked` config.
4+
5+
💭 This rule requires type information.
46

57
<!-- end auto-generated rule header -->
68

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

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

3-
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-statements`, ✅ `recommended`, 🔒 `strict`.
3+
💼🚫 This rule is enabled in the following configs: ☑️ `lite`, `no-statements`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `disable-type-checked` config.
4+
5+
💭 This rule requires type information.
46

57
<!-- end auto-generated rule header -->
68

‎docs/rules/prefer-immutable-types.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Require function parameters to be typed as certain immutability (`functional/prefer-immutable-types`)
22

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

55
🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
66

7+
💭 This rule requires type information.
8+
79
<!-- end auto-generated rule header -->
810

911
## Rule Details

‎docs/rules/prefer-property-signatures.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Prefer property signatures over method signatures (`functional/prefer-property-signatures`)
22

3-
💼 This rule is enabled in the 🎨 `stylistic` config.
3+
💼🚫 This rule is enabled in the 🎨 `stylistic` config. This rule is _disabled_ in the `disable-type-checked` config.
4+
5+
💭 This rule requires type information.
46

57
<!-- end auto-generated rule header -->
68

‎docs/rules/prefer-readonly-type.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
❌ This rule is deprecated. It was replaced by [`functional/prefer-immutable-types`](prefer-immutable-types.md),[`functional/type-declaration-immutability`](type-declaration-immutability.md).
44

5+
🚫 This rule is _disabled_ in the `disable-type-checked` config.
6+
57
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
68

9+
💭 This rule requires type information.
10+
711
<!-- end auto-generated rule header -->
812

913
This rule has been replaced by

‎docs/rules/prefer-tacit.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Replaces `x => f(x)` with just `f` (`functional/prefer-tacit`)
22

3-
⚠️ This rule _warns_ in the 🎨 `stylistic` config.
3+
⚠️🚫 This rule _warns_ in the 🎨 `stylistic` config. This rule is _disabled_ in the `disable-type-checked` config.
44

55
💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
66

7+
💭 This rule requires type information.
8+
79
<!-- end auto-generated rule header -->
810

911
This rule enforces using functions directly if they can be without wrapping them.

‎docs/rules/readonly-type.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Require consistently using either `readonly` keywords or `Readonly<T>` (`functional/readonly-type`)
22

3-
💼 This rule is enabled in the 🎨 `stylistic` config.
3+
💼🚫 This rule is enabled in the 🎨 `stylistic` config. This rule is _disabled_ in the `disable-type-checked` config.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

7+
💭 This rule requires type information.
8+
79
<!-- end auto-generated rule header -->
810

911
This rule enforces consistently using either `readonly` keywords or `Readonly<T>`.

‎docs/rules/type-declaration-immutability.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Enforce the immutability of types based on patterns (`functional/type-declaration-immutability`)
22

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

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

7+
💭 This rule requires type information.
8+
79
<!-- end auto-generated rule header -->
810

911
Require type alias declarations and interfaces that imply some level of

0 commit comments

Comments
 (0)