Clean up FIXMEs

Author: gitKrystan

transforms/helpers/decorator-helper.ts

@@ -14,7 +14,7 @@ export function withDecorators<T>(to: T, decorators: Decorator[] = []): T {
 
 type CallExpressionArg = Parameters<JSCodeshift['callExpression']>[1][number];
 
-/** FIXME: Document */
+/** Creates a decorator for a class. */
 export function createClassDecorator(
   j: JSCodeshift,
   classDecoratorProp: EOClassDecoratorProp

transforms/helpers/eo-prop/index.ts

@@ -34,7 +34,10 @@ export interface EOProps {
   instanceProps: EOProp[];
 }
 
-/** FIXME */
+/**
+ * Makes an object representing an Ember Object property for the given
+ * Property, RuntimeData, and ImportPropDecoratorMap.
+ */
 export default function makeEOProp(
   eoProp: Property,
   runtimeData: RuntimeData | undefined,

transforms/helpers/import-helper.ts

@@ -324,7 +324,7 @@ export function getImportedDecoratedProps(
     for (const specifier of specifiers) {
       if (isSpecifierDecorator(specifier, importPropDecoratorMap)) {
         const localName = specifier.local?.name;
-        assert(localName, 'expected localName'); // FIXME: Do we hit this?
+        assert(localName, 'expected localName');
         importedDecorators[localName] = getDecoratorInfo(
           specifier,
           importPropDecoratorMap

transforms/helpers/options.ts

@@ -9,7 +9,7 @@ export interface Options {
   classicDecorator: boolean;
   /** Whether to use double or single quotes by default for new statements that are added during the codemod. */
   quote: 'single' | 'double';
-  quotes?: 'single' | 'double'; // FIXME: Why both singular and plural?
+  quotes?: 'single' | 'double';
   /** Apply transformation to only passed type. */
   type?: 'services' | 'routes' | 'components' | 'controllers';
   /** @private */

transforms/helpers/parse-helper.ts

@@ -20,8 +20,10 @@ import {
   getImportedDecoratedProps,
 } from './import-helper';
 import logger from './log-helper';
+import type { Options } from './options';
 import { DEFAULT_OPTIONS } from './options';
 import type { RuntimeData } from './runtime-data';
+import { isRuntimeData } from './runtime-data';
 import { createClass, withComments } from './transform-helper';
 import { capitalizeFirstLetter, dig, startsWithUpperCaseLetter } from './util';
 import {
@@ -274,10 +276,7 @@ export function replaceEmberObjectExpressions(
 ): boolean | undefined {
   options.runtimeData = verified(
     getTelemetryFor(path.resolve(filePath)),
-    // FIXME: move to runtime-data.ts
-    function isRuntimeData(v: unknown): v is RuntimeData | undefined {
-      return v === undefined || isRecord(v);
-    }
+    isRuntimeData
   );
 
   if (!options.runtimeData) {
@@ -303,6 +302,40 @@ export function replaceEmberObjectExpressions(
   let transformed = false;
   let decoratorsToImportMap: Partial<DecoratorsToImportMap> = {};
 
+  ({ transformed, decoratorsToImportMap } = transform(
+    j,
+    root,
+    importedDecoratedProps,
+    options,
+    filePath,
+    transformed,
+    decoratorsToImportMap
+  ));
+
+  // Need to find another way, as there might be a case where
+  // one object from a file is transformed and other is not
+  if (transformed) {
+    const decoratorsToImport = Object.keys(decoratorsToImportMap).filter(
+      (key) => decoratorsToImportMap[key as keyof DecoratorsToImportMap]
+    );
+    createDecoratorImportDeclarations(j, root, decoratorsToImport, options);
+    logger.info(`[${filePath}]: SUCCESS`);
+  }
+  return transformed;
+}
+
+function transform(
+  j: JSCodeshift,
+  root: Collection<unknown>,
+  importedDecoratedProps: ImportPropDecoratorMap,
+  options: Options,
+  filePath: string,
+  transformed: boolean,
+  decoratorsToImportMap: Partial<DecoratorsToImportMap>
+): {
+  transformed: boolean;
+  decoratorsToImportMap: Partial<DecoratorsToImportMap>;
+} {
   // eslint-disable-next-line unicorn/no-array-for-each
   getEmberObjectCallExpressions(j, root).forEach((eoCallExpression) => {
     const { eoExpression, mixins } =
@@ -373,16 +406,5 @@ export function replaceEmberObjectExpressions(
     );
   });
 
-  // Need to find another way, as there might be a case where
-  // one object from a file is transformed and other is not
-  // FIXME: Is this always falsy?
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (transformed) {
-    const decoratorsToImport = Object.keys(decoratorsToImportMap).filter(
-      (key) => decoratorsToImportMap[key as keyof DecoratorsToImportMap]
-    );
-    createDecoratorImportDeclarations(j, root, decoratorsToImport, options);
-    logger.info(`[${filePath}]: SUCCESS`);
-  }
-  return transformed;
+  return { transformed, decoratorsToImportMap };
 }

transforms/helpers/runtime-data.ts

@@ -1,3 +1,5 @@
+import { isRecord } from './util/types';
+
 export interface RuntimeData {
   type?: string;
   computedProperties?: string[];
@@ -9,3 +11,8 @@ export interface RuntimeData {
     Array<string | boolean | number | null>
   >;
 }
+
+/** Type predicate */
+export function isRuntimeData(v: unknown): v is RuntimeData | undefined {
+  return v === undefined || isRecord(v);
+}

transforms/helpers/util/types.ts

@@ -25,9 +25,6 @@ export function assert(
   message = 'Assertion Error'
 ): asserts condition {
   if (!condition) {
-    // FIXME
-    // eslint-disable-next-line no-debugger
-    debugger;
     throw new Error(message);
   }
 }

transforms/helpers/validation-helper.ts

@@ -33,7 +33,7 @@ export function isTestFile(file: string): boolean {
  */
 export function isFileOfType(file: string, type: Options['type']): boolean {
   return (
-    // FIXME: False positive?
+    // False positive
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     !!type && !!TYPE_PATTERNS[type] && minimatch(file, TYPE_PATTERNS[type])
   );