Skip to content

refactor: automatically generate all rules #346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 1 addition & 51 deletions lib/index.ts
Original file line number Diff line number Diff line change
@@ -1,54 +1,4 @@
import awaitAsyncQuery from './rules/await-async-query';
import awaitAsyncUtils from './rules/await-async-utils';
import awaitFireEvent from './rules/await-fire-event';
import consistentDataTestid from './rules/consistent-data-testid';
import noAwaitSyncEvents from './rules/no-await-sync-events';
import noAwaitSyncQuery from './rules/no-await-sync-query';
import noContainer from './rules/no-container';
import noDebug from './rules/no-debug';
import noDomImport from './rules/no-dom-import';
import noManualCleanup from './rules/no-manual-cleanup';
import noNodeAccess from './rules/no-node-access';
import noPromiseInFireEvent from './rules/no-promise-in-fire-event';
import noRenderInSetup from './rules/no-render-in-setup';
import noWaitForEmptyCallback from './rules/no-wait-for-empty-callback';
import noWaitForSnapshot from './rules/no-wait-for-snapshot';
import preferExplicitAssert from './rules/prefer-explicit-assert';
import preferPresenceQueries from './rules/prefer-presence-queries';
import preferScreenQueries from './rules/prefer-screen-queries';
import preferUserEvent from './rules/prefer-user-event';
import preferWaitFor from './rules/prefer-wait-for';
import noWaitForMultipleAssertions from './rules/no-wait-for-multiple-assertions';
import preferFindBy from './rules/prefer-find-by';
import noWaitForSideEffects from './rules/no-wait-for-side-effects';
import renderResultNamingConvention from './rules/render-result-naming-convention';

const rules = {
'await-async-query': awaitAsyncQuery,
'await-async-utils': awaitAsyncUtils,
'await-fire-event': awaitFireEvent,
'consistent-data-testid': consistentDataTestid,
'no-await-sync-events': noAwaitSyncEvents,
'no-await-sync-query': noAwaitSyncQuery,
'no-container': noContainer,
'no-debug': noDebug,
'no-dom-import': noDomImport,
'no-manual-cleanup': noManualCleanup,
'no-node-access': noNodeAccess,
'no-promise-in-fire-event': noPromiseInFireEvent,
'no-render-in-setup': noRenderInSetup,
'no-wait-for-empty-callback': noWaitForEmptyCallback,
'no-wait-for-multiple-assertions': noWaitForMultipleAssertions,
'no-wait-for-side-effects': noWaitForSideEffects,
'no-wait-for-snapshot': noWaitForSnapshot,
'prefer-explicit-assert': preferExplicitAssert,
'prefer-find-by': preferFindBy,
'prefer-presence-queries': preferPresenceQueries,
'prefer-screen-queries': preferScreenQueries,
'prefer-user-event': preferUserEvent,
'prefer-wait-for': preferWaitFor,
'render-result-naming-convention': renderResultNamingConvention,
};
import rules from './rules';

const domRules = {
'testing-library/await-async-query': 'error',
Expand Down
29 changes: 29 additions & 0 deletions lib/rules/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { readdirSync } from 'fs';
import { join, parse } from 'path';

import { TSESLint } from '@typescript-eslint/experimental-utils';

type RuleModule = TSESLint.RuleModule<string, unknown[]>;

// Copied from https://github.com/babel/babel/blob/b35c78f08dd854b08575fc66ebca323fdbc59dab/packages/babel-helpers/src/helpers.js#L615-L619
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const interopRequireDefault = (obj: any): { default: unknown } =>
obj?.__esModule ? obj : { default: obj };

const importDefault = (moduleName: string) =>
// eslint-disable-next-line @typescript-eslint/no-var-requires
interopRequireDefault(require(moduleName)).default;

const rulesDir = __dirname;
const excludedFiles = ['index'];

export default readdirSync(rulesDir)
.map((rule) => parse(rule).name)
.filter((ruleName) => !excludedFiles.includes(ruleName))
.reduce<Record<string, RuleModule>>(
(allRules, ruleName) => ({
...allRules,
[ruleName]: importDefault(join(rulesDir, ruleName)) as RuleModule,
}),
{}
);