Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TylerVigario committed May 1, 2024
1 parent f9a9888 commit 880cc1f
Show file tree
Hide file tree
Showing 28 changed files with 56 additions and 56 deletions.
2 changes: 1 addition & 1 deletion docs/rules/assertion-arguments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Enforce passing correct arguments to assertions (`ava/assertion-arguments`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/hooks-order.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Enforce test hook ordering (`ava/hooks-order`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/max-asserts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Enforce a limit on the number of assertions in a test (`ava/max-asserts`)

๐Ÿšซ This rule is _disabled_ in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿšซ This rule is _disabled_ in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-async-fn-without-await.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure that async tests use `await` (`ava/no-async-fn-without-await`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-duplicate-modifiers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure tests do not have duplicate modifiers (`ava/no-duplicate-modifiers`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-identical-title.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no tests have the same title (`ava/no-identical-title`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-ignored-test-files.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no tests are written in ignored files (`ava/no-ignored-test-files`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-import-test-files.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no test files are imported anywhere (`ava/no-import-test-files`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-incorrect-deep-equal.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow using `deepEqual` with primitives (`ava/no-incorrect-deep-equal`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-inline-assertions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure assertions are not called from inline arrow functions (`ava/no-inline-assertions`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-nested-tests.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no tests are nested (`ava/no-nested-tests`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-only-test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no `test.only()` are present (`ava/no-only-test`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

๐Ÿ”ง๐Ÿ’ก 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/latest/use/core-concepts#rule-suggestions).

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-skip-assert.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no assertions are skipped (`ava/no-skip-assert`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-skip-test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no tests are skipped (`ava/no-skip-test`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

๐Ÿ”ง๐Ÿ’ก 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/latest/use/core-concepts#rule-suggestions).

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-todo-implementation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure `test.todo()` is not given an implementation function (`ava/no-todo-implementation`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-todo-test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure no `test.todo()` is used (`ava/no-todo-test`)

โš ๏ธ This rule _warns_ in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
โš ๏ธ This rule _warns_ in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-unknown-modifiers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow the use of unknown test modifiers (`ava/no-unknown-modifiers`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prefer-async-await.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Prefer using async/await instead of returning a Promise (`ava/prefer-async-await`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prefer-power-assert.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Enforce the use of the asserts that have no [power-assert](https://github.com/power-assert-js/power-assert) alternative (`ava/prefer-power-assert`)

๐Ÿšซ This rule is _disabled_ in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿšซ This rule is _disabled_ in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prefer-t-regex.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Prefer using `t.regex()` to test regular expressions (`ava/prefer-t-regex`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/test-title-format.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure test titles have a certain format (`ava/test-title-format`)

๐Ÿšซ This rule is _disabled_ in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿšซ This rule is _disabled_ in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/test-title.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure tests have a title (`ava/test-title`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/use-t-throws-async-well.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure that `t.throwsAsync()` and `t.notThrowsAsync()` are awaited (`ava/use-t-throws-async-well`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/use-t-well.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow the incorrect use of `t` (`ava/use-t-well`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/use-t.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure test functions use `t` as their parameter (`ava/use-t`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/use-test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure that AVA is imported with `test` as the variable name (`ava/use-test`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/use-true-false.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensure that `t.true()`/`t.false()` are used instead of `t.truthy()`/`t.falsy()` (`ava/use-true-false`)

๐Ÿ’ผ This rule is enabled in the โœ… `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
๐Ÿ’ผ This rule is enabled in the following [configs](https://github.com/avajs/eslint-plugin-ava#recommended-config): `flat/recommended`, โœ… `recommended`.

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

Expand Down

0 comments on commit 880cc1f

Please sign in to comment.