chore: add generate-configs script

Author: MichaelDeBoey

lib/configs/index.ts

@@ -8,7 +8,7 @@ import {
   SupportedTestingFramework,
 } from '../utils';
 
-type LinterConfigRules = Record<string, TSESLint.Linter.RuleEntry>;
+export type LinterConfigRules = Record<string, TSESLint.Linter.RuleEntry>;
 
 const configsDir = __dirname;
 

lib/create-testing-library-rule/index.ts

@@ -1,30 +1,25 @@
 import { ESLintUtils, TSESLint } from '@typescript-eslint/experimental-utils';
 
-import { getDocsUrl } from '../utils';
+import { getDocsUrl, TestingLibraryRuleMeta } from '../utils';
 
 import {
   DetectionOptions,
   detectTestingLibraryUtils,
   EnhancedRuleCreate,
 } from './detect-testing-library-utils';
 
-// These 2 types are copied from @typescript-eslint/experimental-utils
-type CreateRuleMetaDocs = Omit<TSESLint.RuleMetaDataDocs, 'url'>;
-type CreateRuleMeta<TMessageIds extends string> = {
-  docs: CreateRuleMetaDocs;
-} & Omit<TSESLint.RuleMetaData<TMessageIds>, 'docs'>;
-
 export function createTestingLibraryRule<
   TOptions extends readonly unknown[],
   TMessageIds extends string,
   TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener
 >({
   create,
   detectionOptions = {},
+  meta,
   ...remainingConfig
 }: Readonly<{
   name: string;
-  meta: CreateRuleMeta<TMessageIds>;
+  meta: TestingLibraryRuleMeta<TMessageIds>;
   defaultOptions: Readonly<TOptions>;
   detectionOptions?: Partial<DetectionOptions>;
   create: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>;
@@ -35,5 +30,12 @@ export function createTestingLibraryRule<
       create,
       detectionOptions
     ),
+    meta: {
+      ...meta,
+      docs: {
+        ...meta.docs,
+        recommended: false,
+      },
+    },
   });
 }

lib/rules/index.ts

@@ -3,9 +3,11 @@ import { join, parse } from 'path';
 
 import { TSESLint } from '@typescript-eslint/experimental-utils';
 
-import { importDefault } from '../utils';
+import { importDefault, TestingLibraryRuleMeta } from '../utils';
 
-type RuleModule = TSESLint.RuleModule<string, unknown[]>;
+type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
+  meta: TestingLibraryRuleMeta<string>;
+};
 
 const rulesDir = __dirname;
 const excludedFiles = ['index'];

lib/utils/types.ts

@@ -1,3 +1,20 @@
+import type { TSESLint } from '@typescript-eslint/experimental-utils';
+
+// These 2 types are copied from @typescript-eslint/experimental-utils' CreateRuleMeta
+// and modified to our needs
+type TestingLibraryRuleMetaDocs = Omit<
+  TSESLint.RuleMetaDataDocs,
+  'recommended' | 'url'
+> & {
+  recommended: Record<
+    SupportedTestingFramework,
+    TSESLint.RuleMetaDataDocs['recommended']
+  >;
+};
+export type TestingLibraryRuleMeta<TMessageIds extends string> = {
+  docs: TestingLibraryRuleMetaDocs;
+} & Omit<TSESLint.RuleMetaData<TMessageIds>, 'docs'>;
+
 export const SUPPORTED_TESTING_FRAMEWORKS = [
   'dom',
   'angular',

package.json

@@ -29,6 +29,7 @@
     "postbuild": "cpy README.md ./dist && cpy package.json ./dist && cpy LICENSE ./dist",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
+    "generate:configs": "ts-node tools/generate-configs",
     "lint": "eslint . --max-warnings 0 --ext .js,.ts",
     "lint:fix": "npm run lint -- --fix",
     "test": "jest",

tools/generate-configs/index.ts

@@ -0,0 +1,33 @@
+import type { LinterConfigRules } from '../../lib/configs';
+import rules from '../../lib/rules';
+import {
+  SUPPORTED_TESTING_FRAMEWORKS,
+  SupportedTestingFramework,
+} from '../../lib/utils';
+
+import { LinterConfig, writeConfig } from './utils';
+
+const RULE_NAME_PREFIX = 'testing-library/';
+
+const getRecommendedRulesForTestingFramework = (
+  framework: SupportedTestingFramework
+): LinterConfigRules =>
+  Object.entries(rules)
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    .filter(([_, { meta: { docs } }]) => Boolean(docs.recommended[framework]))
+    .reduce(
+      (allRules, [ruleName, { meta }]) => ({
+        ...allRules,
+        [ruleName.split(RULE_NAME_PREFIX)[0]]: meta.docs.recommended[framework],
+      }),
+      {}
+    );
+
+SUPPORTED_TESTING_FRAMEWORKS.forEach((framework) => {
+  const specificFrameworkConfig: LinterConfig = {
+    plugins: ['testing-library'],
+    rules: getRecommendedRulesForTestingFramework(framework),
+  };
+
+  writeConfig(specificFrameworkConfig, framework);
+});

tools/generate-configs/utils.ts

@@ -0,0 +1,33 @@
+import { writeFileSync } from 'fs';
+import { resolve } from 'path';
+
+import type { TSESLint } from '@typescript-eslint/experimental-utils';
+import { format, resolveConfig } from 'prettier';
+
+const prettierConfig = resolveConfig.sync(__dirname);
+
+export type LinterConfig = TSESLint.Linter.Config;
+
+const addAutoGeneratedComment = (code: string) =>
+  [
+    '// THIS CODE WAS AUTOMATICALLY GENERATED',
+    '// DO NOT EDIT THIS CODE BY HAND',
+    '// YOU CAN REGENERATE IT USING yarn generate:configs',
+    '',
+    code,
+  ].join('\n');
+
+/**
+ * Helper function writes configuration.
+ */
+export const writeConfig = (config: LinterConfig, configName: string): void => {
+  // note: we use `export =` because ESLint will import these configs via a commonjs import
+  const code = `export = ${JSON.stringify(config)};`;
+  const configStr = format(addAutoGeneratedComment(code), {
+    parser: 'typescript',
+    ...prettierConfig,
+  });
+  const filePath = resolve(__dirname, `../../lib/configs/${configName}.ts`);
+
+  writeFileSync(filePath, configStr);
+};