chore: resolve remarks

Author: MichaelDeBoey

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

@@ -34,6 +34,8 @@ export function createTestingLibraryRule<
       ...meta,
       docs: {
         ...meta.docs,
+        // We're using our own recommendedConfig meta to tell our build tools
+        // if the rule is recommended on a config basis
         recommended: false,
       },
     },

lib/utils/types.ts

@@ -10,6 +10,11 @@ type TestingLibraryRuleMetaDocs<TOptions extends readonly unknown[]> = Omit<
   TSESLint.RuleMetaDataDocs,
   'recommended' | 'url'
 > & {
+  /**
+   * The recommendation level for the rule on a framework basis.
+   * Used by the build tools to generate the framework config.
+   * Set to false to not include it the config
+   */
   recommendedConfig: Record<
     SupportedTestingFramework,
     RecommendedConfig<TOptions>

tests/__snapshots__/index.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`should export configs that refer to actual rules 1`] = `
+exports[`should have run 'generate:configs' script when changing config rules 1`] = `
 Object {
   "angular": Object {
     "plugins": Array [

tests/index.test.ts

@@ -1,8 +1,11 @@
+import { exec } from 'child_process';
 import { existsSync } from 'fs';
 import { resolve } from 'path';
 
 import plugin from '../lib';
 
+const generateConfigs = () => exec(`npm run generate:configs`);
+
 const numberOfRules = 24;
 const ruleNames = Object.keys(plugin.rules);
 
@@ -43,10 +46,16 @@ it('should have the correct amount of rules', () => {
   }
 });
 
+it("should have run 'generate:configs' script when changing config rules", async () => {
+  await generateConfigs();
+
+  const allConfigs = plugin.configs;
+  expect(allConfigs).toMatchSnapshot();
+});
+
 it('should export configs that refer to actual rules', () => {
   const allConfigs = plugin.configs;
 
-  expect(allConfigs).toMatchSnapshot();
   expect(Object.keys(allConfigs)).toEqual(['dom', 'angular', 'react', 'vue']);
   const allConfigRules = Object.values(allConfigs)
     .map((config) => Object.keys(config.rules))