Skip to content

Commit 12554e5

Browse files
authored
docs: update eslint-doc-generator to v3 (#657)
* docs: update eslint-doc-generator to v3 * wip * wip * wip
1 parent dc531b6 commit 12554e5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+320
-166
lines changed

.eslint-doc-generatorrc.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
"use strict";
2+
3+
/** @type {import('eslint-doc-generator').GenerateOptions} */
4+
const config = {
5+
urlConfigs:
6+
"https://github.com/platinumazure/eslint-plugin-qunit/blob/main/README.md#configurations",
7+
};
8+
9+
module.exports = config;

docs/rules/assert-args.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Enforce that the correct number of assert arguments are used (`qunit/assert-args`)
1+
# qunit/assert-args
2+
3+
📝 Enforce that the correct number of assert arguments are used.
24

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

docs/rules/literal-compare-order.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Enforce comparison assertions have arguments in the right order (`qunit/literal-compare-order`)
1+
# qunit/literal-compare-order
2+
3+
📝 Enforce comparison assertions have arguments in the right order.
24

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

docs/rules/no-arrow-tests.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Disallow arrow functions as QUnit test/module callbacks (`qunit/no-arrow-tests`)
1+
# qunit/no-arrow-tests
2+
3+
📝 Disallow arrow functions as QUnit test/module callbacks.
24

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

docs/rules/no-assert-equal-boolean.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Require use of boolean assertions (`qunit/no-assert-equal-boolean`)
1+
# qunit/no-assert-equal-boolean
2+
3+
📝 Require use of boolean assertions.
24

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

docs/rules/no-assert-equal.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Disallow the use of assert.equal (`qunit/no-assert-equal`)
1+
# qunit/no-assert-equal
2+
3+
📝 Disallow the use of assert.equal.
24

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

docs/rules/no-assert-logical-expression.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Disallow binary logical expressions in assert arguments (`qunit/no-assert-logical-expression`)
1+
# qunit/no-assert-logical-expression
2+
3+
📝 Disallow binary logical expressions in assert arguments.
24

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

docs/rules/no-assert-ok.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Disallow the use of assert.ok/assert.notOk (`qunit/no-assert-ok`)
1+
# qunit/no-assert-ok
2+
3+
📝 Disallow the use of assert.ok/assert.notOk.
24

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

docs/rules/no-async-in-loops.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Disallow async calls in loops (`qunit/no-async-in-loops`)
1+
# qunit/no-async-in-loops
2+
3+
📝 Disallow async calls in loops.
24

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

docs/rules/no-async-module-callbacks.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Disallow async module callbacks (`qunit/no-async-module-callbacks`)
1+
# qunit/no-async-module-callbacks
2+
3+
📝 Disallow async module callbacks.
24

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

0 commit comments

Comments
 (0)