Don't run codemod on files that don't match the available types

Author: gitKrystan

.vscode/settings.json

@@ -1,6 +1,10 @@
 {
   "editor.formatOnSave": true,
   "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true,
+    "source.organizeImports": true
+  },
   "typescript.preferences.importModuleSpecifierEnding": "index",
   "typescript.suggest.autoImports": true
 }

transforms/ember-object/index.ts

@@ -33,11 +33,13 @@ const transformer: Transform = function (
 
     const userOptions = getConfig();
 
-    if (userOptions.type && !isFileOfType(filePath, userOptions.type)) {
-      logger.info({
-        filePath,
-        info: `SKIPPED: Type mismatch, expected type '${userOptions.type}' did not match type of file`,
-      });
+    if (!isFileOfType(filePath, userOptions.type)) {
+      if (userOptions.type) {
+        logger.info({
+          filePath,
+          info: `SKIPPED: Type mismatch, expected type '${userOptions.type}' did not match type of file`,
+        });
+      }
       return; // status: 'skipped'
     }
 

transforms/helpers/options.ts

@@ -7,6 +7,7 @@ import {
   StringBooleanSchema,
   StringFalseSchema,
 } from './schema-helper';
+import { twoOrMoreMap } from './util/types';
 
 const DEFAULT_DECORATOR_CONFIG = {
   inObjectLiterals: [],
@@ -49,20 +50,21 @@ const QuoteSchema = z.union([z.literal('single'), z.literal('double')], {
   },
 });
 
+export const TYPES = [
+  'services',
+  'routes',
+  'components',
+  'controllers',
+] as const;
+
 const TypeSchema = z.union(
-  [
-    z.literal('services'),
-    z.literal('routes'),
-    z.literal('components'),
-    z.literal('controllers'),
-  ],
+  twoOrMoreMap(TYPES, (type) => z.literal(type)),
   {
     errorMap: (issue, ctx) => {
       if (issue.code === z.ZodIssueCode.invalid_union) {
+        const expected = TYPES.map((type) => `'${type}'`).join(' or ');
         return {
-          message: `Expected 'services', 'routes', 'components', or 'controllers', received ${inspect(
-            ctx.data
-          )}`,
+          message: `Expected ${expected}, received ${inspect(ctx.data)}`,
         };
       }
       return { message: ctx.defaultError };

transforms/helpers/util/types.ts

@@ -40,3 +40,14 @@ export function defined<T>(
   assert(value !== undefined, message);
   return value;
 }
+
+/**
+ * Wraps Array.map in a type-check that the initial array has at least two
+ * items, then returns an array asserting that it has the same number of items.
+ */
+export function twoOrMoreMap<T, U>(
+  array: readonly [T, T, ...T[]],
+  callbackfn: (value: T, index: number, array: readonly T[]) => U
+): [U, U, ...U[]] {
+  return array.map(callbackfn) as unknown as [U, U, ...U[]];
+}

transforms/helpers/validation-helper.ts

@@ -1,16 +1,12 @@
 import { minimatch } from 'minimatch';
-import type { Options } from './options';
+import { TYPES, type Options } from './options';
+import { defined } from './util/types';
 
-const TYPE_PATTERNS = {
-  service: '**/services/**/*.js',
-  services: '**/services/**/*.js',
-  controller: '**/controllers/**/*.js',
-  controllers: '**/controllers/**/*.js',
-  component: '**/components/**/*.js',
-  components: '**/components/**/*.js',
-  route: '**/routes/**/*.js',
-  routes: '**/routes/**/*.js',
-} as const;
+const TYPE_PATTERNS = new Map(
+  TYPES.map((type) => [type, `**/${type}/**/*.js`])
+);
+
+const ANY_TYPE_PATTERN = `**/(${TYPES.join('|')})/**/*.js`;
 
 const TEST_FILE_PATTERN = '**/*-test.js' as const;
 
@@ -24,9 +20,6 @@ export function isTestFile(file: string): boolean {
  * The glob patterns are specified by `TYPE_PATTERNS`
  */
 export function isFileOfType(file: string, type: Options['type']): boolean {
-  return (
-    // False positive
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    !!type && !!TYPE_PATTERNS[type] && minimatch(file, TYPE_PATTERNS[type])
-  );
+  const pattern = type ? defined(TYPE_PATTERNS.get(type)) : ANY_TYPE_PATTERN;
+  return minimatch(file, pattern);
 }