feat: add addAssemblerHook codemod

Author: Julien-R44

src/code_transformer/rc_file_transformer.ts

@@ -8,7 +8,7 @@
  */
 
 import { fileURLToPath } from 'node:url'
-import type { AppEnvironments } from '@adonisjs/application/types'
+import type { AppEnvironments, RcFile } from '@adonisjs/application/types'
 import {
   Node,
   Project,
@@ -346,6 +346,30 @@ export class RcFileTransformer {
     return this
   }
 
+  /**
+   * Add a new assembler hook
+   */
+  addAssemblerHook(type: keyof NonNullable<RcFile['hooks']>, path: string) {
+    const hooksProperty = this.#getPropertyAssignmentInDefineConfigCall('hooks', '{}')
+
+    const hooks = hooksProperty.getInitializerIfKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+    let hookArray = hooks.getProperty(type) as PropertyAssignment
+    if (!hookArray) {
+      hooks.addPropertyAssignment({ name: type, initializer: '[]' })
+      hookArray = hooks.getProperty(type) as PropertyAssignment
+    }
+
+    const hooksArray = hookArray.getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression)
+    const existingHooks = this.#extractModulesFromArray(hooksArray)
+    if (existingHooks.includes(path)) {
+      return this
+    }
+
+    hooksArray.addElement(`() => import('${path}')`)
+
+    return this
+  }
+
   /**
    * Save the adonisrc.ts file
    */

tests/__snapshots__/code_transformer.spec.ts.cjs

@@ -398,3 +398,36 @@ export const plugins: Config['plugins'] = [
 ]
 "`
 
+exports[`Code Transformer | addAssemblerHook > add assembler hook to the assembler file 1`] = `"import { defineConfig } from '@adonisjs/core/app'
+
+export default defineConfig({
+  typescript: true,
+  preloads: [
+    () => import('./start/routes.ts'),
+    {
+      file: () => import('./start/ace.ts'),
+      environment: ['console'],
+    },
+  ],
+  providers: [
+    () => import('@adonisjs/core/providers/app_provider'),
+    {
+      file: () => import('@adonisjs/core/providers/repl_provider'),
+      environment: ['repl'],
+    }
+  ],
+  metaFiles: [
+    {
+      pattern: 'public/**',
+      reloadServer: true
+    },
+  ],
+  commands: [
+    () => import('@adonisjs/core/commands')
+  ],
+  hooks: {
+    onBuildCompleted: [() => import('@adonisjs/vite/hooks/onBuildCompleted')]
+  }
+})
+"`
+

tests/code_transformer.spec.ts

@@ -894,3 +894,32 @@ test.group('Code transformer | addVitePlugin', (group) => {
     await transformer.addVitePlugin('vue()', [{ identifier: 'vue', module: 'vue', isNamed: false }])
   }).throws(/Expected to find property named 'plugins'/)
 })
+
+test.group('Code Transformer | addAssemblerHook', (group) => {
+  group.each.setup(async ({ context }) => setupFakeAdonisproject(context.fs))
+
+  test('add assembler hook to the assembler file', async ({ assert, fs }) => {
+    const transformer = new CodeTransformer(fs.baseUrl)
+
+    await transformer.updateRcFile((rcFile) =>
+      rcFile.addAssemblerHook('onBuildCompleted', '@adonisjs/vite/hooks/onBuildCompleted')
+    )
+
+    const file = await fs.contents('adonisrc.ts')
+    assert.snapshot(file).match()
+  })
+
+  test('dont add duplicate assembler hooks', async ({ assert, fs }) => {
+    const transformer = new CodeTransformer(fs.baseUrl)
+
+    await transformer.updateRcFile((rcFile) => {
+      rcFile.addAssemblerHook('onBuildCompleted', '@adonisjs/vite/hooks/onBuildCompleted')
+      rcFile.addAssemblerHook('onBuildCompleted', '@adonisjs/vite/hooks/onBuildCompleted')
+    })
+
+    const file = await fs.contents('adonisrc.ts')
+    const occurrences = (file.match(/@adonisjs\/vite\/hooks\/onBuildCompleted/g) || []).length
+
+    assert.equal(occurrences, 1)
+  })
+})