chore: build recommended ruleset based on rules meta doc property (#615)

Author: G-Rath

src/index.ts

@@ -1,8 +1,13 @@
 import { readdirSync } from 'fs';
 import { join, parse } from 'path';
+import { TSESLint } from '@typescript-eslint/experimental-utils';
 import globals from './globals.json';
 import * as snapshotProcessor from './processors/snapshot-processor';
 
+type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
+  meta: Required<Pick<TSESLint.RuleMetaData<string>, 'docs'>>;
+};
+
 // can be removed once we've on v3: https://github.com/typescript-eslint/typescript-eslint/issues/2060
 declare module '@typescript-eslint/experimental-utils/dist/ts-eslint/Rule' {
   export interface RuleMetaDataDocs {
@@ -25,50 +30,38 @@ const excludedFiles = ['__tests__', 'utils'];
 const rules = readdirSync(rulesDir)
   .map(rule => parse(rule).name)
   .filter(rule => !excludedFiles.includes(rule))
+  .reduce<Record<string, RuleModule>>(
+    (acc, curr) => ({
+      ...acc,
+      [curr]: importDefault(join(rulesDir, curr)) as RuleModule,
+    }),
+    {},
+  );
+
+const recommendedRules = Object.entries(rules)
+  .filter(([, rule]) => rule.meta.docs.recommended)
   .reduce(
-    (acc, curr) =>
-      Object.assign(acc, { [curr]: importDefault(join(rulesDir, curr)) }),
+    (acc, [name, rule]) => ({
+      ...acc,
+      [`jest/${name}`]: rule.meta.docs.recommended,
+    }),
     {},
   );
 
-const allRules = Object.keys(rules).reduce<Record<string, string>>(
-  (rules, key) => ({ ...rules, [`jest/${key}`]: 'error' }),
-  {},
-);
+const allRules = Object.keys(rules).reduce<
+  Record<string, TSESLint.Linter.RuleLevel>
+>((rules, key) => ({ ...rules, [`jest/${key}`]: 'error' }), {});
+
+const createConfig = (rules: Record<string, TSESLint.Linter.RuleLevel>) => ({
+  plugins: ['jest'],
+  env: { 'jest/globals': true },
+  rules,
+});
 
 export = {
   configs: {
-    all: {
-      plugins: ['jest'],
-      env: {
-        'jest/globals': true,
-      },
-      rules: allRules,
-    },
-    recommended: {
-      plugins: ['jest'],
-      env: {
-        'jest/globals': true,
-      },
-      rules: {
-        'jest/expect-expect': 'warn',
-        'jest/no-commented-out-tests': 'warn',
-        'jest/no-disabled-tests': 'warn',
-        'jest/no-export': 'error',
-        'jest/no-focused-tests': 'error',
-        'jest/no-identical-title': 'error',
-        'jest/no-jest-import': 'error',
-        'jest/no-mocks-import': 'error',
-        'jest/no-jasmine-globals': 'warn',
-        'jest/no-standalone-expect': 'error',
-        'jest/no-test-callback': 'error',
-        'jest/no-test-prefixes': 'error',
-        'jest/no-try-expect': 'error',
-        'jest/valid-describe': 'error',
-        'jest/valid-expect': 'error',
-        'jest/valid-expect-in-promise': 'error',
-      },
-    },
+    all: createConfig(allRules),
+    recommended: createConfig(recommendedRules),
     style: {
       plugins: ['jest'],
       rules: {

src/rules/expect-expect.ts

@@ -49,7 +49,7 @@ export default createRule<
     docs: {
       category: 'Best Practices',
       description: 'Enforce assertion to be made in a test body',
-      recommended: false,
+      recommended: 'warn',
     },
     messages: {
       noAssertions: 'Test has no assertions',

src/rules/no-alias-methods.ts

@@ -6,7 +6,7 @@ export default createRule({
     docs: {
       category: 'Best Practices',
       description: 'Disallow alias methods',
-      recommended: 'warn',
+      recommended: false,
     },
     messages: {
       replaceAlias: `Replace {{ alias }}() with its canonical name of {{ canonical }}()`,

src/rules/no-commented-out-tests.ts

@@ -13,7 +13,7 @@ export default createRule({
     docs: {
       category: 'Best Practices',
       description: 'Disallow commented out tests',
-      recommended: false,
+      recommended: 'warn',
     },
     messages: {
       commentedTests: 'Some tests seem to be commented',

src/rules/no-disabled-tests.ts

@@ -6,7 +6,7 @@ export default createRule({
     docs: {
       category: 'Best Practices',
       description: 'Disallow disabled tests',
-      recommended: false,
+      recommended: 'warn',
     },
     messages: {
       missingFunction: 'Test is missing function argument',

src/rules/no-export.ts

@@ -10,7 +10,7 @@ export default createRule({
     docs: {
       category: 'Best Practices',
       description: 'Prevent exporting from test files',
-      recommended: false,
+      recommended: 'error',
     },
     messages: {
       unexpectedExport: `Do not export from a test file.`,

src/rules/no-focused-tests.ts

@@ -48,7 +48,7 @@ export default createRule({
     docs: {
       category: 'Best Practices',
       description: 'Disallow focused tests',
-      recommended: false,
+      recommended: 'error',
     },
     messages: {
       focusedTest: 'Unexpected focused test.',

src/rules/no-jasmine-globals.ts

@@ -12,7 +12,7 @@ export default createRule({
     docs: {
       category: 'Best Practices',
       description: 'Disallow Jasmine globals',
-      recommended: 'error',
+      recommended: 'warn',
     },
     messages: {
       illegalGlobal:

src/rules/no-standalone-expect.ts

@@ -66,7 +66,7 @@ export default createRule<
     docs: {
       category: 'Best Practices',
       description: 'Prevents expects that are outside of an it or test block.',
-      recommended: false,
+      recommended: 'error',
     },
     messages: {
       unexpectedExpect: 'Expect must be inside of a test block.',

src/rules/no-test-callback.ts

@@ -7,7 +7,7 @@ export default createRule({
     docs: {
       category: 'Best Practices',
       description: 'Avoid using a callback in asynchronous tests',
-      recommended: false,
+      recommended: 'error',
       suggestion: true,
     },
     messages: {

src/rules/no-try-expect.ts

@@ -12,7 +12,7 @@ export default createRule({
     docs: {
       description: 'Prefer using toThrow for exception tests',
       category: 'Best Practices',
-      recommended: false,
+      recommended: 'error',
     },
     deprecated: true,
     replacedBy: ['no-conditional-expect'],

src/rules/valid-describe.ts

@@ -29,7 +29,7 @@ export default createRule({
     docs: {
       category: 'Possible Errors',
       description: 'Enforce valid `describe()` callback',
-      recommended: 'warn',
+      recommended: 'error',
     },
     messages: {
       nameAndCallback: 'Describe requires name and callback arguments',

tools/generate-rules-table.ts

@@ -14,7 +14,9 @@ interface RuleDetails {
   fixable: FixType | false;
 }
 
-type RuleModule = TSESLint.RuleModule<string, unknown[]>;
+type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
+  meta: Required<Pick<TSESLint.RuleMetaData<string>, 'docs'>>;
+};
 
 const staticElements = {
   listHeaderRow: ['Rule', 'Description', 'Configurations', 'Fixable'],
@@ -97,10 +99,10 @@ const details: RuleDetails[] = Object.keys(config.configs.all.rules)
   .map(
     ([name, rule]): RuleDetails => ({
       name,
-      description: rule.meta.docs?.description ?? '',
+      description: rule.meta.docs.description,
       fixable: rule.meta.fixable
         ? 'fixable'
-        : rule.meta.docs?.suggestion
+        : rule.meta.docs.suggestion
         ? 'suggest'
         : false,
     }),