fix: Use kebab case for exported rule names (#3)

adamhamlin · Jan 17, 2023 · 4ef1cf4 · 4ef1cf4
1 parent 4e32dc1
commit 4ef1cf4
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 17 deletions.
diff --git a/__tests__/rules/forbid-pattern-everywhere.test.ts b/__tests__/rules/forbid-pattern-everywhere.test.ts
@@ -1,15 +1,15 @@
 import { TestCaseError } from '@typescript-eslint/utils/dist/ts-eslint';
 import dedent from 'dedent';
 
-import rule from '../../src/rules/forbid-pattern-everywhere';
+import { name, rule } from '../../src/rules/forbid-pattern-everywhere';
 import { ruleTester } from '../rule-tester';
 
 describe('Rule Tests', () => {
     function getErrors(pattern: string): TestCaseError<'disallowedPattern'>[] {
         return [{ messageId: `disallowedPattern`, data: { pattern } }];
     }
 
-    ruleTester.run('forbid-pattern-everywhere', rule, {
+    ruleTester.run(name, rule, {
         valid: [
             {
                 // No options/patterns specified

diff --git a/__tests__/rules/no-empty-block-comment.test.ts b/__tests__/rules/no-empty-block-comment.test.ts
@@ -1,12 +1,12 @@
 import dedent from 'dedent';
 
-import rule from '../../src/rules/no-empty-block-comment';
+import { name, rule } from '../../src/rules/no-empty-block-comment';
 import { ruleTester } from '../rule-tester';
 
 describe('Rule Tests', () => {
     const errors = [{ messageId: 'nonEmptyBlockComment' as const }];
 
-    ruleTester.run('no-empty-block-comment', rule, {
+    ruleTester.run(name, rule, {
         valid: [
             {
                 code: dedent`

diff --git a/index.ts b/index.ts
@@ -0,0 +1,7 @@
+import excludePatternEverywhere from './src/rules/forbid-pattern-everywhere';
+import noEmptyBlockComment from './src/rules/no-empty-block-comment';
+
+export const rules = {
+    [excludePatternEverywhere.name]: excludePatternEverywhere.rule,
+    [noEmptyBlockComment.name]: noEmptyBlockComment.rule,
+};
diff --git a/jest.config.ts b/jest.config.ts
@@ -21,7 +21,7 @@ export default async (): Promise<Config.InitialOptions> => ({
     coverageDirectory: '<rootDir>/coverage',
 
     // An array of regexp pattern strings used to skip coverage collection
-    coveragePathIgnorePatterns: ['<rootDir>/src/index.ts'],
+    // coveragePathIgnorePatterns: ['<rootDir>/src/index.ts'],
 
     // Indicates which provider should be used to instrument code for coverage
     // coverageProvider: 'v8',

diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
         "/docs"
     ],
     "scripts": {
-        "prepare": "husky install",
+        "prepare": "husky install && npm run compile",
         "_lint": "eslint --fix",
         "_lint:check": "eslint",
         "eslint-docs": "eslint-doc-generator",

diff --git a/src/index.ts b/src/index.ts
diff --git a/src/rules/forbid-pattern-everywhere.ts b/src/rules/forbid-pattern-everywhere.ts
@@ -2,8 +2,9 @@ import { TSESTree } from '@typescript-eslint/utils';
 
 import { createRule } from '../utils/create-rule';
 
-export default createRule({
-    name: 'forbid-pattern-everywhere',
+export const name = 'forbid-pattern-everywhere';
+export const rule = createRule({
+    name,
     meta: {
         type: 'layout',
         messages: {
@@ -75,3 +76,5 @@ export default createRule({
         };
     },
 });
+
+export default { name, rule };
diff --git a/src/rules/no-empty-block-comment.ts b/src/rules/no-empty-block-comment.ts
@@ -2,8 +2,9 @@ import { TSESTree } from '@typescript-eslint/utils';
 
 import { createRule } from '../utils/create-rule';
 
-export default createRule({
-    name: 'no-empty-block-comment',
+export const name = 'no-empty-block-comment';
+export const rule = createRule({
+    name,
     meta: {
         type: 'layout',
         messages: {
@@ -45,3 +46,5 @@ export default createRule({
         };
     },
 });
+
+export default { name, rule };