feat: 🎸 出码模块的 DiskPublisher 改成支持传入自定义 FS

packages/code-generator/src/publisher/disk/index.ts

@@ -1,16 +1,14 @@
-import {
+import * as defaultFs from 'fs';
-  IResultDir,
+import { IResultDir, PublisherFactory, IPublisher, IPublisherFactoryParams, PublisherError } from '../../types';
-  PublisherFactory,
+import { writeFolder, IFileSystem } from './utils';
-  IPublisher,
+
-  IPublisherFactoryParams,
+export type { IFileSystem };
-  PublisherError,
-} from '../../types';
-import { writeFolder } from './utils';
 
 export interface IDiskFactoryParams extends IPublisherFactoryParams {
   outputPath?: string;
   projectSlug?: string;
   createProjectFolder?: boolean;
+  fs?: IFileSystem;
 }
 
 export interface IDiskPublisher extends IPublisher<IDiskFactoryParams, string> {
@@ -18,11 +16,10 @@ export interface IDiskPublisher extends IPublisher<IDiskFactoryParams, string> {
   setOutputPath: (path: string) => void;
 }
 
-export const createDiskPublisher: PublisherFactory<
+export const createDiskPublisher: PublisherFactory<IDiskFactoryParams, IDiskPublisher> = (
-  IDiskFactoryParams,
+  params: IDiskFactoryParams = {},
-  IDiskPublisher
+): IDiskPublisher => {
-> = (params: IDiskFactoryParams = {}): IDiskPublisher => {
+  let { project, outputPath = './', fs = defaultFs } = params;
-  let { project, outputPath = './' } = params;
 
   const getProject = (): IResultDir => {
     if (!project) {
@@ -49,19 +46,14 @@ export const createDiskPublisher: PublisherFactory<
 
     const projectOutputPath = options.outputPath || outputPath;
     const overrideProjectSlug = options.projectSlug || params.projectSlug;
-    const createProjectFolder =
+    const createProjectFolder = options.createProjectFolder || params.createProjectFolder;
-      options.createProjectFolder || params.createProjectFolder;
 
     if (overrideProjectSlug) {
       projectToPublish.name = overrideProjectSlug;
     }
 
     try {
-      await writeFolder(
+      await writeFolder(projectToPublish, projectOutputPath, createProjectFolder, fs);
-        projectToPublish,
-        projectOutputPath,
-        createProjectFolder,
-      );
       return { success: true, payload: projectOutputPath };
     } catch (error) {
       throw new PublisherError(error);

packages/code-generator/src/publisher/disk/utils.ts

@@ -1,39 +1,38 @@
-import { existsSync, mkdir, writeFile } from 'fs';
+import * as systemFs from 'fs';
 import { join } from 'path';
 
 import { IResultDir, IResultFile } from '../../types';
 
+export interface IFileSystem {
+  existsSync: typeof systemFs.existsSync;
+  mkdir: typeof systemFs.mkdir;
+  writeFile: typeof systemFs.writeFile;
+}
+
 export const writeFolder = async (
   folder: IResultDir,
   currentPath: string,
   createProjectFolder = true,
+  fs: IFileSystem = systemFs,
 ): Promise<void> => {
   const { name, files, dirs } = folder;
 
-  const folderPath = createProjectFolder
+  const folderPath = createProjectFolder ? join(currentPath, name) : currentPath;
-    ? join(currentPath, name)
-    : currentPath;
 
-  if (!existsSync(folderPath)) {
+  if (!fs.existsSync(folderPath)) {
-    await createDirectory(folderPath);
+    await createDirectory(folderPath, fs);
   }
 
-  const promises = [
+  const promises = [writeFilesToFolder(folderPath, files, fs), writeSubFoldersToFolder(folderPath, dirs, fs)];
-    writeFilesToFolder(folderPath, files),
-    writeSubFoldersToFolder(folderPath, dirs),
-  ];
 
   await Promise.all(promises);
 };
 
-const writeFilesToFolder = async (
+const writeFilesToFolder = async (folderPath: string, files: IResultFile[], fs: IFileSystem): Promise<void> => {
-  folderPath: string,
+  const promises = files.map((file) => {
-  files: IResultFile[],
-): Promise<void> => {
-  const promises = files.map(file => {
     const fileName = file.ext ? `${file.name}.${file.ext}` : file.name;
     const filePath = join(folderPath, fileName);
-    return writeContentToFile(filePath, file.content);
+    return writeContentToFile(filePath, file.content, 'utf8', fs);
   });
 
   await Promise.all(promises);
@@ -42,17 +41,18 @@ const writeFilesToFolder = async (
 const writeSubFoldersToFolder = async (
   folderPath: string,
   subFolders: IResultDir[],
+  fs: IFileSystem,
 ): Promise<void> => {
-  const promises = subFolders.map(subFolder => {
+  const promises = subFolders.map((subFolder) => {
     return writeFolder(subFolder, folderPath);
   });
 
   await Promise.all(promises);
 };
 
-const createDirectory = (pathToDir: string): Promise<void> => {
+const createDirectory = (pathToDir: string, fs: IFileSystem): Promise<void> => {
   return new Promise((resolve, reject) => {
-    mkdir(pathToDir, { recursive: true }, err => {
+    fs.mkdir(pathToDir, { recursive: true }, (err) => {
       err ? reject(err) : resolve();
     });
   });
@@ -62,9 +62,10 @@ const writeContentToFile = (
   filePath: string,
   fileContent: string,
   encoding: string = 'utf8',
+  fs: IFileSystem,
 ): Promise<void> => {
   return new Promise((resolve, reject) => {
-    writeFile(filePath, fileContent, encoding, err => {
+    fs.writeFile(filePath, fileContent, encoding, (err) => {
       err ? reject(err) : resolve();
     });
   });