Stop passing around jscodeshift

gitKrystan · gitKrystan · commit d66c3c291724 · 2023-02-14T13:21:35.000-08:00
diff --git a/transforms/ember-object/index.ts b/transforms/ember-object/index.ts
@@ -16,7 +16,7 @@ const transformer: Transform = function (
 
   const root = j(source) as AST.Collection;
   const userOptions = getConfig();
-  const replaced = maybeTransformEmberObjects(j, root, filePath, userOptions);
+  const replaced = maybeTransformEmberObjects(root, filePath, userOptions);
 
   if (replaced) {
     source = root.toSource({
diff --git a/transforms/helpers/eo-extend-expression.ts b/transforms/helpers/eo-extend-expression.ts
@@ -6,9 +6,9 @@ import type { EOClassDecorator, EOProp } from './eo-prop/index';
 import makeEOProp from './eo-prop/index';
 import logger from './log-helper';
 import type { Options } from './options';
-import type { DecoratorImportSpecs } from './parse-helper';
 import { getClassName, getExpressionToReplace } from './parse-helper';
 import { withComments } from './transform-helper';
+import type { DecoratorImportSpecs } from './util/index';
 
 export default class EOExtendExpression {
   private className: string;
@@ -71,7 +71,7 @@ export default class EOExtendExpression {
   transform(): boolean {
     const es6ClassDeclaration = this.build();
     if (es6ClassDeclaration) {
-      const expressionToReplace = getExpressionToReplace(j, this.path);
+      const expressionToReplace = getExpressionToReplace(this.path);
       j(expressionToReplace).replaceWith(
         withComments(es6ClassDeclaration, expressionToReplace.value)
       );
diff --git a/transforms/helpers/eo-prop/private/abstract.ts b/transforms/helpers/eo-prop/private/abstract.ts
@@ -1,8 +1,8 @@
 import * as AST from '../../ast';
 import type { DecoratorImportInfo } from '../../decorator-info';
 import type { Options } from '../../options';
-import type { DecoratorImportSpecs } from '../../parse-helper';
 import type { RuntimeData } from '../../runtime-data';
+import type { DecoratorImportSpecs } from '../../util/index';
 import {
   DECORATORS_REQUIRED_PROP_NAMES,
   OFF_DECORATOR_NAME,
diff --git a/transforms/helpers/eo-prop/private/actions/index.ts b/transforms/helpers/eo-prop/private/actions/index.ts
@@ -1,5 +1,5 @@
 import * as AST from '../../../ast';
-import type { DecoratorImportSpecs } from '../../../parse-helper';
+import type { DecoratorImportSpecs } from '../../../util/index';
 import { LIFECYCLE_HOOKS } from '../../../util/index';
 import AbstractEOProp from '../abstract';
 import EOActionMethod from './method';
diff --git a/transforms/helpers/eo-prop/private/class-decorator.ts b/transforms/helpers/eo-prop/private/class-decorator.ts
@@ -1,6 +1,6 @@
 import type * as AST from '../../ast';
 import { createClassDecorator } from '../../decorator-helper';
-import type { DecoratorImportSpecs } from '../../parse-helper';
+import type { DecoratorImportSpecs } from '../../util/index';
 import {
   ATTRIBUTE_BINDINGS_DECORATOR_NAME,
   CLASS_NAMES_DECORATOR_NAME,
diff --git a/transforms/helpers/import-helper.ts b/transforms/helpers/import-helper.ts
@@ -1,4 +1,4 @@
-import type { JSCodeshift } from 'jscodeshift';
+import { default as j } from 'jscodeshift';
 import * as AST from '../helpers/ast';
 import type { DecoratorImportInfoMap } from './decorator-info';
 import { getDecoratorImportInfo } from './decorator-info';
@@ -62,13 +62,12 @@ function setSpecifierNames(
 
 /** Get decorated props from `import` statements */
 function getExistingDecoratorImports(
-  j: JSCodeshift,
   root: AST.Collection
 ): Array<AST.Path<AST.DecoratorImportDeclaration>> {
   const imports: Array<AST.Path<AST.DecoratorImportDeclaration>> = [];
 
   for (const path in Object.fromEntries(DECORATOR_PATHS)) {
-    const decoratorImport = getExistingImportForPath(j, root, path);
+    const decoratorImport = getExistingImportForPath(root, path);
     if (decoratorImport) {
       imports.push(decoratorImport);
     }
@@ -84,7 +83,6 @@ function getExistingDecoratorImports(
  * `@ember-decorators/component`
  */
 function createNewImportDeclarations(
-  j: JSCodeshift,
   root: AST.Collection,
   decoratorsToImport: string[],
   /** Already imported paths */
@@ -93,11 +91,9 @@ function createNewImportDeclarations(
 ): void {
   const firstDeclaration = AST.getFirstDeclaration(root);
 
-  // FIXME: Why is this necessary?
   if (options.classicDecorator) {
     firstDeclaration.insertBefore(
       createImportDeclaration(
-        j,
         [j.importDefaultSpecifier(j.identifier('classic'))],
         'ember-classic-decorator'
       )
@@ -113,15 +109,12 @@ function createNewImportDeclarations(
 
   for (const path of paths) {
     const specifiers = createEmberDecoratorSpecifiers(
-      j,
       edPathNameMap.get(path),
       decoratorsToImport
     ).sort((a, b) => a.imported.name.localeCompare(b.imported.name));
 
     if (specifiers.length > 0) {
-      firstDeclaration.insertBefore(
-        createImportDeclaration(j, specifiers, path)
-      );
+      firstDeclaration.insertBefore(createImportDeclaration(specifiers, path));
     }
   }
 }
@@ -137,15 +130,14 @@ function createNewImportDeclarations(
  * ```
  */
 function getDecoratorPathSpecifiers(
-  j: JSCodeshift,
   root: AST.Collection,
   decoratorsToImport: string[] = []
 ): Record<string, AST.ImportSpecifier[]> {
   const edPathNameMap = new Map(EMBER_DECORATOR_SPECIFIERS);
 
   const decoratorPathSpecifierMap: Record<string, AST.ImportSpecifier[]> = {};
 
-  const existingDecoratorImports = getExistingDecoratorImports(j, root);
+  const existingDecoratorImports = getExistingDecoratorImports(root);
 
   // Iterate over the existing imports
   // Extract and process the specifiers
@@ -166,7 +158,6 @@ function getDecoratorPathSpecifiers(
     // Create decorator specifiers for which no existing specifiers present in the current path
     // e.g. `actions` need not to be imported but `@action` need to be imported from `@ember-decorators/object`
     const decoratedSpecifiers = createEmberDecoratorSpecifiers(
-      j,
       decoratorsForPath,
       decoratorsToImport
     );
@@ -226,7 +217,6 @@ function getDecoratorPathSpecifiers(
 
 /** Get existing import statement matching the import path */
 function getExistingImportForPath(
-  j: JSCodeshift,
   root: AST.Collection,
   importPath: string
 ): AST.Path<AST.DecoratorImportDeclaration> | undefined {
@@ -244,14 +234,12 @@ function getExistingImportForPath(
  * 3. Insert the new imports for which no existing imports found
  */
 export function createDecoratorImportDeclarations(
-  j: JSCodeshift,
   root: AST.Collection,
   decoratorsToImport: string[],
   options: Options
 ): void {
   // Iterate through existing imports, extract the already imported specifiers
   const decoratorPathSpecifierMap = getDecoratorPathSpecifiers(
-    j,
     root,
     decoratorsToImport
   );
@@ -261,7 +249,7 @@ export function createDecoratorImportDeclarations(
   // Create import statement replacing the existing ones with specifiers importing from ember-decorators namespace
   for (const decoratorPath of decoratorPathsImported) {
     const specifiers = defined(decoratorPathSpecifierMap[decoratorPath]);
-    const existingImport = getExistingImportForPath(j, root, decoratorPath);
+    const existingImport = getExistingImportForPath(root, decoratorPath);
     if (existingImport) {
       const existingSpecifiers = existingImport.value.specifiers;
       if (existingSpecifiers) {
@@ -272,14 +260,13 @@ export function createDecoratorImportDeclarations(
       }
     } else {
       firstDeclaration.insertBefore(
-        createImportDeclaration(j, specifiers, decoratorPath)
+        createImportDeclaration(specifiers, decoratorPath)
       );
     }
   }
 
   // Create new import declarations
   createNewImportDeclarations(
-    j,
     root,
     decoratorsToImport,
     decoratorPathsImported,
@@ -316,10 +303,9 @@ export function createDecoratorImportDeclarations(
  * ```
  */
 export function getDecoratorImportInfos(
-  j: JSCodeshift,
   root: AST.Collection
 ): DecoratorImportInfoMap {
-  const existingDecoratorImports = getExistingDecoratorImports(j, root);
+  const existingDecoratorImports = getExistingDecoratorImports(root);
   const decoratorImportInfo: DecoratorImportInfoMap = new Map();
 
   for (const decoratorImport of existingDecoratorImports) {
diff --git a/transforms/helpers/parse-helper.ts b/transforms/helpers/parse-helper.ts
@@ -1,23 +1,11 @@
 import camelCase from 'camelcase';
-import type { JSCodeshift } from 'jscodeshift';
 import { default as j } from 'jscodeshift';
 import path from 'path';
 import * as AST from './ast';
+import type { DecoratorImportSpecs } from './util/index';
 import { capitalizeFirstLetter } from './util/index';
 import { assert, defined, isRecord } from './util/types';
 
-export interface DecoratorImportSpecs {
-  action: boolean;
-  classNames: boolean;
-  classNameBindings: boolean;
-  attributeBindings: boolean;
-  layout: boolean;
-  templateLayout: boolean;
-  off: boolean;
-  tagName: boolean;
-  unobserves: boolean;
-}
-
 /**
  * Get the map of decorators to import other than the computed props, services etc
  * which already have imports in the code
@@ -41,7 +29,6 @@ export function mergeDecoratorImportSpecs(
 
 /** Find the `EmberObject.extend` statements */
 export function getEOExtendExpressionCollection(
-  j: JSCodeshift,
   root: AST.Collection
 ): AST.Collection<AST.EOExtendExpression> {
   return AST.findPaths(root, j.CallExpression, AST.isEOExtendExpression).filter(
@@ -51,7 +38,6 @@ export function getEOExtendExpressionCollection(
 
 /** Return closest parent var declaration statement */
 function getClosestVariableDeclaration(
-  j: JSCodeshift,
   eoExtendExpressionPath: AST.Path<AST.EOExtendExpression>
 ): AST.Path<AST.VariableDeclaration> | null {
   const varDeclarations = j(eoExtendExpressionPath).closest(
@@ -66,13 +52,9 @@ function getClosestVariableDeclaration(
  * It returns either VariableDeclaration or the CallExpression depending on how the object is created
  */
 export function getExpressionToReplace(
-  j: JSCodeshift,
   eoExtendExpressionPath: AST.Path<AST.EOExtendExpression>
 ): AST.Path<AST.EOExtendExpression> | AST.Path<AST.VariableDeclaration> {
-  const varDeclaration = getClosestVariableDeclaration(
-    j,
-    eoExtendExpressionPath
-  );
+  const varDeclaration = getClosestVariableDeclaration(eoExtendExpressionPath);
   const parentValue = eoExtendExpressionPath.parentPath?.value;
   const isFollowedByCreate =
     isRecord(parentValue) &&
@@ -94,10 +76,7 @@ export function getClassName(
   filePath: string,
   type = ''
 ): string {
-  const varDeclaration = getClosestVariableDeclaration(
-    j,
-    eoExtendExpressionPath
-  );
+  const varDeclaration = getClosestVariableDeclaration(eoExtendExpressionPath);
   if (varDeclaration) {
     const firstDeclarator = defined(varDeclaration.value.declarations[0]);
     assert(
diff --git a/transforms/helpers/transform-helper.ts b/transforms/helpers/transform-helper.ts
@@ -1,4 +1,3 @@
-import type { JSCodeshift } from 'jscodeshift';
 import { default as j } from 'jscodeshift';
 import * as AST from '../helpers/ast';
 import {
@@ -22,10 +21,7 @@ export function withComments<T extends { comments?: unknown }>(
 }
 
 /** Creates line comments from passed lines */
-function createLineComments(
-  j: JSCodeshift,
-  lines: readonly string[] = []
-): AST.CommentLine[] {
+function createLineComments(lines: readonly string[] = []): AST.CommentLine[] {
   return lines.map((line) => j.commentLine(line));
 }
 
@@ -82,7 +78,6 @@ export function replaceActionSuperExpressions(
         [j.thisExpression(), ...superMethodArgs]
       );
       superMethodCall.comments = createLineComments(
-        j,
         ACTION_SUPER_EXPRESSION_COMMENT
       );
       return superMethodCall;
@@ -120,7 +115,6 @@ export function replaceMethodSuperExpression(
 
 /** Create import statement */
 export function createImportDeclaration(
-  j: JSCodeshift,
   specifiers: Array<AST.ImportSpecifier | AST.ImportDefaultSpecifier>,
   path: string
 ): AST.ImportDeclaration {
@@ -132,7 +126,6 @@ export function createImportDeclaration(
  * and creates import specifiers for the matching decorators
  */
 export function createEmberDecoratorSpecifiers(
-  j: JSCodeshift,
   pathSpecifiers: string[] = [],
   decoratorsToImport: string[] = []
 ): AST.ImportSpecifier[] {
diff --git a/transforms/helpers/transform.ts b/transforms/helpers/transform.ts
@@ -1,5 +1,4 @@
 import { getTelemetryFor } from 'ember-codemods-telemetry-helpers';
-import type { JSCodeshift } from 'jscodeshift';
 import path from 'path';
 import type * as AST from './ast';
 import EOExtendExpression from './eo-extend-expression';
@@ -9,17 +8,16 @@ import {
 } from './import-helper';
 import logger from './log-helper';
 import type { Options, UserOptions } from './options';
-import type { DecoratorImportSpecs } from './parse-helper';
 import {
   getEOExtendExpressionCollection,
   mergeDecoratorImportSpecs,
 } from './parse-helper';
 import { RuntimeDataSchema } from './runtime-data';
+import type { DecoratorImportSpecs } from './util/index';
 import { isFileOfType, isTestFile } from './validation-helper';
 
 /** Main entry point for parsing and replacing ember objects */
 export default function maybeTransformEmberObjects(
-  j: JSCodeshift,
   root: AST.Collection,
   filePath: string,
   userOptions: UserOptions
@@ -67,7 +65,6 @@ export default function maybeTransformEmberObjects(
   };
 
   const { transformed, decoratorImportSpecs } = _maybeTransformEmberObjects(
-    j,
     root,
     filePath,
     options
@@ -79,14 +76,13 @@ export default function maybeTransformEmberObjects(
     const decoratorsToImport = Object.keys(decoratorImportSpecs).filter(
       (key) => decoratorImportSpecs[key as keyof DecoratorImportSpecs]
     );
-    createDecoratorImportDeclarations(j, root, decoratorsToImport, options);
+    createDecoratorImportDeclarations(root, decoratorsToImport, options);
     logger.info(`[${filePath}]: SUCCESS`);
   }
   return transformed;
 }
 
 function _maybeTransformEmberObjects(
-  j: JSCodeshift,
   root: AST.Collection,
   filePath: string,
   options: Options
@@ -95,7 +91,7 @@ function _maybeTransformEmberObjects(
   decoratorImportSpecs: DecoratorImportSpecs;
 } {
   // Parse the import statements
-  const existingDecoratorImportInfos = getExistingDecoratorImportInfos(j, root);
+  const existingDecoratorImportInfos = getExistingDecoratorImportInfos(root);
   let transformed = false;
   let decoratorImportSpecs: DecoratorImportSpecs = {
     action: false,
@@ -109,7 +105,7 @@ function _maybeTransformEmberObjects(
     unobserves: false,
   };
 
-  const eoExtendExpressionPaths = getEOExtendExpressionCollection(j, root);
+  const eoExtendExpressionPaths = getEOExtendExpressionCollection(root);
 
   if (eoExtendExpressionPaths.length === 0) {
     logger.warn(
diff --git a/transforms/helpers/util/index.ts b/transforms/helpers/util/index.ts
@@ -27,6 +27,18 @@ interface DecoratorPathInfo {
   readonly decoratorPath: string;
 }
 
+export interface DecoratorImportSpecs {
+  [ACTION_DECORATOR_NAME]: boolean;
+  [CLASS_NAMES_DECORATOR_NAME]: boolean;
+  [CLASS_NAME_BINDINGS_DECORATOR_NAME]: boolean;
+  [ATTRIBUTE_BINDINGS_DECORATOR_NAME]: boolean;
+  [LAYOUT_DECORATOR_NAME]: boolean;
+  [LAYOUT_DECORATOR_LOCAL_NAME]: boolean;
+  [OFF_DECORATOR_NAME]: boolean;
+  [TAG_NAME_DECORATOR_NAME]: boolean;
+  [UNOBSERVES_DECORATOR_NAME]: boolean;
+}
+
 export const DECORATOR_PATHS: ReadonlyMap<string, DecoratorPathInfo> = new Map([
   [
     '@ember/object',
