@modern-js/mwa-generator 3.0.4 → 3.0.6

package/README.md

@@ -1,30 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
-<p align="center">
-  The meta-framework suite designed from scratch for frontend-focused modern web development
+  A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Getting Started
 
-- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

package/dist/index.js

@@ -35762,7 +35762,7 @@ var require_nodeEnv = __commonJS({
       });
     }
     exports.canUseNpm = canUseNpm2;
-    function canUseYarn2() {
+    function canUseYarn() {
       return __async(this, null, function* () {
         try {
           yield (0, compiled_1.execa)("yarn", ["--version"], { env: process.env });
@@ -35772,7 +35772,7 @@ var require_nodeEnv = __commonJS({
         }
       });
     }
-    exports.canUseYarn = canUseYarn2;
+    exports.canUseYarn = canUseYarn;
     function canUsePnpm2() {
       return __async(this, null, function* () {
         try {
@@ -44410,7 +44410,7 @@ var require_env = __commonJS({
     exports.canUseNpm = canUseNpm2;
     exports.canUseNvm = canUseNvm;
     exports.canUsePnpm = canUsePnpm2;
-    exports.canUseYarn = canUseYarn2;
+    exports.canUseYarn = canUseYarn;
     var _utils = require_dist();
     function canUseNvm() {
       return __async(this, null, function* () {
@@ -44437,7 +44437,7 @@ var require_env = __commonJS({
         }
       });
     }
-    function canUseYarn2() {
+    function canUseYarn() {
       return __async(this, null, function* () {
         try {
           yield (0, _utils.execa)("yarn", ["--version"], {
@@ -45473,14 +45473,14 @@ var require_packageManager = __commonJS({
       value: true
     });
     exports.canUsePnpm = canUsePnpm2;
-    exports.canUseYarn = canUseYarn2;
+    exports.canUseYarn = canUseYarn;
     exports.runInstall = runInstall;
     var _path = _interopRequireDefault(require("path"));
     var _utils = require_dist();
     function _interopRequireDefault(obj) {
       return obj && obj.__esModule ? obj : { default: obj };
     }
-    function canUseYarn2() {
+    function canUseYarn() {
       return __async(this, null, function* () {
         try {
           yield (0, _utils.execa)("yarn", ["--version"], {
@@ -45527,7 +45527,7 @@ var require_packageManager = __commonJS({
             params.push(`--registry=${registryUrl}`);
           }
           yield (0, _utils.execa)("pnpm", params, options);
-        } else if (yield canUseYarn2()) {
+        } else if (yield canUseYarn()) {
           const params = ["install", "--production", "--silent", "--ignore-scripts"];
           if (registryUrl) {
             params.push(`--registry=${registryUrl}`);
@@ -134820,6 +134820,26 @@ var require_compiled2 = __commonJS({
   }
 });
 
+// ../../../toolkit/utils/dist/commands.js
+var require_commands = __commonJS({
+  "../../../toolkit/utils/dist/commands.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.isDevCommand = exports.getCommand = void 0;
+    var getCommand = () => {
+      const args = process.argv.slice(2);
+      const command = args[0];
+      return command;
+    };
+    exports.getCommand = getCommand;
+    var isDevCommand = () => {
+      const command = (0, exports.getCommand)();
+      return command === "dev" || command === "start";
+    };
+    exports.isDevCommand = isDevCommand;
+  }
+});
+
 // ../../../toolkit/utils/dist/format.js
 var require_format2 = __commonJS({
   "../../../toolkit/utils/dist/format.js"(exports) {
@@ -135195,12 +135215,14 @@ var require_node_env2 = __commonJS({
   "../../../toolkit/utils/dist/is/node-env.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.isProdProfile = exports.isTest = exports.isProd = exports.isDev = void 0;
-    var isDev = () => process.env.NODE_ENV === "development";
+    exports.isProdProfile = exports.isTest = exports.isProd = exports.isDev = exports.getNodeEnv = void 0;
+    var getNodeEnv = () => process.env.NODE_ENV || "development";
+    exports.getNodeEnv = getNodeEnv;
+    var isDev = () => (0, exports.getNodeEnv)() === "development";
     exports.isDev = isDev;
-    var isProd = () => process.env.NODE_ENV === "production";
+    var isProd = () => (0, exports.getNodeEnv)() === "production";
     exports.isProd = isProd;
-    var isTest = () => process.env.NODE_ENV === "test";
+    var isTest = () => (0, exports.getNodeEnv)() === "test";
     exports.isTest = isTest;
     var isProdProfile = () => (0, exports.isProd)() && process.argv.includes("--profile");
     exports.isProdProfile = isProdProfile;
@@ -135343,10 +135365,10 @@ var require_is2 = __commonJS({
 
 // ../../../toolkit/utils/dist/compatRequire.js
 var require_compatRequire2 = __commonJS({
-  "../../../toolkit/utils/dist/compatRequire.js"(exports) {
+  "../../../toolkit/utils/dist/compatRequire.js"(exports, module2) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.cleanRequireCache = exports.requireExistModule = exports.dynamicImport = exports.compatRequire = void 0;
+    exports.deleteRequireCache = exports.cleanRequireCache = exports.requireExistModule = exports.dynamicImport = exports.compatRequire = void 0;
     var findExists_1 = require_findExists2();
     var compatRequire = (filePath, interop = true) => {
       const mod = require(filePath);
@@ -135373,6 +135395,15 @@ var require_compatRequire2 = __commonJS({
       });
     };
     exports.cleanRequireCache = cleanRequireCache;
+    function deleteRequireCache(path3) {
+      if (require.cache[path3]) {
+        delete require.cache[path3];
+      }
+      if (module2.children) {
+        module2.children = module2.children.filter((item) => item.filename !== path3);
+      }
+    }
+    exports.deleteRequireCache = deleteRequireCache;
   }
 });
 
@@ -135394,7 +135425,7 @@ var require_constants6 = __commonJS({
     exports.SERVER_DIR = "server";
     exports.SHARED_DIR = "shared";
     exports.CONFIG_CACHE_DIR = "./node_modules/.cache/node-bundle-require";
-    exports.CONFIG_FILE_EXTENSIONS = [".js", ".ts", ".ejs", ".mjs"];
+    exports.CONFIG_FILE_EXTENSIONS = [".js", ".ts", ".mjs"];
     exports.OUTPUT_CONFIG_FILE = "modern.config.json";
     exports.DEFAULT_SERVER_CONFIG = "modern.server-runtime.config";
     exports.ROUTE_MINIFEST_FILE = "routes-manifest.json";
@@ -135885,7 +135916,7 @@ var require_nodeEnv2 = __commonJS({
       });
     }
     exports.canUseNpm = canUseNpm2;
-    function canUseYarn2() {
+    function canUseYarn() {
       return __async(this, null, function* () {
         try {
           yield (0, compiled_1.execa)("yarn", ["--version"], { env: process.env });
@@ -135895,7 +135926,7 @@ var require_nodeEnv2 = __commonJS({
         }
       });
     }
-    exports.canUseYarn = canUseYarn2;
+    exports.canUseYarn = canUseYarn;
     function canUsePnpm2() {
       return __async(this, null, function* () {
         try {
@@ -136974,6 +137005,7 @@ var require_dist3 = __commonJS({
     };
     Object.defineProperty(exports, "__esModule", { value: true });
     __exportStar(require_compiled2(), exports);
+    __exportStar(require_commands(), exports);
     __exportStar(require_format2(), exports);
     __exportStar(require_FileSizeReporter2(), exports);
     __exportStar(require_printBuildError2(), exports);
@@ -137193,7 +137225,7 @@ var ZH_LOCALE = {
 var EN_LOCALE = {
   solution: {
     self: "Please select the solution you want to create",
-    mwa: "MWA Solution",
+    mwa: "Web App Solution",
     module: "Module Solution",
     monorepo: "Monorepo Solution",
     custom: "Custom Solution",
@@ -137204,10 +137236,10 @@ var EN_LOCALE = {
   },
   sub_solution: {
     self: "Please select the solution you want to create",
-    mwa: "MWA Solution",
-    mwa_test: "MWA Solution(Test)",
+    mwa: "Web App Solution",
+    mwa_test: "Web App Solution (Test)",
     module: "Module Solution",
-    inner_module: "Module Solution(Inner)",
+    inner_module: "Module Solution (Inner)",
     monorepo: "Monorepo Solution"
   },
   action: {
@@ -137510,15 +137542,6 @@ function getPackageVersion(packageName, registry2) {
       spinner.stop();
       return stripAnsi2(result.stdout);
     }
-    if (yield (0, import_utils2.canUseYarn)()) {
-      const args = ["info", packageName, "version", "--silent"];
-      if (registry2) {
-        args.push(`--registry=${registry2}`);
-      }
-      const result = yield (0, import_utils2.execa)("yarn", args);
-      spinner.stop();
-      return stripAnsi2(result.stdout);
-    }
     if (yield (0, import_utils2.canUseNpm)()) {
       const args = ["view", packageName, "version"];
       if (registry2) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modern-js/mwa-generator",
-  "description": "The meta-framework suite designed from scratch for frontend-focused modern web development.",
+  "description": "A Progressive React Framework for modern web development.",
   "homepage": "https://modernjs.dev",
   "bugs": "https://github.com/modern-js-dev/modern.js/issues",
   "repository": "modern-js-dev/modern.js",
@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "3.0.4",
+  "version": "3.0.6",
   "jsnext:source": "./src/index.ts",
   "main": "./dist/index.js",
   "files": [
@@ -27,15 +27,15 @@
     "@types/node": "^14",
     "jest": "^27",
     "typescript": "^4",
-    "@modern-js/entry-generator": "3.0.4",
-    "@modern-js/generator-utils": "3.0.4",
-    "@modern-js/dependence-generator": "3.0.4",
-    "@modern-js/packages-generator": "3.0.4",
-    "@modern-js/plugin-i18n": "2.2.0",
-    "@modern-js/generator-common": "3.0.4",
-    "@modern-js/base-generator": "3.0.4",
-    "@scripts/build": "2.2.0",
-    "@scripts/jest-config": "2.2.0"
+    "@modern-js/base-generator": "3.0.6",
+    "@modern-js/entry-generator": "3.0.6",
+    "@modern-js/generator-utils": "3.0.6",
+    "@modern-js/packages-generator": "3.0.6",
+    "@modern-js/plugin-i18n": "2.4.0",
+    "@modern-js/dependence-generator": "3.0.6",
+    "@modern-js/generator-common": "3.0.6",
+    "@scripts/jest-config": "2.4.0",
+    "@scripts/build": "2.4.0"
   },
   "sideEffects": false,
   "publishConfig": {

package/src/index.ts

@@ -0,0 +1,271 @@
+import path from 'path';
+import { GeneratorContext, GeneratorCore } from '@modern-js/codesmith';
+import { AppAPI } from '@modern-js/codesmith-api-app';
+import { JsonAPI } from '@modern-js/codesmith-api-json';
+import {
+  i18n as commonI18n,
+  BaseGenerator,
+  Solution,
+  getMWASchema,
+  Language,
+  EntryGenerator,
+  PackagesGenerator,
+} from '@modern-js/generator-common';
+import {
+  getMWAProjectPath,
+  getAllPackages,
+  i18n as utilsI18n,
+  validatePackageName,
+  validatePackagePath,
+  getPackageManagerText,
+  getModernVersion,
+} from '@modern-js/generator-utils';
+import { i18n, localeKeys } from './locale';
+
+const getGeneratorPath = (generator: string, distTag: string) => {
+  if (process.env.CODESMITH_ENV === 'development') {
+    return path.dirname(require.resolve(generator));
+  } else if (distTag) {
+    return `${generator}@${distTag}`;
+  }
+  return generator;
+};
+
+export const handleTemplateFile = async (
+  context: GeneratorContext,
+  generator: GeneratorCore,
+  appApi: AppAPI,
+) => {
+  const jsonAPI = new JsonAPI(generator);
+
+  const { isMonorepoSubProject, isTest, projectDir = '' } = context.config;
+
+  const { outputPath } = generator;
+
+  let packages: string[] = [];
+
+  if (isMonorepoSubProject) {
+    try {
+      packages = getAllPackages(outputPath);
+    } catch (e) {
+      generator.logger.debug('get all packages error', e);
+      generator.logger.warn(i18n.t(localeKeys.get_packages_error));
+    }
+  }
+
+  context.config = {
+    ...context.config,
+    isMwa: true,
+    isEmptySrc: true,
+  };
+
+  const { hasPlugin, generatorPlugin, ...extra } = context.config;
+
+  let ans: Record<string, unknown> = {};
+
+  if (hasPlugin) {
+    await generatorPlugin.installPlugins(Solution.MWA, extra);
+    const schema = generatorPlugin.getInputSchema();
+    const inputValue = generatorPlugin.getInputValue();
+    context.config.gitCommitMessage =
+      generatorPlugin.getGitMessage() || context.config.gitCommitMessage;
+    ans = await appApi.getInputBySchema(
+      schema,
+      'formily',
+      { ...context.config, ...inputValue },
+      {
+        packageName: input =>
+          validatePackageName(input as string, packages, {
+            isMonorepoSubProject,
+          }),
+        packagePath: input =>
+          validatePackagePath(
+            input as string,
+            path.join(process.cwd(), projectDir),
+            {
+              isTest,
+              isMwa: true,
+            },
+          ),
+      },
+      {},
+    );
+  } else {
+    ans = await appApi.getInputBySchemaFunc(
+      getMWASchema,
+      { ...context.config },
+      {
+        packageName: input =>
+          validatePackageName(input as string, packages, {
+            isMonorepoSubProject,
+          }),
+        packagePath: input =>
+          validatePackagePath(
+            input as string,
+            path.join(process.cwd(), projectDir),
+            { isTest, isMwa: true },
+          ),
+      },
+    );
+  }
+
+  const modernVersion = await getModernVersion(
+    Solution.MWA,
+    context.config.registry,
+    context.config.distTag,
+  );
+
+  generator.logger.debug(`inputData=${JSON.stringify(ans)}`, ans);
+
+  const { packageName, packagePath, language } = ans;
+
+  const projectPath = getMWAProjectPath(
+    packagePath as string,
+    isMonorepoSubProject,
+    isTest,
+  );
+
+  const dirname = path.basename(generator.outputPath);
+
+  await appApi.runSubGenerator(
+    getGeneratorPath(BaseGenerator, context.config.distTag),
+    undefined,
+    { ...context.config, hasPlugin: false },
+  );
+
+  await appApi.forgeTemplate(
+    'templates/base-template/**/*',
+    undefined,
+    resourceKey =>
+      resourceKey
+        .replace('templates/base-template/', projectPath)
+        .replace('.handlebars', ''),
+    {
+      name: packageName || dirname,
+      isMonorepoSubProject,
+      modernVersion,
+    },
+  );
+
+  if (language === Language.TS) {
+    await jsonAPI.update(
+      context.materials.default.get(path.join(projectPath, 'package.json')),
+      {
+        query: {},
+        update: {
+          $set: {
+            'devDependencies.typescript': '~4.9.4',
+            'devDependencies.@types/jest': '~29.2.4',
+            'devDependencies.@types/node': '~16.11.7',
+            'devDependencies.@types/react': '~18.0.26',
+            'devDependencies.@types/react-dom': '~18.0.10',
+          },
+        },
+      },
+    );
+
+    await appApi.forgeTemplate(
+      'templates/ts-template/**/*',
+      undefined,
+      resourceKey =>
+        resourceKey
+          .replace('templates/ts-template/', projectPath)
+          .replace('.handlebars', ''),
+    );
+  } else {
+    await appApi.forgeTemplate(
+      'templates/js-template/**/*',
+      undefined,
+      resourceKey =>
+        resourceKey
+          .replace('templates/js-template/', projectPath)
+          .replace('.handlebars', ''),
+    );
+  }
+
+  await appApi.runSubGenerator(
+    getGeneratorPath(EntryGenerator, context.config.distTag),
+    `./${projectPath}`,
+    {
+      ...context.config,
+      isSubGenerator: true,
+    },
+  );
+
+  if (isMonorepoSubProject) {
+    await appApi.updateWorkspace({
+      name: packagePath as string,
+      path: projectPath,
+    });
+  }
+
+  const { packagesInfo } = context.config;
+  if (packagesInfo && Object.keys(packagesInfo).length > 0) {
+    await appApi.runSubGenerator(
+      getGeneratorPath(PackagesGenerator, context.config.distTag),
+      undefined,
+      context.config,
+    );
+  }
+
+  return { projectPath };
+};
+
+export default async (context: GeneratorContext, generator: GeneratorCore) => {
+  const appApi = new AppAPI(context, generator);
+
+  const { locale, successInfo } = context.config;
+  commonI18n.changeLanguage({ locale });
+  utilsI18n.changeLanguage({ locale });
+  appApi.i18n.changeLanguage({ locale });
+  i18n.changeLanguage({ locale });
+
+  if (!(await appApi.checkEnvironment())) {
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
+  }
+
+  generator.logger.debug(`start run @modern-js/mwa-generator`);
+  generator.logger.debug(`context=${JSON.stringify(context)}`);
+  generator.logger.debug(`context.data=${JSON.stringify(context.data)}`);
+
+  let projectPath = '';
+  try {
+    ({ projectPath } = await handleTemplateFile(context, generator, appApi));
+  } catch (e) {
+    generator.logger.error(e);
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
+  }
+
+  if (context.handleForged) {
+    await context.handleForged(
+      Solution.MWA,
+      context,
+      context.config.hasPlugin,
+      projectPath,
+    );
+  }
+
+  try {
+    await appApi.runGitAndInstall(context.config.gitCommitMessage);
+  } catch (e) {
+    generator.logger.error(e);
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
+  }
+
+  const { packageManager } = context.config;
+
+  if (successInfo) {
+    appApi.showSuccessInfo(successInfo);
+  } else {
+    appApi.showSuccessInfo(
+      i18n.t(localeKeys.success, {
+        packageManager: getPackageManagerText(packageManager),
+      }),
+    );
+  }
+
+  generator.logger.debug(`forge @modern-js/mwa-generator succeed `);
+};