create-umi 4.0.51 → 4.0.52

package/dist/index.d.ts

@@ -1,12 +1,41 @@
 import { yParser } from '@umijs/utils';
 interface IArgs extends yParser.Arguments {
     default?: boolean;
-    plugin?: boolean;
     git?: boolean;
     install?: boolean;
 }
-declare const _default: ({ cwd, args }: {
+interface ITemplatePluginParams {
+    pluginName?: string;
+}
+interface ITemplateParams extends ITemplatePluginParams {
+    version: string;
+    npmClient: ENpmClient;
+    registry: string;
+    author: string;
+    email: string;
+    withHusky: boolean;
+    extraNpmrc: string;
+}
+declare enum ENpmClient {
+    npm = "npm",
+    cnpm = "cnpm",
+    tnpm = "tnpm",
+    yarn = "yarn",
+    pnpm = "pnpm"
+}
+declare enum ETemplate {
+    app = "app",
+    max = "max",
+    vueApp = "vue-app",
+    plugin = "plugin"
+}
+export interface IDefaultData extends ITemplateParams {
+    appTemplate?: ETemplate;
+}
+interface IGeneratorOpts {
     cwd: string;
     args: IArgs;
-}) => Promise<void>;
+    defaultData?: IDefaultData;
+}
+declare const _default: ({ cwd, args, defaultData, }: IGeneratorOpts) => Promise<void>;
 export default _default;

package/dist/index.js

@@ -25,122 +25,133 @@ module.exports = __toCommonJS(src_exports);
 var import_utils = require("@umijs/utils");
 var import_fs = require("fs");
 var import_path = require("path");
-var testData = {
-  name: "umi-plugin-demo",
-  description: "nothing",
-  mail: "xiaohuoni@gmail.com",
-  author: "xiaohuoni",
-  org: "umijs",
-  version: require("../package").version,
-  npmClient: "pnpm",
-  registry: "https://registry.npmjs.org/"
+var pkg = require("../package");
+var DEFAULT_DATA = {
+  pluginName: "umi-plugin-demo",
+  email: "i@domain.com",
+  author: "umijs",
+  version: pkg.version,
+  npmClient: "pnpm" /* pnpm */,
+  registry: "https://registry.npmjs.com/" /* npm */,
+  withHusky: false,
+  extraNpmrc: "",
+  appTemplate: "app" /* app */
 };
-var src_default = async ({ cwd, args }) => {
-  const [name] = args._;
-  let npmClient = "pnpm";
-  let registry = "https://registry.npmjs.org/";
-  let appTemplate = "app";
+var src_default = async ({
+  cwd,
+  args,
+  defaultData = DEFAULT_DATA
+}) => {
+  let [name] = args._;
+  let npmClient = "pnpm" /* pnpm */;
+  let registry = "https://registry.npmjs.com/" /* npm */;
+  let appTemplate = (defaultData == null ? void 0 : defaultData.appTemplate) || "app" /* app */;
   const { username, email } = await (0, import_utils.getGitInfo)();
-  let author = email && username ? `${username} <${email}>` : "";
-  if (!args.default) {
-    const response = await (0, import_utils.prompts)(
-      [
+  const author = email && username ? `${username} <${email}>` : "";
+  let pluginName = `umi-plugin-${name || "demo"}`;
+  const { isCancel, text, select, intro, outro } = import_utils.clackPrompts;
+  const exitPrompt = () => {
+    outro(import_utils.chalk.red("Exit create-umi"));
+    process.exit(1);
+  };
+  const useDefaultData = args.default;
+  if (!useDefaultData) {
+    intro(import_utils.chalk.bgHex("#19BDD2")(" create-umi "));
+    appTemplate = await select({
+      message: "Pick Umi App Template",
+      options: [
+        { label: "Simple App", value: "app" /* app */ },
         {
-          type: "select",
-          name: "appTemplate",
-          message: "Pick Umi App Template",
-          choices: [
-            { title: "Simple App", value: "app" },
-            { title: "Ant Design Pro", value: "max" },
-            { title: "Vue Simple App", value: "vue-app" }
-          ],
-          initial: 0
+          label: "Ant Design Pro",
+          value: "max" /* max */,
+          hint: "more plugins and ready to use features"
         },
+        { label: "Vue Simple App", value: "vue-app" /* vueApp */ },
         {
-          type: "select",
-          name: "npmClient",
-          message: "Pick Npm Client",
-          choices: [
-            { title: "npm", value: "npm" },
-            { title: "cnpm", value: "cnpm" },
-            { title: "tnpm", value: "tnpm" },
-            { title: "yarn", value: "yarn" },
-            { title: "pnpm", value: "pnpm" }
-          ],
-          initial: 4
+          label: "Umi Plugin",
+          value: "plugin" /* plugin */,
+          hint: "for plugin development"
+        }
+      ],
+      initialValue: "app" /* app */
+    });
+    if (isCancel(appTemplate)) {
+      exitPrompt();
+    }
+    npmClient = await select({
+      message: "Pick Npm Client",
+      options: [
+        { label: "npm" /* npm */, value: "npm" /* npm */ },
+        { label: "cnpm" /* cnpm */, value: "cnpm" /* cnpm */ },
+        { label: "tnpm" /* tnpm */, value: "tnpm" /* tnpm */ },
+        { label: "yarn" /* yarn */, value: "yarn" /* yarn */ },
+        { label: "pnpm" /* pnpm */, value: "pnpm" /* pnpm */, hint: "recommended" }
+      ],
+      initialValue: "pnpm" /* pnpm */
+    });
+    if (isCancel(npmClient)) {
+      exitPrompt();
+    }
+    registry = await select({
+      message: "Pick Npm Registry",
+      options: [
+        {
+          label: "npm",
+          value: "https://registry.npmjs.com/" /* npm */
         },
         {
-          type: "select",
-          name: "registry",
-          message: "Pick Npm Registry",
-          choices: [
-            {
-              title: "npm",
-              value: "https://registry.npmjs.org/",
-              selected: true
-            },
-            { title: "taobao", value: "https://registry.npmmirror.com" }
-          ]
+          label: "taobao",
+          value: "https://registry.npmmirror.com" /* taobao */,
+          hint: "recommended for China"
         }
       ],
-      {
-        onCancel() {
-          process.exit(1);
+      initialValue: "https://registry.npmjs.com/" /* npm */
+    });
+    if (isCancel(registry)) {
+      exitPrompt();
+    }
+    const isPlugin = appTemplate === "plugin" /* plugin */;
+    if (isPlugin) {
+      pluginName = await text({
+        message: `What's the plugin name?`,
+        placeholder: pluginName,
+        validate: (value) => {
+          if (!(value == null ? void 0 : value.length)) {
+            return "Please input plugin name";
+          }
         }
+      });
+      if (isCancel(pluginName)) {
+        exitPrompt();
       }
-    );
-    npmClient = response.npmClient;
-    registry = response.registry;
-    appTemplate = response.appTemplate;
-  }
-  const pluginPrompts = [
-    {
-      name: "name",
-      type: "text",
-      message: `What's the plugin name?`,
-      default: name
-    },
-    {
-      name: "description",
-      type: "text",
-      message: `What's your plugin used for?`
-    },
-    {
-      name: "mail",
-      type: "text",
-      message: `What's your email?`
-    },
-    {
-      name: "author",
-      type: "text",
-      message: `What's your name?`
-    },
-    {
-      name: "org",
-      type: "text",
-      message: `Which organization is your plugin stored under github?`
     }
-  ];
+    outro(import_utils.chalk.green(`You're all set!`));
+  }
   const target = name ? (0, import_path.join)(cwd, name) : cwd;
-  const templateName = args.plugin ? "plugin" : appTemplate;
-  const version = require("../package").version;
+  const version = pkg.version;
   const monorepoRoot = await detectMonorepoRoot({ target });
   const inMonorepo = !!monorepoRoot;
   const projectRoot = inMonorepo ? monorepoRoot : target;
   const shouldInitGit = args.git !== false;
   const withHusky = shouldInitGit && !inMonorepo;
+  const isPnpm = npmClient === "pnpm" /* pnpm */;
   const generator = new import_utils.BaseGenerator({
-    path: (0, import_path.join)(__dirname, "..", "templates", templateName),
+    path: (0, import_path.join)(__dirname, "..", "templates", appTemplate),
     target,
-    data: args.default ? testData : {
+    slient: true,
+    data: useDefaultData ? defaultData : {
       version: version.includes("-canary.") ? version : `^${version}`,
       npmClient,
       registry,
       author,
+      email,
       withHusky,
-      extraNpmrc: npmClient === "pnpm" ? `strict-peer-dependencies=false` : ""
-    },
-    questions: args.default ? [] : args.plugin ? pluginPrompts : []
+      // suppress pnpm v7 warning
+      // No need when `pnpm` > v7.13.5 , but we are forward compatible
+      // https://pnpm.io/npmrc#strict-peer-dependencies
+      extraNpmrc: isPnpm ? `strict-peer-dependencies=false` : "",
+      pluginName
+    }
   });
   await generator.run();
   const context = {
@@ -159,7 +170,7 @@ var src_default = async ({ cwd, args }) => {
   } else {
     import_utils.logger.info(`Skip Git init`);
   }
-  if (!args.default && args.install !== false) {
+  if (!useDefaultData && args.install !== false) {
     (0, import_utils.installWithNpmClient)({ npmClient, cwd: target });
   } else {
     import_utils.logger.info(`Skip install deps`);
@@ -196,7 +207,6 @@ async function initGit(opts) {
     return;
   try {
     await import_utils.execa.execa("git", ["init"], { cwd: projectRoot });
-    import_utils.logger.ready(`Git initialized successfully`);
   } catch {
     import_utils.logger.error(`Initial the git repo failed`);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-umi",
-  "version": "4.0.51",
+  "version": "4.0.52",
   "description": "create-umi",
   "homepage": "https://github.com/umijs/umi/tree/master/packages/create-umi#readme",
   "bugs": "https://github.com/umijs/umi/issues",
@@ -25,7 +25,7 @@
     "test": "umi-scripts jest-turbo"
   },
   "dependencies": {
-    "@umijs/utils": "4.0.51"
+    "@umijs/utils": "4.0.52"
   },
   "publishConfig": {
     "access": "public"

package/templates/plugin/.fatherrc.ts

@@ -1,5 +1,5 @@
-export default {
-  target: 'node',
-  cjs: { type: 'babel', lazy: true },
-  disableTypeCheck: true,
-};
+import { defineConfig } from 'father';
+
+export default defineConfig({
+  cjs: {},
+});

package/templates/plugin/.gitignore.tpl

@@ -1,2 +1,2 @@
 node_modules
-lib
+/dist

package/templates/plugin/README.md.tpl

@@ -1,30 +1,21 @@
-# {{{ name }}}
+# {{{ pluginName }}}
 
-[![NPM version](https://img.shields.io/npm/v/{{{ name }}}.svg?style=flat)](https://npmjs.org/package/{{{ name }}})
-[![NPM downloads](http://img.shields.io/npm/dm/{{{ name }}}.svg?style=flat)](https://npmjs.org/package/{{{ name }}})
-
-{{{ description }}}
+A umi plugin
 
 ## Install
 
 ```bash
-# or yarn
-$ npm install
-```
-
-```bash
-$ npm run build --watch
-$ npm run start
+pnpm i {{{ pluginName }}}
 ```
 
 ## Usage
 
-Configure in `.umirc.js`,
+Configure in `.umirc.ts`,
 
 ```js
 export default {
   plugins: [
-    ['{{{ name }}}'],
+    ['{{{ pluginName }}}'],
   ],
 }
 ```

package/templates/plugin/package.json.tpl

@@ -1,25 +1,26 @@
 {
-  "name": "{{{ name }}}",
+  "name": "{{{ pluginName }}}",
   "author": "{{{ author }}}",
   "version": "0.0.1",
-  "description": "{{{ description }}}",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "types": "dist/cjs/index.d.ts",
   "scripts": {
-    "build": "father-build"
+    "dev": "father dev",
+    "build": "father build"
   },
   "keywords": [],
-  "repository": "{{{ org }}}/{{{ name }}}",
   "authors": {
     "name": "{{{ author }}}",
-    "email": "{{{ mail }}}"
+    "email": "{{{ email }}}"
   },
   "license": "MIT",
   "files": [
-    "lib"
+    "dist"
   ],
   "devDependencies": {
-    "@umijs/types": "{{{ version }}}",
-    "father-build": "^1.20.0"
+    "father": "^4.0.0",
+    "umi": "{{{ version }}}",
+    "@types/node": "^18.0.0",
+    "typescript": "^4.0.0"
   }
 }

package/templates/plugin/src/index.ts.tpl

@@ -1,5 +1,5 @@
-import type { IApi } from '@umijs/types';
+import type { IApi } from 'umi';
 
 export default (api: IApi) => {
-  // TODO: https://umijs.org/plugins/api
+  // See https://umijs.org/docs/guides/plugins
 };

package/templates/plugin/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es2019",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": false,
+    "noEmit": false,
+    "declaration": true
+  }
+}