Skip to content

Commit

Permalink
Docs: split emojis into separate columns in README rules table (#185)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bmish
bmish authored May 21, 2021
1 parent 7fefc99 commit 7fda3c4
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 51 deletions.
82 changes: 41 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,47 +27,47 @@ Each rule has emojis denoting:

<!--RULES_TABLE_START-->

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

<!--RULES_TABLE_END-->

Expand Down
12 changes: 2 additions & 10 deletions scripts/update-rules.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,17 @@ const rulesTableContent = Object.keys(rules)
// Check which emojis to show for this rule.
const isRecommended = Object.prototype.hasOwnProperty.call(configs.recommended.rules, `qunit/${ruleName}`);
const isFixable = rules[ruleName].meta.fixable;

const emojis = [
isRecommended ? EMOJI_RECOMMENDED : "",
isFixable ? EMOJI_FIXABLE : ""
].join("");

const url = `./docs/rules/${ruleName}.md`;
const link = `[${ruleName}](${url})`;

const description = rules[ruleName].meta.docs.description;

return `| ${emojis} | ${link} | ${description}|`;
return `| ${link} | ${description} | ${isRecommended ? EMOJI_RECOMMENDED : ""} | ${isFixable ? EMOJI_FIXABLE : ""} |`;
})
.join("\n");

fs.writeFileSync(
pathReadme,
readmeContent.replace(
tablePlaceholder,
`<!--RULES_TABLE_START-->\n\n| | Name | Description |\n|:---|:--------|:--------|\n${rulesTableContent}\n\n<!--RULES_TABLE_END-->`
`<!--RULES_TABLE_START-->\n\n| Name | Description | ${EMOJI_RECOMMENDED} | ${EMOJI_FIXABLE} |\n|:--------|:--------|:---|:---|\n${rulesTableContent}\n\n<!--RULES_TABLE_END-->`
)
);

0 comments on commit 7fda3c4

Please sign in to comment.