qunitjs · bmish · Jan 1, 2026 · Jan 1, 2026 · Jan 2, 2026 · Jan 2, 2026
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -0,0 +1,9 @@
+"use strict";
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+    urlConfigs:
+        "https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations",
+};
+
+module.exports = config;
diff --git a/docs/rules/assert-args.md b/docs/rules/assert-args.md
@@ -1,4 +1,6 @@
-# Enforce that the correct number of assert arguments are used (`qunit/assert-args`)
+# qunit/assert-args
+
+📝 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).
 

diff --git a/docs/rules/literal-compare-order.md b/docs/rules/literal-compare-order.md
@@ -1,4 +1,6 @@
-# Enforce comparison assertions have arguments in the right order (`qunit/literal-compare-order`)
+# 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).
 

diff --git a/docs/rules/no-arrow-tests.md b/docs/rules/no-arrow-tests.md
@@ -1,4 +1,6 @@
-# Disallow arrow functions as QUnit test/module callbacks (`qunit/no-arrow-tests`)
+# qunit/no-arrow-tests
+
+📝 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).
 

diff --git a/docs/rules/no-assert-equal-boolean.md b/docs/rules/no-assert-equal-boolean.md
@@ -1,4 +1,6 @@
-# Require use of boolean assertions (`qunit/no-assert-equal-boolean`)
+# 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).
 

diff --git a/docs/rules/no-assert-equal.md b/docs/rules/no-assert-equal.md
@@ -1,4 +1,6 @@
-# Disallow the use of assert.equal (`qunit/no-assert-equal`)
+# 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).
 

diff --git a/docs/rules/no-assert-logical-expression.md b/docs/rules/no-assert-logical-expression.md
@@ -1,4 +1,6 @@
-# Disallow binary logical expressions in assert arguments (`qunit/no-assert-logical-expression`)
+# qunit/no-assert-logical-expression
+
+📝 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).
 

diff --git a/docs/rules/no-assert-ok.md b/docs/rules/no-assert-ok.md
@@ -1,4 +1,6 @@
-# Disallow the use of assert.ok/assert.notOk (`qunit/no-assert-ok`)
+# qunit/no-assert-ok
+
+📝 Disallow the use of assert.ok/assert.notOk.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-async-in-loops.md b/docs/rules/no-async-in-loops.md
@@ -1,4 +1,6 @@
-# Disallow async calls in loops (`qunit/no-async-in-loops`)
+# qunit/no-async-in-loops
+
+📝 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).
 

diff --git a/docs/rules/no-async-module-callbacks.md b/docs/rules/no-async-module-callbacks.md
@@ -1,4 +1,6 @@
-# Disallow async module callbacks (`qunit/no-async-module-callbacks`)
+# qunit/no-async-module-callbacks
+
+📝 Disallow async module callbacks.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-async-test.md b/docs/rules/no-async-test.md
@@ -1,4 +1,6 @@
-# Disallow the use of asyncTest or QUnit.asyncTest (`qunit/no-async-test`)
+# qunit/no-async-test
+
+📝 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).
 

diff --git a/docs/rules/no-commented-tests.md b/docs/rules/no-commented-tests.md
@@ -1,4 +1,6 @@
-# Disallow commented tests (`qunit/no-commented-tests`)
+# qunit/no-commented-tests
+
+📝 Disallow commented tests.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-compare-relation-boolean.md b/docs/rules/no-compare-relation-boolean.md
@@ -1,4 +1,6 @@
-# Disallow comparing relational expressions to booleans in assertions (`qunit/no-compare-relation-boolean`)
+# 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).
 

diff --git a/docs/rules/no-conditional-assertions.md b/docs/rules/no-conditional-assertions.md
@@ -1,4 +1,6 @@
-# Disallow assertions within if statements or conditional expressions (`qunit/no-conditional-assertions`)
+# qunit/no-conditional-assertions
+
+📝 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).
 

diff --git a/docs/rules/no-early-return.md b/docs/rules/no-early-return.md
@@ -1,4 +1,6 @@
-# Disallow early return in tests (`qunit/no-early-return`)
+# qunit/no-early-return
+
+📝 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).
 

diff --git a/docs/rules/no-global-assertions.md b/docs/rules/no-global-assertions.md
@@ -1,4 +1,6 @@
-# Disallow global QUnit assertions (`qunit/no-global-assertions`)
+# qunit/no-global-assertions
+
+📝 Disallow global QUnit assertions.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-global-expect.md b/docs/rules/no-global-expect.md
@@ -1,4 +1,6 @@
-# Disallow global expect (`qunit/no-global-expect`)
+# qunit/no-global-expect
+
+📝 Disallow global expect.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-global-module-test.md b/docs/rules/no-global-module-test.md
@@ -1,4 +1,6 @@
-# Disallow global module/test/asyncTest (`qunit/no-global-module-test`)
+# qunit/no-global-module-test
+
+📝 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).
 

diff --git a/docs/rules/no-global-stop-start.md b/docs/rules/no-global-stop-start.md
@@ -1,4 +1,6 @@
-# Disallow global stop/start (`qunit/no-global-stop-start`)
+# qunit/no-global-stop-start
+
+📝 Disallow global stop/start.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-hooks-from-ancestor-modules.md b/docs/rules/no-hooks-from-ancestor-modules.md
@@ -1,4 +1,6 @@
-# Disallow the use of hooks from ancestor modules (`qunit/no-hooks-from-ancestor-modules`)
+# qunit/no-hooks-from-ancestor-modules
+
+📝 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).
 

diff --git a/docs/rules/no-identical-names.md b/docs/rules/no-identical-names.md
@@ -1,4 +1,6 @@
-# Disallow identical test and module names (`qunit/no-identical-names`)
+# qunit/no-identical-names
+
+📝 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).
 

diff --git a/docs/rules/no-init.md b/docs/rules/no-init.md
@@ -1,4 +1,6 @@
-# Disallow use of QUnit.init (`qunit/no-init`)
+# qunit/no-init
+
+📝 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).
 

diff --git a/docs/rules/no-jsdump.md b/docs/rules/no-jsdump.md
@@ -1,4 +1,6 @@
-# Disallow use of QUnit.jsDump (`qunit/no-jsdump`)
+# qunit/no-jsdump
+
+📝 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).
 

diff --git a/docs/rules/no-loose-assertions.md b/docs/rules/no-loose-assertions.md
@@ -1,4 +1,6 @@
-# Disallow the use of assert.equal/assert.ok/assert.notEqual/assert.notOk (`qunit/no-loose-assertions`)
+# qunit/no-loose-assertions
+
+📝 Disallow the use of assert.equal/assert.ok/assert.notEqual/assert.notOk.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-negated-ok.md b/docs/rules/no-negated-ok.md
@@ -1,4 +1,6 @@
-# Disallow negation in assert.ok/assert.notOk (`qunit/no-negated-ok`)
+# 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).
 

diff --git a/docs/rules/no-nested-tests.md b/docs/rules/no-nested-tests.md
@@ -1,4 +1,6 @@
-# Disallow nested QUnit.test() calls (`qunit/no-nested-tests`)
+# qunit/no-nested-tests
+
+📝 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).
 

diff --git a/docs/rules/no-ok-equality.md b/docs/rules/no-ok-equality.md
@@ -1,4 +1,6 @@
-# Disallow equality comparisons in assert.ok/assert.notOk (`qunit/no-ok-equality`)
+# 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).
 

diff --git a/docs/rules/no-only.md b/docs/rules/no-only.md
@@ -1,4 +1,6 @@
-# Disallow QUnit.only (`qunit/no-only`)
+# qunit/no-only
+
+📝 Disallow QUnit.only.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-qunit-push.md b/docs/rules/no-qunit-push.md
@@ -1,4 +1,6 @@
-# Disallow QUnit.push (`qunit/no-qunit-push`)
+# qunit/no-qunit-push
+
+📝 Disallow QUnit.push.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-qunit-start-in-tests.md b/docs/rules/no-qunit-start-in-tests.md
@@ -1,4 +1,6 @@
-# Disallow QUnit.start() within tests or test hooks (`qunit/no-qunit-start-in-tests`)
+# qunit/no-qunit-start-in-tests
+
+📝 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).
 

diff --git a/docs/rules/no-qunit-stop.md b/docs/rules/no-qunit-stop.md
@@ -1,4 +1,6 @@
-# Disallow QUnit.stop (`qunit/no-qunit-stop`)
+# qunit/no-qunit-stop
+
+📝 Disallow QUnit.stop.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-reassign-log-callbacks.md b/docs/rules/no-reassign-log-callbacks.md
@@ -1,4 +1,6 @@
-# Disallow overwriting of QUnit logging callbacks (`qunit/no-reassign-log-callbacks`)
+# qunit/no-reassign-log-callbacks
+
+📝 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).
 

diff --git a/docs/rules/no-reset.md b/docs/rules/no-reset.md
@@ -1,4 +1,6 @@
-# Disallow QUnit.reset (`qunit/no-reset`)
+# qunit/no-reset
+
+📝 Disallow QUnit.reset.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/no-setup-teardown.md b/docs/rules/no-setup-teardown.md
@@ -1,4 +1,6 @@
-# Disallow setup/teardown module hooks (`qunit/no-setup-teardown`)
+# 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).
 

diff --git a/docs/rules/no-skip.md b/docs/rules/no-skip.md
@@ -1,4 +1,6 @@
-# Disallow QUnit.skip (`qunit/no-skip`)
+# qunit/no-skip
+
+📝 Disallow QUnit.skip.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-test-expect-argument.md b/docs/rules/no-test-expect-argument.md
@@ -1,4 +1,6 @@
-# Disallow the expect argument in QUnit.test (`qunit/no-test-expect-argument`)
+# qunit/no-test-expect-argument
+
+📝 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).
 

diff --git a/docs/rules/no-throws-string.md b/docs/rules/no-throws-string.md
@@ -1,4 +1,6 @@
-# Disallow assert.throws() with block, string, and message args (`qunit/no-throws-string`)
+# qunit/no-throws-string
+
+📝 Disallow assert.throws() with block, string, and message args.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/require-expect.md b/docs/rules/require-expect.md
@@ -1,4 +1,6 @@
-# Enforce that `expect` is called (`qunit/require-expect`)
+# qunit/require-expect
+
+📝 Enforce that `expect` is called.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/require-object-in-propequal.md b/docs/rules/require-object-in-propequal.md
@@ -1,4 +1,6 @@
-# Enforce use of objects as expected value in `assert.propEqual` (`qunit/require-object-in-propequal`)
+# qunit/require-object-in-propequal
+
+📝 Enforce use of objects as expected value in `assert.propEqual`.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).
 

diff --git a/docs/rules/resolve-async.md b/docs/rules/resolve-async.md
@@ -1,4 +1,6 @@
-# Require that async calls are resolved (`qunit/resolve-async`)
+# qunit/resolve-async
+
+📝 Require that async calls are resolved.
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations).