wip

bmish · bmish · commit 7639012c41a7 · 2026-01-02T12:10:58.000-05:00
diff --git a/docs/rules/assert-args.md b/docs/rules/assert-args.md
@@ -1,9 +1,9 @@
 # qunit/assert-args
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Enforce that the correct number of assert arguments are used.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit's assertions expect a certain number of arguments based on what sort of
diff --git a/docs/rules/literal-compare-order.md b/docs/rules/literal-compare-order.md
@@ -1,11 +1,11 @@
 # qunit/literal-compare-order
 
+📝 Enforce comparison assertions have arguments in the right order.
+
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-📝 Enforce comparison assertions have arguments in the right order.
-
 <!-- end auto-generated rule header -->
 
 QUnit's many comparison assertions (`equal`, `strictEqual`, etc.) distinguish
diff --git a/docs/rules/no-arrow-tests.md b/docs/rules/no-arrow-tests.md
@@ -1,9 +1,9 @@
 # qunit/no-arrow-tests
 
-🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
 📝 Disallow arrow functions as QUnit test/module callbacks.
 
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 
 QUnit test and module callbacks can share state by modifying properties of
diff --git a/docs/rules/no-assert-equal-boolean.md b/docs/rules/no-assert-equal-boolean.md
@@ -1,11 +1,11 @@
 # qunit/no-assert-equal-boolean
 
+📝 Require use of boolean assertions.
+
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-📝 Require use of boolean assertions.
-
 <!-- end auto-generated rule header -->
 
 The boolean assertion functions `assert.true()` and `assert.false()` are available as of QUnit 2.11. These assertions can be stricter and clearer about intent when compared to using other assertion functions for boolean comparisons.
diff --git a/docs/rules/no-assert-equal.md b/docs/rules/no-assert-equal.md
@@ -1,11 +1,11 @@
 # qunit/no-assert-equal
 
+📝 Disallow the use of assert.equal.
+
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
-📝 Disallow the use of assert.equal.
-
 <!-- end auto-generated rule header -->
 
 The `assert.equal` assertion method in QUnit uses loose equality comparison. In a project which favors strict equality comparison, it is better to use `assert.strictEqual` for scalar values and either `assert.deepEqual` or `assert.propEqual` for more complex objects.
diff --git a/docs/rules/no-assert-logical-expression.md b/docs/rules/no-assert-logical-expression.md
@@ -1,9 +1,9 @@
 # qunit/no-assert-logical-expression
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow binary logical expressions in assert arguments.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 Generally, it is not a good idea to use logical expressions as assertion arguments. Logical-and assertions can be broken down into multiple assertions, while logical-or assertions may be indicative of uncertainty or nondeterminism in a test.
diff --git a/docs/rules/no-async-in-loops.md b/docs/rules/no-async-in-loops.md
@@ -1,9 +1,9 @@
 # qunit/no-async-in-loops
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow async calls in loops.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 Asynchronous operations are much harder to reason about in loops. To increase
diff --git a/docs/rules/no-async-module-callbacks.md b/docs/rules/no-async-module-callbacks.md
@@ -1,9 +1,9 @@
 # qunit/no-async-module-callbacks
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow async module callbacks.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit does not support async module callbacks. Only test and hook callbacks
diff --git a/docs/rules/no-async-test.md b/docs/rules/no-async-test.md
@@ -1,9 +1,9 @@
 # qunit/no-async-test
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow the use of asyncTest or QUnit.asyncTest.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit 2.0 is deprecating `QUnit.asyncTest()` in favor of `assert.async()` within tests. This rule will flag `asyncTest` and `QUnit.asyncTest` calls and recommend that you use `assert.async()` instead.
diff --git a/docs/rules/no-commented-tests.md b/docs/rules/no-commented-tests.md
@@ -1,9 +1,9 @@
 # qunit/no-commented-tests
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow commented tests.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 When developing non-trivial projects, it is unfortunately realistic that unit
diff --git a/docs/rules/no-compare-relation-boolean.md b/docs/rules/no-compare-relation-boolean.md
@@ -1,11 +1,11 @@
 # qunit/no-compare-relation-boolean
 
+📝 Disallow comparing relational expressions to booleans in assertions.
+
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-📝 Disallow comparing relational expressions to booleans in assertions.
-
 <!-- end auto-generated rule header -->
 
 Sometimes, QUnit assertions contain relations (such as `expected === actual`). Many of these relations can be expressed better using different assertion methods (such as `assert.strictEqual`). However, even for those comparisons which cannot easily be expressed (such as `actual > expected`), comparing those results explicitly to `true` or `false` provides no added value, because the assertion will show that true equals or does not equal true.
diff --git a/docs/rules/no-conditional-assertions.md b/docs/rules/no-conditional-assertions.md
@@ -1,9 +1,9 @@
 # qunit/no-conditional-assertions
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow assertions within if statements or conditional expressions.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 This rule aims to detect non-deterministic unit testing by looking for assertions in an if statement or conditional expression.
diff --git a/docs/rules/no-early-return.md b/docs/rules/no-early-return.md
@@ -1,9 +1,9 @@
 # qunit/no-early-return
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow early return in tests.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 This rule aims to prevent early returns in a QUnit test. Unit tests which can return early are usually indications that a test is nondeterministic or too dependent on environmental factors. On the rare occasion that a test should be run conditionally, the whole test should be run or skipped, rather than having a test that can return early (which is harder to maintain).
diff --git a/docs/rules/no-global-assertions.md b/docs/rules/no-global-assertions.md
@@ -1,9 +1,9 @@
 # qunit/no-global-assertions
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow global QUnit assertions.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit 2.0 is deprecating and removing global QUnit assertions such as `ok()`, requiring consumers to instead use scoped assertions provided on the test callback argument.
diff --git a/docs/rules/no-global-expect.md b/docs/rules/no-global-expect.md
@@ -1,9 +1,9 @@
 # qunit/no-global-expect
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow global expect.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit 2.0 is deprecating and removing the global `expect` function. This rule will warn when the global `expect` function is used.
diff --git a/docs/rules/no-global-module-test.md b/docs/rules/no-global-module-test.md
@@ -1,9 +1,9 @@
 # qunit/no-global-module-test
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow global module/test/asyncTest.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit 2.0 is deprecating and removing global functions related to declaring tests and modules. This rule will warn when the global functions are used.
diff --git a/docs/rules/no-global-stop-start.md b/docs/rules/no-global-stop-start.md
@@ -1,9 +1,9 @@
 # qunit/no-global-stop-start
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow global stop/start.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit 2.0 is deprecating and removing all of its global exports, including
diff --git a/docs/rules/no-hooks-from-ancestor-modules.md b/docs/rules/no-hooks-from-ancestor-modules.md
@@ -1,9 +1,9 @@
 # qunit/no-hooks-from-ancestor-modules
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow the use of hooks from ancestor modules.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 When a QUnit `module` is used with a nested callback, the callback provides a `hooks`
diff --git a/docs/rules/no-identical-names.md b/docs/rules/no-identical-names.md
@@ -1,9 +1,9 @@
 # qunit/no-identical-names
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow identical test and module names.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 Having identical names for two different tests or modules may create
diff --git a/docs/rules/no-init.md b/docs/rules/no-init.md
@@ -1,9 +1,9 @@
 # qunit/no-init
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow use of QUnit.init.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 Early versions of QUnit exposed the `QUnit.init()` function, which allowed
diff --git a/docs/rules/no-jsdump.md b/docs/rules/no-jsdump.md
@@ -1,9 +1,9 @@
 # qunit/no-jsdump
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow use of QUnit.jsDump.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 When QUnit was first developed, it used the `jsDump` library for serializing
diff --git a/docs/rules/no-negated-ok.md b/docs/rules/no-negated-ok.md
@@ -1,11 +1,11 @@
 # qunit/no-negated-ok
 
+📝 Disallow negation in assert.ok/assert.notOk.
+
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-📝 Disallow negation in assert.ok/assert.notOk.
-
 <!-- end auto-generated rule header -->
 
 Negated `assert.ok()` or `assert.notOk()` solutions can be misleading, because
diff --git a/docs/rules/no-nested-tests.md b/docs/rules/no-nested-tests.md
@@ -1,9 +1,9 @@
 # qunit/no-nested-tests
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow nested QUnit.test() calls.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 This rule prevents from incorrect usage of [Nested Scope](https://github.com/qunitjs/qunit/blob/master/docs/QUnit/module.md#nested-scope). Developer can write nested test instead of nested module by mistake. In this case test will still be executed, but effects may be unexpected.
diff --git a/docs/rules/no-ok-equality.md b/docs/rules/no-ok-equality.md
@@ -1,11 +1,11 @@
 # qunit/no-ok-equality
 
+📝 Disallow equality comparisons in assert.ok/assert.notOk.
+
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-📝 Disallow equality comparisons in assert.ok/assert.notOk.
-
 <!-- end auto-generated rule header -->
 
 Equality comparisons in `assert.ok` or `assert.notOk` calls are not valuable
diff --git a/docs/rules/no-only.md b/docs/rules/no-only.md
@@ -1,9 +1,9 @@
 # qunit/no-only
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow QUnit.only.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 `QUnit.only` is useful for restricting a test run to just one test while developing, but committing a test file using this function to a repository is dangerous because it will ensure that the rest of the test suite is not run.
diff --git a/docs/rules/no-qunit-push.md b/docs/rules/no-qunit-push.md
@@ -1,9 +1,9 @@
 # qunit/no-qunit-push
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow QUnit.push.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 When writing custom assertions, the proper way to log an assertion result
diff --git a/docs/rules/no-qunit-start-in-tests.md b/docs/rules/no-qunit-start-in-tests.md
@@ -1,9 +1,9 @@
 # qunit/no-qunit-start-in-tests
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow QUnit.start() within tests or test hooks.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 The purpose of this rule is to ensure that `QUnit.start()` is not used within tests or test hooks.
diff --git a/docs/rules/no-qunit-stop.md b/docs/rules/no-qunit-stop.md
@@ -1,9 +1,9 @@
 # qunit/no-qunit-stop
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow QUnit.stop.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit's handling of asynchronous tests used to be via tracking a global
diff --git a/docs/rules/no-reassign-log-callbacks.md b/docs/rules/no-reassign-log-callbacks.md
@@ -1,9 +1,9 @@
 # qunit/no-reassign-log-callbacks
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow overwriting of QUnit logging callbacks.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 In early versions of QUnit, it was possible to create logging functions that
diff --git a/docs/rules/no-reset.md b/docs/rules/no-reset.md
@@ -1,9 +1,9 @@
 # qunit/no-reset
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow QUnit.reset.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 Early versions of QUnit exposed the `QUnit.reset()` function, which allowed
diff --git a/docs/rules/no-setup-teardown.md b/docs/rules/no-setup-teardown.md
@@ -1,11 +1,11 @@
 # qunit/no-setup-teardown
 
+📝 Disallow setup/teardown module hooks.
+
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-📝 Disallow setup/teardown module hooks.
-
 <!-- end auto-generated rule header -->
 
 QUnit supports two hooks at the module level: `beforeEach` and `afterEach`.
diff --git a/docs/rules/no-test-expect-argument.md b/docs/rules/no-test-expect-argument.md
@@ -1,9 +1,9 @@
 # qunit/no-test-expect-argument
 
-💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
-
 📝 Disallow the expect argument in QUnit.test.
 
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
+
 <!-- end auto-generated rule header -->
 
 QUnit 2.0 is deprecating expect counts as the second argument of `QUnit.test`. Users are expected to use `assert.expect()` instead.
diff --git a/docs/rules/no-throws-string.md b/docs/rules/no-throws-string.md
diff --git a/docs/rules/require-expect.md b/docs/rules/require-expect.md
diff --git a/docs/rules/require-object-in-propequal.md b/docs/rules/require-object-in-propequal.md
diff --git a/docs/rules/resolve-async.md b/docs/rules/resolve-async.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
