feat(fs/fileOutput)!: support merge for more file types, more powerful hooks

Author: NamesMT

package.json

@@ -72,7 +72,8 @@
     "jiti": "^2.4.2",
     "pathe": "^2.0.3",
     "std-env": "^3.9.0",
-    "tinyglobby": "^0.2.13"
+    "tinyglobby": "^0.2.13",
+    "yaml": "^2.8.0"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^4.12.0",

pnpm-lock.yaml

@@ -3,23 +3,38 @@ import type { ReactiveArgs } from '~/types'
 import { Buffer } from 'node:buffer'
 import { access, mkdir, readFile, writeFile } from 'node:fs/promises'
 import { defu } from 'defu'
-import { dirname } from 'pathe'
+import { dirname, extname } from 'pathe'
+import { parse as yamlParse, stringify as yamlStringify } from 'yaml'
 import { logger } from './logger'
 
 export type FileOutputState = ReactiveArgs<{
   filePath: string
   data: string
-  mergeResult: undefined | string
-  mergeType: 'json' | 'concat'
+  /**
+   * This property is auto-populated for deep merge-able files (json, yaml) in hooks like `onFileOutputDeepMerge`, the user can also set it manually on prior hooks.
+   */
+  parsedData?: Record<string, unknown> | undefined
+  mergeResult?: string | undefined
+  mergeType: 'json' | 'yaml' | 'concat' | 'custom'
   isValidFileToMerge: boolean
+  /**
+   * A custom id for the file, used for advanced hook usecase like `custom` merge
+   */
+  fid?: string
 }>
 
 export interface FileOutputHooks extends Hooks {
   onFileOutput: (state: FileOutputState) => void | Promise<void>
 
-  onFileOutputJsonMerge: (state: FileOutputState) => void | Promise<void>
+  onFileOutputCustomMerge: (state: FileOutputState) => void | Promise<void>
 
   onFileOutputConcatMerge: (state: FileOutputState) => void | Promise<void>
+
+  onFileOutputDeepMerge: (state: FileOutputState) => void | Promise<void>
+
+  onFileOutputJsonMerge: (state: FileOutputState) => void | Promise<void>
+
+  onFileOutputYamlMerge: (state: FileOutputState) => void | Promise<void>
 }
 
 export interface FileOutputOptions {
@@ -32,11 +47,11 @@ export interface FileOutputOptions {
    * Control existing file content merging policy.
    *
    * Options:
-   * + `'json'`: perform deep merge for json files only.
+   * + `'deep'`: perform deep merge supported files only (json, yaml).
    * + `true`: concatenate data of all files (json are still deep-merged).
    *
    */
-  mergeContent?: boolean | 'json'
+  mergeContent?: boolean | 'deep'
 }
 
 /**
@@ -52,12 +67,12 @@ export async function fileOutput(filePath: string, data: string, options?: FileO
     mergeContent,
   } = options ?? {}
 
+  const mergeType = _fileMergeType(filePath)
   const state: FileOutputState = {
     filePath,
     data,
-    mergeResult: undefined as undefined | string,
-    mergeType: filePath.endsWith('.json') ? 'json' : 'concat',
-    isValidFileToMerge: mergeContent === true || (mergeContent === 'json' && filePath.endsWith('.json')),
+    mergeType,
+    isValidFileToMerge: mergeContent === true || (mergeContent === 'deep' && mergeType !== 'concat'),
   }
 
   if (hookable)
@@ -71,25 +86,59 @@ export async function fileOutput(filePath: string, data: string, options?: FileO
     logger.info(`Merging file "${state.filePath}"...`)
 
     switch (state.mergeType) {
+      case 'custom': {
+        if (!hookable)
+          throw new Error('Expect `hookable` to be provided when mergeType is "custom"')
+
+        await hookable.callHook('onFileOutputCustomMerge', state)
+
+        if (!state.mergeResult)
+          throw new Error('Expect `mergeResult` to be provided when mergeType is "custom"')
+
+        state.data = state.mergeResult
+        break
+      }
+      case 'concat': {
+        if (hookable)
+          await hookable.callHook('onFileOutputConcatMerge', state)
+
+        state.data = state.mergeResult ?? Buffer.concat([await readFile(state.filePath), Buffer.from(state.data)]).toString()
+        break
+      }
       case 'json': {
         if (typeof state.data !== 'string')
           throw new Error('Please provide `data` as a JSON stringified object')
 
-        if (hookable)
+        state.parsedData = JSON.parse(state.data)
+
+        if (hookable) {
+          await hookable.callHook('onFileOutputDeepMerge', state)
           await hookable.callHook('onFileOutputJsonMerge', state)
+        }
 
         state.data = state.mergeResult ?? JSON.stringify(
-          defu(JSON.parse(state.data), JSON.parse(await readFile(state.filePath, 'utf-8'))),
+          defu(state.parsedData, JSON.parse(await readFile(state.filePath, 'utf-8'))),
           undefined,
           2,
         )
         break
       }
-      case 'concat': {
-        if (hookable)
-          await hookable.callHook('onFileOutputConcatMerge', state)
+      case 'yaml': {
+        if (typeof state.data !== 'string')
+          throw new Error('Please provide `data` as a YAML stringified object')
 
-        state.data = state.mergeResult ?? Buffer.concat([await readFile(state.filePath), Buffer.from(state.data)]).toString()
+        state.parsedData = yamlParse(state.data)
+
+        if (hookable) {
+          await hookable.callHook('onFileOutputDeepMerge', state)
+          await hookable.callHook('onFileOutputYamlMerge', state)
+        }
+
+        state.data = state.mergeResult ?? yamlStringify(
+          defu(state.parsedData, yamlParse(await readFile(state.filePath, 'utf-8'))),
+          undefined,
+          2,
+        )
         break
       }
       default:
@@ -100,3 +149,17 @@ export async function fileOutput(filePath: string, data: string, options?: FileO
   // Write the file
   return await writeFile(state.filePath, state.data)
 }
+
+function _fileMergeType(filePath: string) {
+  const extension = extname(filePath)
+
+  switch (extension) {
+    case '.json':
+      return 'json'
+    case '.yaml':
+    case '.yml':
+      return 'yaml'
+    default:
+      return 'concat'
+  }
+}

src/helpers/fs.ts

@@ -114,7 +114,7 @@ export async function simpleRocketAssemble(options: SimpleRocketAssembleOptions)
         fileContentFinal = replaceMap(fileContentMirror, variables)
       } while (fileContentFinal !== fileContentMirror)
 
-      await fileOutput(resolve(outDir, filePath), fileContentFinal, { hookable, mergeContent: 'json' })
+      await fileOutput(resolve(outDir, filePath), fileContentFinal, { hookable, mergeContent: 'deep' })
     }
   }
 

src/rocket/assemble.ts

@@ -81,7 +81,7 @@ describe('unpackFromUrl', () => {
     delete globalThis.fetch
   })
 
-  it('should download, extract, and assemble a valid rocket config pack', async () => {
+  it('should extract, and assemble a valid rocket config pack', async () => {
     // Arrange
     const mockZipData = await createMockZip({
       'rocket.config.json5': '{ "name": "test-pack" }',
@@ -113,9 +113,9 @@ describe('unpackFromUrl', () => {
     expect(vi.mocked(await import('node:fs/promises')).mkdtemp).toHaveBeenCalled()
     expect(mockUnzip).toHaveBeenCalled()
     expect(fileOutput).toHaveBeenCalledTimes(3)
-    expect(fileOutput).toHaveBeenCalledWith(`${expectedTmpDir}/rocket.config.json5`, '{ "name": "test-pack" }', { hookable: undefined })
-    expect(fileOutput).toHaveBeenCalledWith(`${expectedTmpDir}/frame/file1.txt`, 'frame content', { hookable: undefined })
-    expect(fileOutput).toHaveBeenCalledWith(`${expectedTmpDir}/fuel/file2.txt`, 'fuel content', { hookable: undefined })
+    expect(fileOutput).toHaveBeenCalledWith(`${expectedTmpDir}/rocket.config.json5`, '{ "name": "test-pack" }', undefined)
+    expect(fileOutput).toHaveBeenCalledWith(`${expectedTmpDir}/frame/file1.txt`, 'frame content', undefined)
+    expect(fileOutput).toHaveBeenCalledWith(`${expectedTmpDir}/fuel/file2.txt`, 'fuel content', undefined)
     expect(logger.success).toHaveBeenCalledWith('Extracted successfully.')
     expect(logger.start).toHaveBeenCalledWith('Assembling the config according to `rocketConfig`...')
     expect(rocketAssemble).toHaveBeenCalledWith({