Skip to content

Commit 2580563

Browse files
bmishG-Rath
andauthoredSep 10, 2022
fix: consistent rule doc notices and sections (#1226)
Co-authored-by: Gareth Jones <Jones258@Gmail.com>
1 parent 90cdc0c commit 2580563

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+659
-41
lines changed
 

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ installations requiring long-term consistency.
215215
| [no-focused-tests](docs/rules/no-focused-tests.md) | Disallow focused tests | ![recommended][] | ![suggest][] |
216216
| [no-hooks](docs/rules/no-hooks.md) | Disallow setup and teardown hooks | | |
217217
| [no-identical-title](docs/rules/no-identical-title.md) | Disallow identical titles | ![recommended][] | |
218+
| [no-if](docs/rules/no-if.md) | Disallow conditional logic | ![deprecated][] | |
218219
| [no-interpolation-in-snapshots](docs/rules/no-interpolation-in-snapshots.md) | Disallow string interpolation inside snapshots | ![recommended][] | |
219220
| [no-jasmine-globals](docs/rules/no-jasmine-globals.md) | Disallow Jasmine globals | ![recommended][] | ![fixable][] |
220221
| [no-large-snapshots](docs/rules/no-large-snapshots.md) | disallow large snapshots | | |
@@ -308,4 +309,5 @@ https://github.com/istanbuljs/eslint-plugin-istanbul
308309
[suggest]: https://img.shields.io/badge/-suggest-yellow.svg
309310
[fixable]: https://img.shields.io/badge/-fixable-green.svg
310311
[style]: https://img.shields.io/badge/-style-blue.svg
312+
[deprecated]: https://img.shields.io/badge/-deprecated-red.svg
311313
[`no-deprecated-functions`]: docs/rules/no-deprecated-functions.md

‎docs/rules/consistent-test-it.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
# Have control over `test` and `it` usages (`consistent-test-it`)
22

3+
💼 This rule is enabled in the following
4+
[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
5+
`all`.
6+
7+
🔧 This rule is automatically fixable using the `--fix`
8+
[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
9+
on the command line.
10+
11+
<!-- end rule header -->
12+
313
Jest allows you to choose how you want to define your tests, using the `it` or
414
the `test` keywords, with multiple permutations for each:
515

616
- **it:** `it`, `xit`, `fit`, `it.only`, `it.skip`.
717
- **test:** `test`, `xtest`, `test.only`, `test.skip`.
818

19+
## Rule details
20+
921
This rule gives you control over the usage of these keywords in your codebase.
1022

11-
## Rule Details
23+
## Options
1224

1325
This rule can be configured as follows
1426

0 commit comments

Comments
 (0)
Please sign in to comment.