@modern-js/bff-generator 3.6.3 → 3.7.1

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "3.6.3",
+  "version": "3.7.1",
   "jsnext:source": "./src/index.ts",
   "types": "./src/index.ts",
   "main": "./dist/index.js",
@@ -23,22 +23,20 @@
     "/templates",
     "/dist/index.js"
   ],
-  "dependencies": {
-    "@modern-js/utils": "2.60.3"
-  },
   "devDependencies": {
-    "@modern-js/codesmith": "2.5.2",
-    "@modern-js/codesmith-api-app": "2.5.2",
-    "@modern-js/codesmith-api-json": "2.5.2",
+    "@modern-js/codesmith-utils": "2.6.5",
+    "@modern-js/codesmith": "2.6.5",
+    "@modern-js/codesmith-api-app": "2.6.5",
+    "@modern-js/codesmith-api-json": "2.6.5",
     "@types/jest": "^29",
     "@types/node": "^14",
     "jest": "^29",
     "typescript": "^5",
-    "@modern-js/generator-common": "3.6.3",
-    "@modern-js/plugin-i18n": "2.60.3",
-    "@modern-js/generator-utils": "3.6.3",
-    "@scripts/build": "2.60.3",
-    "@scripts/jest-config": "2.60.3"
+    "@modern-js/generator-utils": "3.7.1",
+    "@modern-js/plugin-i18n": "2.60.5",
+    "@scripts/build": "2.60.5",
+    "@scripts/jest-config": "2.60.5",
+    "@modern-js/generator-common": "3.7.1"
   },
   "sideEffects": false,
   "publishConfig": {

package/src/index.ts

@@ -1,319 +0,0 @@
-import path from 'path';
-import type { GeneratorContext, GeneratorCore } from '@modern-js/codesmith';
-import { AppAPI } from '@modern-js/codesmith-api-app';
-import { JsonAPI } from '@modern-js/codesmith-api-json';
-import {
-  BFFPluginDependence,
-  BFFPluginName,
-  BFFType,
-  Framework,
-  FrameworkAppendTypeContent,
-  Language,
-  Solution,
-  i18n as commonI18n,
-  getBFFSchema,
-} from '@modern-js/generator-common';
-import {
-  fs,
-  chalk,
-  getModernConfigFile,
-  getModernPluginVersion,
-  getPackageVersion,
-  isTsProject,
-  readTsConfigByFile,
-} from '@modern-js/generator-utils';
-import { i18n, localeKeys } from './locale';
-
-function isEmptyApiDir(apiDir: string) {
-  const files = fs.readdirSync(apiDir);
-  if (files.length === 0) {
-    return true;
-  }
-  return files.every(file => {
-    if (fs.statSync(path.join(apiDir, file)).isDirectory()) {
-      const childFiles = fs.readdirSync(path.join(apiDir, file));
-      return childFiles.length === 0;
-    }
-    return false;
-  });
-}
-
-export const handleTemplateFile = async (
-  context: GeneratorContext,
-  generator: GeneratorCore,
-  appApi: AppAPI,
-) => {
-  const jsonAPI = new JsonAPI(generator);
-
-  const ans = await appApi.getInputBySchemaFunc(getBFFSchema, context.config);
-
-  const appDir = context.materials.default.basePath;
-  const apiDir = path.join(appDir, 'api');
-
-  if (fs.existsSync(apiDir) && !isEmptyApiDir(apiDir)) {
-    const files = fs.readdirSync(apiDir);
-    if (files.length > 0) {
-      generator.logger.warn(`🟡 The 'api' directory already exists.`);
-      throw Error("The 'api' directory is already exist");
-    }
-  }
-
-  const { bffType, framework } = ans;
-
-  const language = isTsProject(appDir) ? Language.TS : Language.JS;
-
-  const getBffPluginVersion = (packageName: string) => {
-    return getModernPluginVersion(Solution.MWA, packageName, {
-      registry: context.config.registry,
-      distTag: context.config.distTag,
-      cwd: context.materials.default.basePath,
-    });
-  };
-
-  // update bff plugin config
-  context.config.bffPluginName = BFFPluginName[framework as Framework];
-  context.config.bffPluginDependence =
-    BFFPluginDependence[framework as Framework];
-
-  let updateInfo: Record<string, string> = {};
-
-  if (framework === Framework.Express || framework === Framework.Koa) {
-    updateInfo = {
-      [`devDependencies.@types/${framework as string}`]: `~${await getPackageVersion(`@types/${framework as string}`)}`,
-    };
-  }
-
-  updateInfo = {
-    ...updateInfo,
-    [`dependencies.${framework as string}`]: `~${await getPackageVersion(
-      framework as string,
-    )}`,
-  };
-
-  await jsonAPI.update(
-    context.materials.default.get(path.join(appDir, 'package.json')),
-    {
-      query: {},
-      update: {
-        $set: {
-          'dependencies.@modern-js/plugin-bff': `${await getBffPluginVersion(
-            '@modern-js/plugin-bff',
-          )}`,
-          [`dependencies.@modern-js/plugin-${framework as string}`]: `${await getBffPluginVersion(
-            `@modern-js/plugin-${framework as string}`,
-          )}`,
-          'devDependencies.ts-node': '~10.8.1',
-          'devDependencies.tsconfig-paths': '~3.14.1',
-          ...updateInfo,
-        },
-      },
-    },
-    true,
-  );
-
-  if (language === Language.TS) {
-    const tsconfigJSON = readTsConfigByFile(path.join(appDir, 'tsconfig.json'));
-
-    if (!(tsconfigJSON.include || []).includes('api')) {
-      await jsonAPI.update(
-        context.materials.default.get(path.join(appDir, 'tsconfig.json')),
-        {
-          query: {},
-          update: {
-            $set: {
-              include: [...(tsconfigJSON.include || []), 'api'],
-            },
-          },
-        },
-        true,
-      );
-    }
-  }
-
-  if (bffType === BFFType.Func) {
-    if (language === Language.TS) {
-      await jsonAPI.update(
-        context.materials.default.get(path.join(appDir, 'tsconfig.json')),
-        {
-          query: {},
-          update: {
-            $set: {
-              'compilerOptions.paths.@api/*': ['./api/*'],
-            },
-          },
-        },
-        true,
-      );
-    }
-    await appApi.forgeTemplate(
-      'templates/function/base/*',
-      undefined,
-      resourceKey =>
-        resourceKey
-          .replace('templates/function/base/', 'api/')
-          .replace('.handlebars', `.${language}`),
-    );
-    await appApi.forgeTemplate(
-      `templates/function/info/*`,
-      resourceKey => resourceKey.includes(language),
-      resourceKey =>
-        resourceKey
-          .replace('templates/function/info/', 'api/info/')
-          .replace('.handlebars', ``),
-    );
-    await appApi.forgeTemplate(
-      `templates/function/app/${language}/${
-        framework as string
-      }.${language}.handlebars`,
-      undefined,
-      resourceKey =>
-        resourceKey.replace(
-          `templates/function/app/${language}/${
-            framework as string
-          }.${language}.handlebars`,
-          `api/_app.${language}`,
-        ),
-    );
-  } else {
-    if (language === Language.TS) {
-      await jsonAPI.update(
-        context.materials.default.get(path.join(appDir, 'tsconfig.json')),
-        {
-          query: {},
-          update: {
-            $set: {
-              'compilerOptions.paths.@api/*': ['./api/lambda/*'],
-            },
-          },
-        },
-        true,
-      );
-    }
-    await appApi.forgeTemplate(
-      `templates/framework/lambda/*`,
-      undefined,
-      resourceKey =>
-        resourceKey
-          .replace(`templates/framework/`, 'api/')
-          .replace('.handlebars', `.${language}`),
-    );
-    await appApi.forgeTemplate(
-      `templates/framework/app/${framework as string}/**/*`,
-      resourceKey =>
-        framework === Framework.Koa ? resourceKey.includes(language) : true,
-      resourceKey =>
-        resourceKey
-          .replace(`templates/framework/app/${framework as string}/`, 'api/')
-          .replace(
-            '.handlebars',
-            framework === Framework.Express ? `.${language}` : '',
-          ),
-    );
-  }
-
-  const appendTypeContent = FrameworkAppendTypeContent[framework as Framework];
-
-  if (appendTypeContent && language === Language.TS) {
-    const typePath = path.join(appDir, 'src', 'modern-app-env.d.ts');
-    if (fs.existsSync(typePath)) {
-      const npmrc = fs.readFileSync(typePath, 'utf-8');
-      if (!npmrc.includes(appendTypeContent)) {
-        fs.writeFileSync(typePath, `${npmrc}${appendTypeContent}\n`, 'utf-8');
-      }
-    } else {
-      fs.ensureFileSync(typePath);
-      fs.writeFileSync(typePath, appendTypeContent, 'utf-8');
-    }
-  }
-};
-
-export default async (context: GeneratorContext, generator: GeneratorCore) => {
-  const appApi = new AppAPI(context, generator);
-
-  const { locale } = context.config;
-  i18n.changeLanguage({ locale });
-  appApi.i18n.changeLanguage({ locale });
-  commonI18n.changeLanguage({ locale });
-
-  if (!(await appApi.checkEnvironment())) {
-    process.exit(1);
-  }
-
-  generator.logger.debug(`🚀 [Start Run BFF Generator]`);
-  generator.logger.debug(
-    '💡 [Current Config]:',
-    JSON.stringify(context.config),
-  );
-
-  try {
-    await handleTemplateFile(context, generator, appApi);
-  } catch (e) {
-    process.exit(1);
-  }
-
-  await appApi.runInstall(undefined, { ignoreScripts: true });
-
-  if (!context.config.isSubGenerator) {
-    await appApi.runInstall(undefined, { ignoreScripts: true });
-    if (!context.config.pluginName) {
-      appApi.showSuccessInfo();
-    } else {
-      const appDir = context.materials.default.basePath;
-      const configFile = await getModernConfigFile(appDir);
-      const isTS = configFile.endsWith('ts');
-      const {
-        pluginName,
-        bffPluginName,
-        pluginDependence,
-        bffPluginDependence,
-        shouldUsePluginNameExport,
-      } = context.config;
-      console.info(
-        chalk.green(`\n[INFO]`),
-        `${i18n.t(localeKeys.success)}`,
-        chalk.yellow.bold(`${configFile}`),
-        ':',
-        '\n',
-      );
-      if (shouldUsePluginNameExport) {
-        console.info(
-          chalk.yellow.bold(
-            `import { ${pluginName} } from '${pluginDependence}';`,
-          ),
-        );
-        console.info(
-          chalk.yellow.bold(
-            `import { ${bffPluginName} } from '${bffPluginDependence}';`,
-          ),
-        );
-      } else {
-        console.info(
-          chalk.yellow.bold(`import ${pluginName} from '${pluginDependence}';`),
-        );
-        console.info(
-          chalk.yellow.bold(
-            `import ${bffPluginName} from '${bffPluginDependence}';`,
-          ),
-        );
-      }
-
-      if (isTS) {
-        console.info(`
-export default defineConfig({
-  ...,
-  plugins: [..., ${chalk.yellow.bold(`${pluginName}(), ${bffPluginName}()`)}],
-});
-`);
-      } else {
-        console.info(`
-module.exports = {
-  ...,
-  plugins: [..., ${chalk.yellow.bold(`${pluginName}(), ${bffPluginName}()`)}],
-};
-`);
-      }
-    }
-  }
-
-  generator.logger.debug(`🌟 [End Run BFF Generator]`);
-};