Refactor createReducerBuilder transform file

aryaemami59 · aryaemami59 · commit 681a982a0911 · 2024-01-14T22:06:55.000-06:00
- Eliminated `@ts-ignore` directives to improve TypeScript compliance.
  - Configured `lineTerminator` in `.toSource.options` for consistent end-of-line across platforms, overriding `jscodeshift`'s default OS-specific EOL.
  - Removed unnecessary `test.js` file.
  - Refactored `__fixtures__` files to contain more realistic and practical examples.
diff --git a/packages/rtk-codemods/transforms/createReducerBuilder/createReducerBuilder.test.ts b/packages/rtk-codemods/transforms/createReducerBuilder/createReducerBuilder.test.ts
@@ -1,11 +1,10 @@
-import path from 'path';
-import transform, { parser } from './index';
-
-import { runTransformTest } from '../../transformTestUtils';
+import path from 'node:path'
+import { runTransformTest } from '../../transformTestUtils'
+import transform, { parser } from './index'
 
 runTransformTest(
   'createReducerBuilder',
   transform,
   parser,
   path.join(__dirname, '__testfixtures__')
-);
+)
diff --git a/packages/rtk-codemods/transforms/createReducerBuilder/index.ts b/packages/rtk-codemods/transforms/createReducerBuilder/index.ts
@@ -1,93 +1,96 @@
-import { ExpressionKind, SpreadElementKind } from 'ast-types/gen/kinds';
-import {
+import type { ExpressionKind, SpreadElementKind } from 'ast-types/gen/kinds'
+import type {
   ExpressionStatement,
   JSCodeshift,
   ObjectExpression,
-  ObjectMethod,
-  ObjectProperty,
-  Transform,
-} from 'jscodeshift';
-
-type ObjectKey = ObjectMethod['key'] & ObjectProperty['key'];
+  Transform
+} from 'jscodeshift'
+import type { TestOptions } from 'jscodeshift/src/testUtils'
 
 function wrapInAddCaseExpression(
   j: JSCodeshift,
   addCaseArgs: (ExpressionKind | SpreadElementKind)[]
 ) {
-  const identifier = j.identifier('builder');
+  const identifier = j.identifier('builder')
   return j.expressionStatement(
-    j.callExpression(j.memberExpression(identifier, j.identifier('addCase'), false), addCaseArgs)
-  );
+    j.callExpression(
+      j.memberExpression(identifier, j.identifier('addCase'), false),
+      addCaseArgs
+    )
+  )
 }
 
-export function reducerPropsToBuilderExpression(j: JSCodeshift, defNode: ObjectExpression) {
-  const caseExpressions: ExpressionStatement[] = [];
-  for (let property of defNode.properties) {
-    let addCaseArgs: (ExpressionKind | SpreadElementKind)[] = [];
+export function reducerPropsToBuilderExpression(
+  j: JSCodeshift,
+  defNode: ObjectExpression
+) {
+  const caseExpressions: ExpressionStatement[] = []
+  for (const property of defNode.properties) {
+    let addCaseArgs: (ExpressionKind | SpreadElementKind)[] = []
     switch (property.type) {
       case 'ObjectMethod': {
-        const { key, params, body } = property;
+        const { key, params, body } = property
         if (body) {
-          addCaseArgs = [key, j.arrowFunctionExpression(params, body)];
+          addCaseArgs = [key, j.arrowFunctionExpression(params, body)]
         }
-        break;
+        break
       }
       case 'ObjectProperty': {
-        const { key } = property;
+        const { key } = property
 
         switch (property.value.type) {
           case 'ArrowFunctionExpression':
           case 'FunctionExpression': {
-            const { params, body } = property.value;
+            const { params, body } = property.value
             if (body) {
-              addCaseArgs = [key, j.arrowFunctionExpression(params, body)];
+              addCaseArgs = [key, j.arrowFunctionExpression(params, body)]
             }
-            break;
+            break
           }
           case 'Identifier':
           case 'MemberExpression': {
-            const { value } = property;
-            addCaseArgs = [key, value];
-            break;
+            const { value } = property
+            addCaseArgs = [key, value]
+            break
           }
         }
       }
     }
     if (!addCaseArgs.length) {
-      continue;
+      continue
     }
-    caseExpressions.push(wrapInAddCaseExpression(j, addCaseArgs));
+    caseExpressions.push(wrapInAddCaseExpression(j, addCaseArgs))
   }
 
-  return j.arrowFunctionExpression([j.identifier('builder')], j.blockStatement(caseExpressions));
+  return j.arrowFunctionExpression(
+    [j.identifier('builder')],
+    j.blockStatement(caseExpressions)
+  )
 }
 
 const transform: Transform = (file, api) => {
-  const j = api.jscodeshift;
+  const j = api.jscodeshift
 
-  return (
-    j(file.source)
-      // @ts-ignore some expression mismatch
-      .find(j.CallExpression, {
-        callee: { name: 'createReducer' },
-        // @ts-ignore some expression mismatch
-        arguments: { 1: { type: 'ObjectExpression' } },
-      })
-      .forEach((path) => {
-        const reducerObjectExpression = path.node.arguments[1] as ObjectExpression;
-        j(path).replaceWith(
-          j.callExpression(j.identifier('createReducer'), [
-            path.node.arguments[0],
-            reducerPropsToBuilderExpression(j, reducerObjectExpression),
-          ])
-        );
-      })
-      .toSource({
-        arrowParensAlways: true,
-      })
-  );
-};
+  return j(file.source)
+    .find(j.CallExpression, {
+      callee: { name: 'createReducer' },
+      arguments: [{}, { type: 'ObjectExpression' }]
+    })
+    .forEach((path) => {
+      const reducerObjectExpression = path.node.arguments[1] as ObjectExpression
+      j(path).replaceWith(
+        j.callExpression(j.identifier('createReducer'), [
+          path.node.arguments[0],
+          reducerPropsToBuilderExpression(j, reducerObjectExpression)
+        ])
+      )
+    })
+    .toSource({
+      arrowParensAlways: true,
+      lineTerminator: '\n'
+    })
+}
 
-export const parser = 'tsx';
+export const parser = 'tsx' satisfies TestOptions['parser']
 
-export default transform;
+export default transform
diff --git a/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic-ts.input.ts b/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic-ts.input.ts
@@ -1,27 +1,43 @@
-const aSlice = createSlice({
-  name: 'name',
+import type { PayloadAction } from '@reduxjs/toolkit'
+import { createEntityAdapter, createSlice, nanoid } from '@reduxjs/toolkit'
+
+function withPayload(): any {
+  throw new Error('Function not implemented.')
+}
+
+export interface Todo {
+  id: string
+  title: string
+}
+
+export const todoAdapter = createEntityAdapter<Todo>()
+
+const todoSlice = createSlice({
+  name: 'todo',
   initialState: todoAdapter.getInitialState(),
   reducers: {
     property: () => {},
     method(state, action: PayloadAction<Todo>) {
-      todoAdapter.addOne(state, action);
+      todoAdapter.addOne(state, action)
     },
     identifier: todoAdapter.removeOne,
     preparedProperty: {
-      prepare: (todo: Todo) => ({ payload: { id: nanoid(), ...todo } }),
+      prepare: (todo: Omit<Todo, 'id'>) => ({
+        payload: { id: nanoid(), ...todo }
+      }),
       reducer: () => {}
     },
     preparedMethod: {
-      prepare(todo: Todo) {
+      prepare(todo: Omit<Todo, 'id'>) {
         return { payload: { id: nanoid(), ...todo } }
       },
       reducer(state, action: PayloadAction<Todo>) {
-        todoAdapter.addOne(state, action);
+        todoAdapter.addOne(state, action)
       }
     },
     preparedIdentifier: {
       prepare: withPayload(),
       reducer: todoAdapter.setMany
-    },
+    }
   }
 })
diff --git a/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic-ts.output.ts b/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic-ts.output.ts
@@ -1,21 +1,38 @@
-const aSlice = createSlice({
-  name: 'name',
+import type { PayloadAction } from '@reduxjs/toolkit'
+import { createEntityAdapter, createSlice, nanoid } from '@reduxjs/toolkit'
+
+function withPayload(): any {
+  throw new Error('Function not implemented.')
+}
+
+export interface Todo {
+  id: string
+  title: string
+}
+
+export const todoAdapter = createEntityAdapter<Todo>()
+
+const todoSlice = createSlice({
+  name: 'todo',
   initialState: todoAdapter.getInitialState(),
 
   reducers: (create) => ({
     property: create.reducer(() => {}),
 
     method: create.reducer((state, action: PayloadAction<Todo>) => {
-      todoAdapter.addOne(state, action);
+      todoAdapter.addOne(state, action)
     }),
 
     identifier: create.reducer(todoAdapter.removeOne),
-    preparedProperty: create.preparedReducer((todo: Todo) => ({ payload: { id: nanoid(), ...todo } }), () => {}),
 
-    preparedMethod: create.preparedReducer((todo: Todo) => {
+    preparedProperty: create.preparedReducer((todo: Omit<Todo, 'id'>) => ({
+      payload: { id: nanoid(), ...todo }
+    }), () => {}),
+
+    preparedMethod: create.preparedReducer((todo: Omit<Todo, 'id'>) => {
       return { payload: { id: nanoid(), ...todo } }
     }, (state, action: PayloadAction<Todo>) => {
-      todoAdapter.addOne(state, action);
+      todoAdapter.addOne(state, action)
     }),
 
     preparedIdentifier: create.preparedReducer(withPayload(), todoAdapter.setMany)
diff --git a/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic.input.js b/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic.input.js
@@ -1,27 +1,37 @@
-const aSlice = createSlice({
-  name: 'name',
-  initialState: todoAdapter.getInitialState(),
-  reducers: {
-    property: () => {},
-    method(state, action) {
-      todoAdapter.setMany(state, action);
-    },
-    identifier: todoAdapter.removeOne,
-    preparedProperty: {
-      prepare: (todo) => ({ payload: { id: nanoid(), ...todo } }),
-      reducer: () => {}
-    },
-    preparedMethod: {
-      prepare(todo) {
-        return { payload: { id: nanoid(), ...todo } }
-      },
-      reducer(state, action) {
-        todoAdapter.setMany(state, action);
-      }
-    },
-    preparedIdentifier: {
-      prepare: withPayload(),
-      reducer: todoAdapter.setMany
-    },
-  }
-})
+import { createEntityAdapter, createSlice, nanoid } from '@reduxjs/toolkit'
+
+function withPayload() {
+    throw new Error('Function not implemented.')
+}
+
+export const todoAdapter = createEntityAdapter()
+
+const todoSlice = createSlice({
+    name: 'todo',
+    initialState: todoAdapter.getInitialState(),
+    reducers: {
+        property: () => { },
+        method(state, action) {
+            todoAdapter.addOne(state, action)
+        },
+        identifier: todoAdapter.removeOne,
+        preparedProperty: {
+            prepare: (todo) => ({
+                payload: { id: nanoid(), ...todo }
+            }),
+            reducer: () => { }
+        },
+        preparedMethod: {
+            prepare(todo) {
+                return { payload: { id: nanoid(), ...todo } }
+            },
+            reducer(state, action) {
+                todoAdapter.addOne(state, action)
+            }
+        },
+        preparedIdentifier: {
+            prepare: withPayload(),
+            reducer: todoAdapter.setMany
+        }
+    }
+})
diff --git a/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic.output.js b/packages/rtk-codemods/transforms/createSliceReducerBuilder/__testfixtures__/basic.output.js
@@ -1,23 +1,34 @@
-const aSlice = createSlice({
-  name: 'name',
-  initialState: todoAdapter.getInitialState(),
+import { createEntityAdapter, createSlice, nanoid } from '@reduxjs/toolkit'
 
-  reducers: (create) => ({
-    property: create.reducer(() => {}),
+function withPayload() {
+    throw new Error('Function not implemented.')
+}
 
-    method: create.reducer((state, action) => {
-      todoAdapter.setMany(state, action);
-    }),
+export const todoAdapter = createEntityAdapter()
 
-    identifier: create.reducer(todoAdapter.removeOne),
-    preparedProperty: create.preparedReducer((todo) => ({ payload: { id: nanoid(), ...todo } }), () => {}),
+const todoSlice = createSlice({
+    name: 'todo',
+    initialState: todoAdapter.getInitialState(),
 
-    preparedMethod: create.preparedReducer((todo) => {
-      return { payload: { id: nanoid(), ...todo } }
-    }, (state, action) => {
-      todoAdapter.setMany(state, action);
-    }),
+    reducers: (create) => ({
+        property: create.reducer(() => { }),
 
-    preparedIdentifier: create.preparedReducer(withPayload(), todoAdapter.setMany)
-  })
-})
+        method: create.reducer((state, action) => {
+            todoAdapter.addOne(state, action)
+        }),
+
+        identifier: create.reducer(todoAdapter.removeOne),
+
+        preparedProperty: create.preparedReducer((todo) => ({
+            payload: { id: nanoid(), ...todo }
+        }), () => { }),
+
+        preparedMethod: create.preparedReducer((todo) => {
+            return { payload: { id: nanoid(), ...todo } }
+        }, (state, action) => {
+            todoAdapter.addOne(state, action)
+        }),
+
+        preparedIdentifier: create.preparedReducer(withPayload(), todoAdapter.setMany)
+    })
+})
diff --git a/packages/rtk-codemods/transforms/createSliceReducerBuilder/test.js b/packages/rtk-codemods/transforms/createSliceReducerBuilder/test.js
