chore(valid-title): update documentation

jest-community · Oct 26, 2019 · 81b1504 · 81b1504
1 parent 42d2b7f
commit 81b1504
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -117,7 +117,6 @@ installations requiring long-term consistency.
 | [no-commented-out-tests][]     | Disallow commented out tests                                      |                  |                     |
 | [no-disabled-tests][]          | Disallow disabled tests                                           | ![recommended][] |                     |
 | [no-duplicate-hooks][]         | Disallow duplicate hooks within a `describe` block                |                  |                     |
-| [no-empty-title][]             | Disallow empty titles                                             |                  |                     |
 | [no-expect-resolves][]         | Disallow using `expect().resolves`                                |                  |                     |
 | [no-export][]                  | Disallow export from test files                                   |                  |                     |
 | [no-focused-tests][]           | Disallow focused tests                                            | ![recommended][] |                     |
@@ -150,7 +149,7 @@ installations requiring long-term consistency.
 | [valid-describe][]             | Enforce valid `describe()` callback                               | ![recommended][] |                     |
 | [valid-expect-in-promise][]    | Enforce having return statement when testing with promises        | ![recommended][] |                     |
 | [valid-expect][]               | Enforce valid `expect()` usage                                    | ![recommended][] |                     |
-| [valid-title][]                | Disallow invalid `describe`/`test` titles                         |                  |                     |
+| [valid-title][]                | Enforce valid titles for jest blocks                              |                  |                     |
 
 ## Credit
 
@@ -173,7 +172,6 @@ https://github.com/dangreenisrael/eslint-plugin-jest-formatting
 [no-commented-out-tests]: docs/rules/no-commented-out-tests.md
 [no-disabled-tests]: docs/rules/no-disabled-tests.md
 [no-duplicate-hooks]: docs/rules/no-duplicate-hooks.md
-[no-empty-title]: docs/rules/no-empty-title.md
 [no-expect-resolves]: docs/rules/no-expect-resolves.md
 [no-export]: docs/rules/no-export.md
 [no-focused-tests]: docs/rules/no-focused-tests.md

diff --git a/docs/rules/no-empty-title.md b/docs/rules/no-empty-title.md
diff --git a/docs/rules/valid-title.md b/docs/rules/valid-title.md
@@ -1,9 +1,45 @@
 # describe/test titles should be valid (valid-title)
 
-A describe/ test block should not contain accidentalSpace or duplicatePrefix.
+Checks that the title of Jest blocks are valid by ensuring that titles are:
+
+- not empty,
+- not prefixed with their block name
+- have no leading or trailing spaces
 
 ## Rule Details
 
+**emptyTitle**
+
+An empty title is not informative, and serves little purpose.
+
+Examples of **incorrect** code for this rule:
+
+```js
+describe('', () => {});
+describe('foo', () => {
+  it('', () => {});
+});
+it('', () => {});
+test('', () => {});
+xdescribe('', () => {});
+xit('', () => {});
+xtest('', () => {});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+describe('foo', () => {});
+describe('foo', () => {
+  it('bar', () => {});
+});
+test('foo', () => {});
+it('foo', () => {});
+xdescribe('foo', () => {});
+xit('foo', () => {});
+xtest('foo', () => {});
+```
+
 **duplicatePrefix**
 
 A describe/ test block should not start with duplicatePrefix