feat: update filename-* rules to use options object

BREAKING CHANGE: filename- rules now expect options object.
gajus · Feb 8, 2023 · 3283274 · 3283274
1 parent affde54
commit 3283274
Show file tree

Hide file tree

Showing 20 changed files with 252 additions and 192 deletions.
diff --git a/.README/rules/filename-match-exported.md b/.README/rules/filename-match-exported.md
@@ -19,7 +19,7 @@ export default { foo: "bar" };
 If your filename policy doesn't quite match with your variable naming policy, you can add one or multiple transforms:
 
 ```json
-"canonical/filename-match-exported": [ 2, "kebab" ]
+"canonical/filename-match-exported": [ 2, { "transforms": "kebab" } ]
 ```
 
 Now, in your code:
@@ -31,21 +31,21 @@ export default function variableName;
 
 Available transforms:
 
-* snake
-* kebab
-* camel
-* pascal
+* `snake`
+* `kebab`
+* `camel`
+* `pascal`
 
 For multiple transforms simply specify an array like this (null in this case stands for no transform):
 
 ```json
-"canonical/filename-match-exported": [2, [ null, "kebab", "snake" ] ]
+"canonical/filename-match-exported": [2, { "transforms": [ null, "kebab", "snake" ] } ]
 ```
 
 If you prefer to use suffixes for your files (e.g. `Foo.react.js` for a React component file), you can use a second configuration parameter. It allows you to remove parts of a filename matching a regex pattern before transforming and matching against the export.
 
 ```json
-"canonical/filename-match-exported": [ 2, null, "\\.react$" ]
+"canonical/filename-match-exported": [ 2, { "suffix": "\\.react$" } ]
 ```
 
 Now, in your code:
@@ -58,7 +58,7 @@ export default function variableName;
 If you also want to match exported function calls you can use the third option (a boolean flag).
 
 ```json
-"canonical/filename-match-exported": [ 2, null, null, true ]
+"canonical/filename-match-exported": [ 2, { "matchCallExpression": true } ]
 ```
 
 Now, in your code:

diff --git a/.README/rules/filename-match-regex.md b/.README/rules/filename-match-regex.md
@@ -6,7 +6,7 @@ The convention can be configured using a regular expression (the default is `cam
 exporting files can be ignored with a second configuration parameter.
 
 ```json
-"canonical/filename-match-regex": [2, "^[a-z_]+$", true]
+"canonical/filename-match-regex": [2, { "regex": "^[a-z_]+$", "ignoreExporting": true }]
 ```
 
 With these configuration options, `camelCase.js` will be reported as an error while `snake_case.js` will pass.

diff --git a/README.md b/README.md
@@ -156,7 +156,7 @@ export default { foo: "bar" };
 If your filename policy doesn't quite match with your variable naming policy, you can add one or multiple transforms:
 
 ```json
-"canonical/filename-match-exported": [ 2, "kebab" ]
+"canonical/filename-match-exported": [ 2, { "transforms": "kebab" } ]
 ```
 
 Now, in your code:
@@ -168,21 +168,21 @@ export default function variableName;
 
 Available transforms:
 
-* snake
-* kebab
-* camel
-* pascal
+* `snake`
+* `kebab`
+* `camel`
+* `pascal`
 
 For multiple transforms simply specify an array like this (null in this case stands for no transform):
 
 ```json
-"canonical/filename-match-exported": [2, [ null, "kebab", "snake" ] ]
+"canonical/filename-match-exported": [2, { "transforms": [ null, "kebab", "snake" ] } ]
 ```
 
 If you prefer to use suffixes for your files (e.g. `Foo.react.js` for a React component file), you can use a second configuration parameter. It allows you to remove parts of a filename matching a regex pattern before transforming and matching against the export.
 
 ```json
-"canonical/filename-match-exported": [ 2, null, "\\.react$" ]
+"canonical/filename-match-exported": [ 2, { "suffix": "\\.react$" } ]
 ```
 
 Now, in your code:
@@ -195,7 +195,7 @@ export default function variableName;
 If you also want to match exported function calls you can use the third option (a boolean flag).
 
 ```json
-"canonical/filename-match-exported": [ 2, null, null, true ]
+"canonical/filename-match-exported": [ 2, { "matchCallExpression": true } ]
 ```
 
 Now, in your code:

diff --git a/src/rules/destructuringPropertyNewline.ts b/src/rules/destructuringPropertyNewline.ts
@@ -1,9 +1,15 @@
 import { createRule } from '../utilities';
 
-export default createRule({
-  create(context) {
-    const allowAllPropertiesOnSameLine =
-      context.options[0]?.allowAllPropertiesOnSameLine;
+type Options = [
+  {
+    allowAllPropertiesOnSameLine: boolean;
+  },
+];
+
+type MessageIds = 'propertiesOnNewline' | 'propertiesOnNewlineAll';
+
+export default createRule<Options, MessageIds>({
+  create(context, [{ allowAllPropertiesOnSameLine }]) {
     const messageId = allowAllPropertiesOnSameLine
       ? 'propertiesOnNewlineAll'
       : 'propertiesOnNewline';

diff --git a/src/rules/exportSpecifierNewline.ts b/src/rules/exportSpecifierNewline.ts
@@ -1,6 +1,10 @@
 import { createRule } from '../utilities';
 
-export default createRule({
+type Options = [];
+
+type MessageIds = 'specifiersOnNewline';
+
+export default createRule<Options, MessageIds>({
   create: (context) => {
     return {
       ExportNamedDeclaration: (node) => {

diff --git a/src/rules/filenameMatchExported.ts b/src/rules/filenameMatchExported.ts
@@ -64,108 +64,114 @@ const getWhatToMatchMessage = (transforms) => {
   return 'the exported and transformed name';
 };
 
-const create = (context) => {
-  return {
-    Program(node) {
-      const transforms = getTransformsFromOptions(context.options[0]);
-      const replacePattern = context.options[1]
-        ? new RegExp(context.options[1], 'u')
-        : undefined;
-      const filename = context.getFilename();
-      const absoluteFilename = path.resolve(filename);
-      const parsed = parseFilename(absoluteFilename);
-      const shouldIgnore = isIgnoredFilename(filename);
-      const exportedName = getExportedName(node, context.options);
-      const isExporting = Boolean(exportedName);
-      const expectedExport = getStringToCheckAgainstExport(
-        parsed,
-        replacePattern,
-      );
-      const transformedNames = transform(exportedName, transforms);
-      const everythingIsIndex =
-        exportedName === 'index' && parsed.name === 'index';
-      const matchesExported =
-        anyMatch(expectedExport, transformedNames) || everythingIsIndex;
-      const reportIf = function (
-        condition,
-        messageForNormalFile,
-        messageForIndexFile,
-      ) {
-        const message =
-          !messageForIndexFile || !isIndexFile(parsed)
-            ? messageForNormalFile
-            : messageForIndexFile;
-
-        if (condition) {
-          context.report({
-            data: {
-              expectedExport,
-              exportName: transformedNames.join("', '"),
-              extension: parsed.ext,
-              name: parsed.base,
-              whatToMatch: getWhatToMatchMessage(transforms),
-            },
-            message,
-            node,
-          });
+type Options = [
+  {
+    matchCallExpression: boolean;
+    suffix: string | null;
+    transforms: string[] | string | null;
+  },
+];
+
+type MessageIds = 'indexFile' | 'regularFile';
+
+export default createRule<Options, MessageIds>({
+  create: (context, options) => {
+    return {
+      Program(node) {
+        const transforms = getTransformsFromOptions(options[0].transforms);
+        const replacePattern = options[0].suffix
+          ? new RegExp(options[0].suffix, 'u')
+          : undefined;
+        const filename = context.getFilename();
+        const absoluteFilename = path.resolve(filename);
+        const parsed = parseFilename(absoluteFilename);
+        const shouldIgnore = isIgnoredFilename(filename);
+        const exportedName = getExportedName(
+          node,
+          options[0].matchCallExpression,
+        );
+        const isExporting = Boolean(exportedName);
+        const expectedExport = getStringToCheckAgainstExport(
+          parsed,
+          replacePattern,
+        );
+        const transformedNames = transform(exportedName, transforms);
+        const everythingIsIndex =
+          exportedName === 'index' && parsed.name === 'index';
+        const matchesExported =
+          anyMatch(expectedExport, transformedNames) || everythingIsIndex;
+
+        if (shouldIgnore || !isExporting || matchesExported) {
+          return;
         }
-      };
-
-      if (shouldIgnore) {
-        return;
-      }
 
-      reportIf(
-        isExporting && !matchesExported,
-        "Filename '{{expectedExport}}' must match {{whatToMatch}} '{{exportName}}'.",
-        "The directory '{{expectedExport}}' must be named '{{exportName}}', after the exported value of its index file.",
-      );
+        context.report({
+          data: {
+            expectedExport,
+            exportName: transformedNames.join("', '"),
+            extension: parsed.ext,
+            name: parsed.base,
+            whatToMatch: getWhatToMatchMessage(transforms),
+          },
+          messageId: isIndexFile(parsed) ? 'indexFile' : 'regularFile',
+          node,
+        });
+      },
+    };
+  },
+  defaultOptions: [
+    {
+      matchCallExpression: false,
+      suffix: null,
+      transforms: null,
     },
-  };
-};
-
-export default createRule({
-  create,
-  defaultOptions: [],
+  ],
   meta: {
     docs: {
       description:
         'Match the file name against the default exported value in the module.',
       recommended: 'warn',
     },
-    messages: {},
+    messages: {
+      indexFile:
+        "The directory '{{expectedExport}}' must be named '{{exportName}}', after the exported value of its index file.",
+      regularFile:
+        "Filename '{{expectedExport}}' must match {{whatToMatch}} '{{exportName}}'.",
+    },
     schema: [
       {
-        anyOf: [
-          {
-            items: {
-              type: 'string',
-            },
-            type: 'array',
+        properties: {
+          matchCallExpression: {
+            type: 'boolean',
           },
-          {
-            type: 'string',
+          suffix: {
+            oneOf: [
+              {
+                type: 'string',
+              },
+              {
+                type: 'null',
+              },
+            ],
           },
-          {
-            type: 'null',
+          transforms: {
+            oneOf: [
+              {
+                items: {
+                  type: 'string',
+                },
+                type: 'array',
+              },
+              {
+                type: 'string',
+              },
+              {
+                type: 'null',
+              },
+            ],
           },
-        ],
-        default: null,
-      },
-      {
-        default: null,
-        oneOf: [
-          {
-            type: 'string',
-          },
-          {
-            type: 'null',
-          },
-        ],
-      },
-      {
-        default: false,
-        type: 'boolean',
+        },
+        type: 'object',
       },
     ],
     type: 'suggestion',