Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrade: Bump eslint-doc-generator from 0.16.0 to 0.19.0 #251

Merged
merged 1 commit into from
Nov 4, 2022
Merged

Upgrade: Bump eslint-doc-generator from 0.16.0 to 0.19.0 #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
85 changes: 43 additions & 42 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,51 +21,52 @@ For more details on how to extend your configuration from a plugin configuration

<!-- begin auto-generated rules list -->

✅ Enabled in the `recommended` [configuration](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).\
💼 [Configurations](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations) enabled in.\
✅ Set in the `recommended` [configuration](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).\
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

| Name                           | Description | ✅ | 🔧 | 💡 |
| :----------------------------------------------------------------------------- | :---------------------------------------------------------------------- | :-- | :-- | :-- |
| [assert-args](docs/rules/assert-args.md) | enforce that the correct number of assert arguments are used | ✅ | | |
| [literal-compare-order](docs/rules/literal-compare-order.md) | enforce comparison assertions have arguments in the right order | ✅ | 🔧 | |
| [no-arrow-tests](docs/rules/no-arrow-tests.md) | disallow arrow functions as QUnit test/module callbacks | | 🔧 | |
| [no-assert-equal](docs/rules/no-assert-equal.md) | disallow the use of assert.equal | ✅ | | 💡 |
| [no-assert-equal-boolean](docs/rules/no-assert-equal-boolean.md) | require use of boolean assertions | ✅ | 🔧 | |
| [no-assert-logical-expression](docs/rules/no-assert-logical-expression.md) | disallow binary logical expressions in assert arguments | ✅ | | |
| [no-assert-ok](docs/rules/no-assert-ok.md) | disallow the use of assert.ok/assert.notOk | | | |
| [no-async-in-loops](docs/rules/no-async-in-loops.md) | disallow async calls in loops | ✅ | | |
| [no-async-module-callbacks](docs/rules/no-async-module-callbacks.md) | disallow async module callbacks | ✅ | | |
| [no-async-test](docs/rules/no-async-test.md) | disallow the use of asyncTest or QUnit.asyncTest | ✅ | | |
| [no-commented-tests](docs/rules/no-commented-tests.md) | disallow commented tests | ✅ | | |
| [no-compare-relation-boolean](docs/rules/no-compare-relation-boolean.md) | disallow comparing relational expressions to booleans in assertions | ✅ | 🔧 | |
| [no-conditional-assertions](docs/rules/no-conditional-assertions.md) | disallow assertions within if statements or conditional expressions | ✅ | | |
| [no-early-return](docs/rules/no-early-return.md) | disallow early return in tests | ✅ | | |
| [no-global-assertions](docs/rules/no-global-assertions.md) | disallow global QUnit assertions | ✅ | | |
| [no-global-expect](docs/rules/no-global-expect.md) | disallow global expect | ✅ | | |
| [no-global-module-test](docs/rules/no-global-module-test.md) | disallow global module/test/asyncTest | ✅ | | |
| [no-global-stop-start](docs/rules/no-global-stop-start.md) | disallow global stop/start | ✅ | | |
| [no-hooks-from-ancestor-modules](docs/rules/no-hooks-from-ancestor-modules.md) | disallow the use of hooks from ancestor modules | ✅ | | |
| [no-identical-names](docs/rules/no-identical-names.md) | disallow identical test and module names | ✅ | | |
| [no-init](docs/rules/no-init.md) | disallow use of QUnit.init | ✅ | | |
| [no-jsdump](docs/rules/no-jsdump.md) | disallow use of QUnit.jsDump | ✅ | | |
| [no-loose-assertions](docs/rules/no-loose-assertions.md) | disallow the use of assert.equal/assert.ok/assert.notEqual/assert.notOk | | | |
| [no-negated-ok](docs/rules/no-negated-ok.md) | disallow negation in assert.ok/assert.notOk | ✅ | 🔧 | |
| [no-nested-tests](docs/rules/no-nested-tests.md) | disallow nested QUnit.test() calls | ✅ | | |
| [no-ok-equality](docs/rules/no-ok-equality.md) | disallow equality comparisons in assert.ok/assert.notOk | ✅ | 🔧 | |
| [no-only](docs/rules/no-only.md) | disallow QUnit.only | ✅ | | |
| [no-qunit-push](docs/rules/no-qunit-push.md) | disallow QUnit.push | ✅ | | |
| [no-qunit-start-in-tests](docs/rules/no-qunit-start-in-tests.md) | disallow QUnit.start() within tests or test hooks | ✅ | | |
| [no-qunit-stop](docs/rules/no-qunit-stop.md) | disallow QUnit.stop | ✅ | | |
| [no-reassign-log-callbacks](docs/rules/no-reassign-log-callbacks.md) | disallow overwriting of QUnit logging callbacks | ✅ | | |
| [no-reset](docs/rules/no-reset.md) | disallow QUnit.reset | ✅ | | |
| [no-setup-teardown](docs/rules/no-setup-teardown.md) | disallow setup/teardown module hooks | ✅ | 🔧 | |
| [no-skip](docs/rules/no-skip.md) | disallow QUnit.skip | | | |
| [no-test-expect-argument](docs/rules/no-test-expect-argument.md) | disallow the expect argument in QUnit.test | ✅ | | |
| [no-throws-string](docs/rules/no-throws-string.md) | disallow assert.throws() with block, string, and message args | ✅ | | |
| [require-expect](docs/rules/require-expect.md) | enforce that `expect` is called | ✅ | | |
| [require-object-in-propequal](docs/rules/require-object-in-propequal.md) | enforce use of objects as expected value in `assert.propEqual` | ✅ | | |
| [resolve-async](docs/rules/resolve-async.md) | require that async calls are resolved | ✅ | | |
| Name                           | Description | 💼 | 🔧 | 💡 |
| :----------------------------------------------------------------------------- | :---------------------------------------------------------------------- | :- | :- | :- |
| [assert-args](docs/rules/assert-args.md) | enforce that the correct number of assert arguments are used | ✅ | | |
| [literal-compare-order](docs/rules/literal-compare-order.md) | enforce comparison assertions have arguments in the right order | ✅ | 🔧 | |
| [no-arrow-tests](docs/rules/no-arrow-tests.md) | disallow arrow functions as QUnit test/module callbacks | | 🔧 | |
| [no-assert-equal](docs/rules/no-assert-equal.md) | disallow the use of assert.equal | ✅ | | 💡 |
| [no-assert-equal-boolean](docs/rules/no-assert-equal-boolean.md) | require use of boolean assertions | ✅ | 🔧 | |
| [no-assert-logical-expression](docs/rules/no-assert-logical-expression.md) | disallow binary logical expressions in assert arguments | ✅ | | |
| [no-assert-ok](docs/rules/no-assert-ok.md) | disallow the use of assert.ok/assert.notOk | | | |
| [no-async-in-loops](docs/rules/no-async-in-loops.md) | disallow async calls in loops | ✅ | | |
| [no-async-module-callbacks](docs/rules/no-async-module-callbacks.md) | disallow async module callbacks | ✅ | | |
| [no-async-test](docs/rules/no-async-test.md) | disallow the use of asyncTest or QUnit.asyncTest | ✅ | | |
| [no-commented-tests](docs/rules/no-commented-tests.md) | disallow commented tests | ✅ | | |
| [no-compare-relation-boolean](docs/rules/no-compare-relation-boolean.md) | disallow comparing relational expressions to booleans in assertions | ✅ | 🔧 | |
| [no-conditional-assertions](docs/rules/no-conditional-assertions.md) | disallow assertions within if statements or conditional expressions | ✅ | | |
| [no-early-return](docs/rules/no-early-return.md) | disallow early return in tests | ✅ | | |
| [no-global-assertions](docs/rules/no-global-assertions.md) | disallow global QUnit assertions | ✅ | | |
| [no-global-expect](docs/rules/no-global-expect.md) | disallow global expect | ✅ | | |
| [no-global-module-test](docs/rules/no-global-module-test.md) | disallow global module/test/asyncTest | ✅ | | |
| [no-global-stop-start](docs/rules/no-global-stop-start.md) | disallow global stop/start | ✅ | | |
| [no-hooks-from-ancestor-modules](docs/rules/no-hooks-from-ancestor-modules.md) | disallow the use of hooks from ancestor modules | ✅ | | |
| [no-identical-names](docs/rules/no-identical-names.md) | disallow identical test and module names | ✅ | | |
| [no-init](docs/rules/no-init.md) | disallow use of QUnit.init | ✅ | | |
| [no-jsdump](docs/rules/no-jsdump.md) | disallow use of QUnit.jsDump | ✅ | | |
| [no-loose-assertions](docs/rules/no-loose-assertions.md) | disallow the use of assert.equal/assert.ok/assert.notEqual/assert.notOk | | | |
| [no-negated-ok](docs/rules/no-negated-ok.md) | disallow negation in assert.ok/assert.notOk | ✅ | 🔧 | |
| [no-nested-tests](docs/rules/no-nested-tests.md) | disallow nested QUnit.test() calls | ✅ | | |
| [no-ok-equality](docs/rules/no-ok-equality.md) | disallow equality comparisons in assert.ok/assert.notOk | ✅ | 🔧 | |
| [no-only](docs/rules/no-only.md) | disallow QUnit.only | ✅ | | |
| [no-qunit-push](docs/rules/no-qunit-push.md) | disallow QUnit.push | ✅ | | |
| [no-qunit-start-in-tests](docs/rules/no-qunit-start-in-tests.md) | disallow QUnit.start() within tests or test hooks | ✅ | | |
| [no-qunit-stop](docs/rules/no-qunit-stop.md) | disallow QUnit.stop | ✅ | | |
| [no-reassign-log-callbacks](docs/rules/no-reassign-log-callbacks.md) | disallow overwriting of QUnit logging callbacks | ✅ | | |
| [no-reset](docs/rules/no-reset.md) | disallow QUnit.reset | ✅ | | |
| [no-setup-teardown](docs/rules/no-setup-teardown.md) | disallow setup/teardown module hooks | ✅ | 🔧 | |
| [no-skip](docs/rules/no-skip.md) | disallow QUnit.skip | | | |
| [no-test-expect-argument](docs/rules/no-test-expect-argument.md) | disallow the expect argument in QUnit.test | ✅ | | |
| [no-throws-string](docs/rules/no-throws-string.md) | disallow assert.throws() with block, string, and message args | ✅ | | |
| [require-expect](docs/rules/require-expect.md) | enforce that `expect` is called | ✅ | | |
| [require-object-in-propequal](docs/rules/require-object-in-propequal.md) | enforce use of objects as expected value in `assert.propEqual` | ✅ | | |
| [resolve-async](docs/rules/resolve-async.md) | require that async calls are resolved | ✅ | | |

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/assert-args.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Enforce that the correct number of assert arguments are used (`qunit/assert-args`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/literal-compare-order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Enforce comparison assertions have arguments in the right order (`qunit/literal-compare-order`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

🔧 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-assert-equal-boolean.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Require use of boolean assertions (`qunit/no-assert-equal-boolean`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

🔧 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-assert-equal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow the use of assert.equal (`qunit/no-assert-equal`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-assert-logical-expression.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow binary logical expressions in assert arguments (`qunit/no-assert-logical-expression`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-async-in-loops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow async calls in loops (`qunit/no-async-in-loops`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-async-module-callbacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow async module callbacks (`qunit/no-async-module-callbacks`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-async-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow the use of asyncTest or QUnit.asyncTest (`qunit/no-async-test`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-commented-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow commented tests (`qunit/no-commented-tests`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-compare-relation-boolean.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disallow comparing relational expressions to booleans in assertions (`qunit/no-compare-relation-boolean`)

✅ This rule is enabled in the `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations).

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

Expand Down