Minor docs tweaks

sindresorhus · sindresorhus · commit dee1802d39e2 · 2021-04-20T01:35:55.000+07:00
diff --git a/docs/new-rule.md b/docs/new-rule.md
@@ -7,12 +7,10 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 - [Read the ESLint docs on creating a new rule.](https://eslint.org/docs/developer-guide/working-with-rules)
 - Look at the commit for how previous rules were added as inspiration. For example, the [`no-async-fn-without-await` rule](https://github.com/avajs/eslint-plugin-ava/commit/a443d7a9c94165f42749938e6b491a7c10749b6c).
 
-
 ## Tip
 
 Use the [`astexplorer` site](https://astexplorer.net) with the `espree` parser and `ESLint v4` transform to interactively create the initial rule implementation. It lets you inspect the full AST as you would get from ESLint and you can even see the result of your auto-fixer implementation.
 
-
 ## Steps
 
 - Go to the `test` directory and duplicate the `no-todo-test.js` file and rename it to the name of your rule. Then write some tests before starting to implement the rule.
@@ -22,7 +20,7 @@ Use the [`astexplorer` site](https://astexplorer.net) with the `espree` parser a
 - Add the rule in alphabetically sorted order to:
 	- [The recommended config](https://github.com/avajs/eslint-plugin-ava/blob/0ded4b5c3cd09504e846309760566c9499a24196/index.js#L19)
 	- [The recommended config in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L35)
-	- [The rule listing in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L73)<br>
+	- [The rule listing in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L73)\
 	*(The description should be the same as the heading of the documentation file).*
 - Run `$ npm test` to ensure the tests pass.
 - Run `$ npm run integration` to run the rules against real projects to ensure your rule does not fail on real-world code.
diff --git a/docs/rules/assertion-arguments.md b/docs/rules/assertion-arguments.md
@@ -13,46 +13,44 @@ This rule also attempts to enforce passing actual values before expected values.
 ```js
 const test = require('ava');
 
-test(t => {
+test('1', t => {
 	t.is(value); // Not enough arguments
 	t.is(value, expected, message, extra); // Too many arguments
 	t.is(value, expected, false); // Assertion message is not a string
 });
 
 /* eslint ava/assertion-arguments: ["error", {"message": "always"}] */
-test(t => {
+test('2', t => {
 	t.true(array.includes(value));
 });
 
 /* eslint ava/assertion-arguments: ["error", {"message": "never"}] */
-test(t => {
+test('3', t => {
 	t.true(array.includes(value), 'value is not in array');
 });
 ```
 
-
 ## Pass
 
 ```js
 const test = require('ava');
 
-test(t => {
+test('1', t => {
 	t.is(value, expected);
 	t.is(value, expected, message);
 });
 
 /* eslint ava/assertion-arguments: ["error", {"message": "always"}] */
-test(t => {
+test('2', t => {
 	t.true(array.includes(value), 'value is not in array');
 });
 
 /* eslint ava/assertion-arguments: ["error", {"message": "never"}] */
-test(t => {
+test('3', t => {
 	t.true(array.includes(value));
 });
 ```
 
-
 ## Options
 
 This rule supports the following options:
diff --git a/docs/rules/hooks-order.md b/docs/rules/hooks-order.md
@@ -14,7 +14,6 @@ Hooks should be placed before any tests and in the proper semantic order:
 
 This rule is fixable as long as no other code is between the hooks that need to be reordered.
 
-
 ## Fail
 
 ```js
@@ -45,7 +44,6 @@ test.before(t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/max-asserts.md b/docs/rules/max-asserts.md
@@ -6,7 +6,6 @@ Limit the amount of assertions in a test to enforce splitting up large tests int
 
 Skipped assertions are counted.
 
-
 ## Fail
 
 ```js
@@ -26,7 +25,6 @@ test('getSomeObject should define the players\' names', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-async-fn-without-await.md b/docs/rules/no-async-fn-without-await.md
@@ -8,26 +8,24 @@ Declaring an async test without using the `await` keyword means that either a Pr
 
 This rule will report an error when it finds an async test which does not use the `await` keyword.
 
-
 ## Fail
 
 ```js
 const test = require('ava');
 
-test(async t => {
+test('foo', async t => {
 	return foo().then(res => {
 		t.is(res, 1);
 	});
 });
 ```
 
-
 ## Pass
 
 ```js
 const test = require('ava');
 
-test(async t => {
+test('foo', async t => {
 	t.is(await foo(), 1);
 });
 ```
diff --git a/docs/rules/no-cb-test.md b/docs/rules/no-cb-test.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 Disallow the use of `test.cb()`. We instead recommend using `test()` with an async function or a function returning a promise.
 
-
 ## Fail
 
 ```js
@@ -16,7 +15,6 @@ test.cb('some test', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-duplicate-modifiers.md b/docs/rules/no-duplicate-modifiers.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 Prevent the use of duplicate [test modifiers](https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md).
 
-
 ## Fail
 
 ```js
@@ -17,7 +16,6 @@ test.beforeEach.beforeEach(t => {});
 test.only.only.cb(t => {});
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-identical-title.md b/docs/rules/no-identical-title.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 Disallow tests with identical titles as it makes it hard to differentiate them.
 
-
 ## Fail
 
 ```js
@@ -19,16 +18,11 @@ test('foo', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
 const test = require('ava');
 
-test(t => {
-	t.pass();
-});
-
 test('foo', t => {
 	t.pass();
 });
diff --git a/docs/rules/no-ignored-test-files.md b/docs/rules/no-ignored-test-files.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 This rule will verify that files which create tests are treated as test files by AVA. It will consider the root of the project to be the closest folder containing a `package.json` file, and will not do anything if it can't find one. Test files in `node_modules` will not be linted as they are ignored by ESLint.
 
-
 ## Fail
 
 ```js
@@ -25,7 +24,6 @@ test('foo', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-import-test-files.md b/docs/rules/no-import-test-files.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 This rule will verify that you don't import any test files. It will consider the root of the project to be the closest folder containing a `package.json` file, and will not do anything if it can't find one. Test files in `node_modules` will not be linted as they are ignored by ESLint.
 
-
 ## Fail
 
 ```js
@@ -23,7 +22,6 @@ test('foo', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-incorrect-deep-equal.md b/docs/rules/no-incorrect-deep-equal.md
@@ -6,7 +6,6 @@ The `deepEqual` and `notDeepEqual` assertions are unnecessary when comparing pri
 
 This rule is fixable.
 
-
 ## Fail
 
 ```js
@@ -18,7 +17,6 @@ t.deepEqual(expression, undefined);
 t.notDeepEqual(expression, undefined);
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-inline-assertions.md b/docs/rules/no-inline-assertions.md
@@ -6,7 +6,6 @@ The test implementation should not purely consist of an inline assertion as asse
 
 This rule is fixable. It will wrap the assertion in braces `{}`. It will not do any whitespace or style changes.
 
-
 ## Fail
 
 ```js
@@ -15,7 +14,6 @@ const test = require('ava');
 test('foo', t => t.true(fn()));
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-invalid-end.md b/docs/rules/no-invalid-end.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 AVA will fail if `t.end()` is called in a non-`.cb` test function.
 
-
 ## Fail
 
 ```js
@@ -16,7 +15,6 @@ test('some test', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-nested-tests.md b/docs/rules/no-nested-tests.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 In AVA, you cannot nest tests, for example, create tests inside of other tests. Doing so will lead to odd behavior.
 
-
 ## Fail
 
 ```js
@@ -20,7 +19,6 @@ test('foo', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-only-test.md b/docs/rules/no-only-test.md
@@ -19,7 +19,6 @@ test('test 2', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-skip-assert.md b/docs/rules/no-skip-assert.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 It's easy to make an assertion skipped with `t.skip.xyz()` and then forget about it.
 
-
 ## Fail
 
 ```js
@@ -15,7 +14,6 @@ test('some title', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-skip-test.md b/docs/rules/no-skip-test.md
@@ -18,7 +18,6 @@ test.skip('bar', t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-statement-after-end.md b/docs/rules/no-statement-after-end.md
@@ -20,7 +20,6 @@ test.cb(t => {
 });
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-todo-implementation.md b/docs/rules/no-todo-implementation.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 [`test.todo()`](https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md#test-placeholders-todo) is intended for planning tests. It's not meant to be passed a function to implement the test, and if given one, AVA will throw an error. If you added an implementation, you probably meant to remove the `.todo` modifier.
 
-
 ## Fail
 
 ```js
@@ -13,21 +12,16 @@ const test = require('ava');
 test.todo('title', t => {
 	// ...
 });
-
-test.todo(t => {
-	// ...
-});
 ```
 
-
 ## Pass
 
 ```js
 const test = require('ava');
 
 test.todo('title');
 
-test(t => {
+test('title2', t => {
 	// ...
 });
 ```
diff --git a/docs/rules/no-todo-test.md b/docs/rules/no-todo-test.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 Disallow the use of `test.todo()`. You might want to do this to only ship features with specs fully written and passing.
 
-
 ## Fail
 
 ```js
@@ -13,7 +12,6 @@ const test = require('ava');
 test.todo('some test');
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/no-unknown-modifiers.md b/docs/rules/no-unknown-modifiers.md
@@ -4,7 +4,6 @@ Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/rela
 
 Prevent the use of unknown [test modifiers](https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md).
 
-
 ## Fail
 
 ```js
@@ -17,7 +16,6 @@ test.beforeeach(t => {});
 test.unknown(t => {});
 ```
 
-
 ## Pass
 
 ```js
diff --git a/docs/rules/prefer-async-await.md b/docs/rules/prefer-async-await.md
diff --git a/docs/rules/prefer-power-assert.md b/docs/rules/prefer-power-assert.md
diff --git a/docs/rules/prefer-t-regex.md b/docs/rules/prefer-t-regex.md
diff --git a/docs/rules/test-ended.md b/docs/rules/test-ended.md
diff --git a/docs/rules/test-title-format.md b/docs/rules/test-title-format.md
diff --git a/docs/rules/test-title.md b/docs/rules/test-title.md
diff --git a/docs/rules/use-t-well.md b/docs/rules/use-t-well.md
diff --git a/docs/rules/use-t.md b/docs/rules/use-t.md
diff --git a/docs/rules/use-true-false.md b/docs/rules/use-true-false.md

-Original file line number
+Diff line change
 This rule is fixable as long as no other code is between the hooks that need to be reordered.
+-
 ## Fail
 ```js
 });
 ```
+-
 ## Pass
 ```js