Create more tooling (#578)

G-Rath · web-flow · commit d7cc77e046b1 · 2020-05-12T20:36:58.000+12:00
* chore: create `generate-rules-table` script

* docs: update titles

* chore: update rule descriptions

* docs: regenerate rules table in README

* chore: `sort-package-json`
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -71,11 +71,17 @@ module.exports = {
       globals,
     },
     {
-      files: ['src/**/*', 'dangerfile.ts'],
+      files: ['src/**/*', 'dangerfile.ts', 'tools/*'],
       parserOptions: {
         sourceType: 'module',
       },
     },
+    {
+      files: ['tools/*'],
+      rules: {
+        'node/shebang': 'off',
+      },
+    },
     {
       files: ['.eslintrc.js', 'babel.config.js'],
       rules: {
diff --git a/README.md b/README.md
diff --git a/docs/rules/consistent-test-it.md b/docs/rules/consistent-test-it.md
@@ -1,4 +1,4 @@
-# Have control over `test` and `it` usages (consistent-test-it)
+# Have control over `test` and `it` usages (`consistent-test-it`)
 
 Jest allows you to choose how you want to define your tests, using the `it` or
 the `test` keywords, with multiple permutations for each:
diff --git a/docs/rules/expect-expect.md b/docs/rules/expect-expect.md
@@ -1,4 +1,4 @@
-# Enforce assertion to be made in a test body (expect-expect)
+# Enforce assertion to be made in a test body (`expect-expect`)
 
 Ensure that there is at least one `expect` call made in a test.
 
diff --git a/docs/rules/lowercase-name.md b/docs/rules/lowercase-name.md
@@ -1,4 +1,4 @@
-# Enforce lowercase test names (lowercase-name)
+# Enforce lowercase test names (`lowercase-name`)
 
 ## Rule details
 
diff --git a/docs/rules/no-alias-methods.md b/docs/rules/no-alias-methods.md
@@ -1,4 +1,4 @@
-# Don't use alias methods (no-alias-methods)
+# Don't use alias methods (`no-alias-methods`)
 
 Several Jest methods have alias names, such as `toThrow` having the alias of
 `toThrowError`. This rule ensures that only the canonical name as used in the
diff --git a/docs/rules/no-commented-out-tests.md b/docs/rules/no-commented-out-tests.md
@@ -1,4 +1,4 @@
-# Disallow commented out tests (no-commented-out-tests)
+# Disallow commented out tests (`no-commented-out-tests`)
 
 This rule raises a warning about commented out tests. It's similar to
 no-disabled-tests rule.
diff --git a/docs/rules/no-disabled-tests.md b/docs/rules/no-disabled-tests.md
@@ -1,4 +1,4 @@
-# Disallow disabled tests (no-disabled-tests)
+# Disallow disabled tests (`no-disabled-tests`)
 
 Jest has a feature that allows you to temporarily mark tests as disabled. This
 feature is often helpful while debugging or to create placeholders for future
diff --git a/docs/rules/no-duplicate-hooks.md b/docs/rules/no-duplicate-hooks.md
@@ -1,4 +1,4 @@
-# Disallow duplicate setup and teardown hooks (no-duplicate-hooks)
+# Disallow duplicate setup and teardown hooks (`no-duplicate-hooks`)
 
 A describe block should not contain duplicate hooks.
 
diff --git a/docs/rules/no-expect-resolves.md b/docs/rules/no-expect-resolves.md
@@ -1,4 +1,4 @@
-# Avoid using `expect().resolves` (no-expect-resolves)
+# Avoid using `expect().resolves` (`no-expect-resolves`)
 
 Jest allows you to test a promise resolve value using `await expect().resolves`.
 For consistency and readability this rule bans `expect().resolves` in favor of
diff --git a/docs/rules/no-export.md b/docs/rules/no-export.md
@@ -1,4 +1,4 @@
-# no export from test file (no-export)
+# Prevent exporting from test files (`no-export`)
 
 Prevents exports from test files. If a file has at least 1 test in it, then this
 rule will prevent exports.
diff --git a/docs/rules/no-focused-tests.md b/docs/rules/no-focused-tests.md
@@ -1,4 +1,4 @@
-# Disallow focused tests (no-focused-tests)
+# Disallow focused tests (`no-focused-tests`)
 
 Jest has a feature that allows you to focus tests by appending `.only` or
 prepending `f` to a test-suite or a test-case. This feature is really helpful to
diff --git a/docs/rules/no-hooks.md b/docs/rules/no-hooks.md
@@ -1,4 +1,4 @@
-# Disallow setup and teardown hooks (no-hooks)
+# Disallow setup and teardown hooks (`no-hooks`)
 
 Jest provides global functions for setup and teardown tasks, which are called
 before/after each test case and each test suite. The use of these hooks promotes
diff --git a/docs/rules/no-identical-title.md b/docs/rules/no-identical-title.md
@@ -1,4 +1,4 @@
-# Disallow identical titles (no-identical-title)
+# Disallow identical titles (`no-identical-title`)
 
 Having identical titles for two different tests or test suites may create
 confusion. For example, when a test with the same title as another test in the
diff --git a/docs/rules/no-if.md b/docs/rules/no-if.md
@@ -1,4 +1,4 @@
-# Disallow conditional logic. (no-if)
+# Disallow conditional logic (`no-if`)
 
 Conditional logic in tests is usually an indication that a test is attempting to
 cover too much, and not testing the logic it intends to. Each branch of code
diff --git a/docs/rules/no-jasmine-globals.md b/docs/rules/no-jasmine-globals.md
@@ -1,4 +1,4 @@
-# Disallow Jasmine globals
+# Disallow Jasmine globals (`no-jasmine-globals`)
 
 `jest` uses `jasmine` as a test runner. A side effect of this is that both a
 `jasmine` object, and some jasmine-specific globals, are exposed to the test
diff --git a/docs/rules/no-jest-import.md b/docs/rules/no-jest-import.md
@@ -1,4 +1,4 @@
-# Disallow importing Jest(no-jest-import)
+# Disallow importing Jest (`no-jest-import`)
 
 The `jest` object is automatically in scope within every test file. The methods
 in the `jest` object help create mocks and let you control Jest's overall
diff --git a/docs/rules/no-large-snapshots.md b/docs/rules/no-large-snapshots.md
@@ -1,4 +1,4 @@
-# disallow large snapshots (no-large-snapshots)
+# disallow large snapshots (`no-large-snapshots`)
 
 When using Jest's snapshot capability one should be mindful of the size of
 created snapshots. As a best practice snapshots should be limited in size in
diff --git a/docs/rules/no-mocks-import.md b/docs/rules/no-mocks-import.md
@@ -1,4 +1,4 @@
-# Disallow manually importing from `__mocks__` (no-mocks-import)
+# Disallow manually importing from `__mocks__` (`no-mocks-import`)
 
 When using `jest.mock`, your tests (just like the code being tested) should
 import from `./x`, not `./__mocks__/x`. Not following this rule can lead to
diff --git a/docs/rules/no-standalone-expect.md b/docs/rules/no-standalone-expect.md
@@ -1,4 +1,4 @@
-# No standalone expect in a describe block (no-standalone-expect)
+# No standalone expect in a describe block (`no-standalone-expect`)
 
 Prevents `expect` statements outside of a `test` or `it` block. An `expect`
 within a helper function (but outside of a `test` or `it` block) will not
diff --git a/docs/rules/no-test-callback.md b/docs/rules/no-test-callback.md
@@ -1,4 +1,4 @@
-# Avoid using a callback in asynchronous tests (no-test-callback)
+# Avoid using a callback in asynchronous tests (`no-test-callback`)
 
 Jest allows you to pass a callback to test definitions, typically called `done`,
 that is later invoked to indicate that the asynchronous test is complete.
diff --git a/docs/rules/no-test-prefixes.md b/docs/rules/no-test-prefixes.md
@@ -1,4 +1,4 @@
-# Use `.only` and `.skip` over `f` and `x` (no-test-prefixes)
+# Use `.only` and `.skip` over `f` and `x` (`no-test-prefixes`)
 
 Jest allows you to choose how you want to define focused and skipped tests, with
 multiple permutations for each:
diff --git a/docs/rules/no-test-return-statement.md b/docs/rules/no-test-return-statement.md
@@ -1,4 +1,4 @@
-# Disallow explicitly returning from tests (no-test-return-statement)
+# Disallow explicitly returning from tests (`no-test-return-statement`)
 
 Tests in Jest should be void and not return values.
 
diff --git a/docs/rules/no-truthy-falsy.md b/docs/rules/no-truthy-falsy.md
@@ -1,4 +1,4 @@
-# Disallow using `toBeTruthy()` & `toBeFalsy()` (no-truthy-falsy)
+# Disallow using `toBeTruthy()` & `toBeFalsy()` (`no-truthy-falsy`)
 
 Tests against boolean values should assert true or false. Asserting `toBeTruthy`
 or `toBeFalsy` matches non-boolean values as well and encourages weaker tests.
diff --git a/docs/rules/no-try-expect.md b/docs/rules/no-try-expect.md
@@ -1,4 +1,4 @@
-# Prevent catch assertions in tests (no-try-expect)
+# Prevent catch assertions in tests (`no-try-expect`)
 
 This rule prevents the use of `expect` inside `catch` blocks.
 
diff --git a/docs/rules/prefer-called-with.md b/docs/rules/prefer-called-with.md
@@ -1,4 +1,4 @@
-# Suggest using `toBeCalledWith` OR `toHaveBeenCalledWith` (prefer-called-with)
+# Suggest using `toBeCalledWith` OR `toHaveBeenCalledWith` (`prefer-called-with`)
 
 The `toBeCalled()` matcher is used to assert that a mock function has been
 called one or more times, without checking the arguments passed. The assertion
diff --git a/docs/rules/prefer-expect-assertions.md b/docs/rules/prefer-expect-assertions.md
@@ -1,4 +1,4 @@
-# Suggest using `expect.assertions()` OR `expect.hasAssertions()` (prefer-expect-assertions)
+# Suggest using `expect.assertions()` OR `expect.hasAssertions()` (`prefer-expect-assertions`)
 
 Ensure every test to have either `expect.assertions(<number of assertions>)` OR
 `expect.hasAssertions()` as its first expression.
diff --git a/docs/rules/prefer-hooks-on-top.md b/docs/rules/prefer-hooks-on-top.md
@@ -1,4 +1,4 @@
-# Suggest to have all hooks at top-level before tests (prefer-hooks-on-top)
+# Suggest to have all hooks at top-level before tests (`prefer-hooks-on-top`)
 
 All hooks should be defined before the start of the tests
 
diff --git a/docs/rules/prefer-inline-snapshots.md b/docs/rules/prefer-inline-snapshots.md
@@ -1,4 +1,4 @@
-# Suggest using inline snapshots (prefer-inline-snapshots)
+# Suggest using inline snapshots (`prefer-inline-snapshots`)
 
 In order to make snapshot tests more managable and reviewable
 `toMatchInlineSnapshot()` and `toThrowErrorMatchingInlineSnapshot` should be
diff --git a/docs/rules/prefer-spy-on.md b/docs/rules/prefer-spy-on.md
@@ -1,4 +1,4 @@
-# Suggest using `jest.spyOn()` (prefer-spy-on)
+# Suggest using `jest.spyOn()` (`prefer-spy-on`)
 
 When mocking a function by overwriting a property you have to manually restore
 the original implementation when cleaning up. When using `jest.spyOn()` Jest
diff --git a/docs/rules/prefer-strict-equal.md b/docs/rules/prefer-strict-equal.md
@@ -1,4 +1,4 @@
-# Suggest using `toStrictEqual()` (prefer-strict-equal)
+# Suggest using `toStrictEqual()` (`prefer-strict-equal`)
 
 `toStrictEqual` not only checks that two objects contain the same data but also
 that they have the same structure. It is common to expect objects to not only
diff --git a/docs/rules/prefer-to-be-null.md b/docs/rules/prefer-to-be-null.md
@@ -1,4 +1,4 @@
-# Suggest using `toBeNull()` (prefer-to-be-null)
+# Suggest using `toBeNull()` (`prefer-to-be-null`)
 
 In order to have a better failure message, `toBeNull()` should be used upon
 asserting expections on null value.
diff --git a/docs/rules/prefer-to-be-undefined.md b/docs/rules/prefer-to-be-undefined.md
@@ -1,4 +1,4 @@
-# Suggest using `toBeUndefined()` (prefer-to-be-undefined)
+# Suggest using `toBeUndefined()` (`prefer-to-be-undefined`)
 
 In order to have a better failure message, `toBeUndefined()` should be used upon
 asserting expections on undefined value.
diff --git a/docs/rules/prefer-to-contain.md b/docs/rules/prefer-to-contain.md
@@ -1,4 +1,4 @@
-# Suggest using `toContain()` (prefer-to-contain)
+# Suggest using `toContain()` (`prefer-to-contain`)
 
 In order to have a better failure message, `toContain()` should be used upon
 asserting expectations on an array containing an object.
diff --git a/docs/rules/prefer-to-have-length.md b/docs/rules/prefer-to-have-length.md
@@ -1,4 +1,4 @@
-# Suggest using `toHaveLength()` (prefer-to-have-length)
+# Suggest using `toHaveLength()` (`prefer-to-have-length`)
 
 In order to have a better failure message, `toHaveLength()` should be used upon
 asserting expectations on object's length property.
diff --git a/docs/rules/prefer-todo.md b/docs/rules/prefer-todo.md
@@ -1,4 +1,4 @@
-# Suggest using `test.todo` (prefer-todo)
+# Suggest using `test.todo` (`prefer-todo`)
 
 When test cases are empty then it is better to mark them as `test.todo` as it
 will be highlighted in the summary output.
diff --git a/docs/rules/require-to-throw-message.md b/docs/rules/require-to-throw-message.md
@@ -1,4 +1,4 @@
-# Require a message for `toThrow()` (require-to-throw-message)
+# Require a message for `toThrow()` (`require-to-throw-message`)
 
 `toThrow()`, and its alias `toThrowError()`, are used to check if an error is
 thrown by a function call, such as in `expect(() => a()).toThrow()`. However, if
diff --git a/docs/rules/require-top-level-describe.md b/docs/rules/require-top-level-describe.md
@@ -1,4 +1,4 @@
-# Require top-level describe block (require-top-level-describe)
+# Require top-level describe block (`require-top-level-describe`)
 
 Jest allows you to organise your test files the way you want it. However, the
 more your codebase grows, the more it becomes hard to navigate in your test
diff --git a/docs/rules/valid-describe.md b/docs/rules/valid-describe.md
@@ -1,4 +1,4 @@
-# Enforce valid `describe()` callback (valid-describe)
+# Enforce valid `describe()` callback (`valid-describe`)
 
 Using an improper `describe()` callback function can lead to unexpected test
 errors.
diff --git a/docs/rules/valid-expect-in-promise.md b/docs/rules/valid-expect-in-promise.md
@@ -1,4 +1,4 @@
-# Enforce having return statement when testing with promises (valid-expect-in-promise)
+# Enforce having return statement when testing with promises (`valid-expect-in-promise`)
 
 Ensure to return promise when having assertions in `then` or `catch` block of
 promise
diff --git a/docs/rules/valid-expect.md b/docs/rules/valid-expect.md
@@ -1,4 +1,4 @@
-# Enforce valid `expect()` usage (valid-expect)
+# Enforce valid `expect()` usage (`valid-expect`)
 
 Ensure `expect()` is called with a single argument and there is an actual
 expectation made.
diff --git a/docs/rules/valid-title.md b/docs/rules/valid-title.md
@@ -1,4 +1,4 @@
-# describe/test titles should be valid (valid-title)
+# describe/test titles should be valid (`valid-title`)
 
 Checks that the title of Jest blocks are valid by ensuring that titles are:
 
diff --git a/package.json b/package.json
diff --git a/src/rules/lowercase-name.ts b/src/rules/lowercase-name.ts
diff --git a/src/rules/no-commented-out-tests.ts b/src/rules/no-commented-out-tests.ts
diff --git a/src/rules/no-export.ts b/src/rules/no-export.ts
diff --git a/src/rules/no-jest-import.ts b/src/rules/no-jest-import.ts
diff --git a/src/rules/no-mocks-import.ts b/src/rules/no-mocks-import.ts
diff --git a/src/rules/valid-describe.ts b/src/rules/valid-describe.ts
diff --git a/tools/generate-rules-table.ts b/tools/generate-rules-table.ts
diff --git a/yarn.lock b/yarn.lock
