create-egg 3.0.0 → 4.0.1-beta.0

package/README.md

@@ -1,38 +1,77 @@
 # create-egg
 
 [![NPM version][npm-image]][npm-url]
-[![Node.js CI](https://github.com/eggjs/create-egg/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/create-egg/actions/workflows/nodejs.yml)
-[![Test coverage][codecov-image]][codecov-url]
 [![NPM download][download-image]][download-url]
 
 [npm-image]: https://img.shields.io/npm/v/create-egg.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/create-egg
-[codecov-image]: https://codecov.io/gh/eggjs/create-egg/branch/master/graph/badge.svg
-[codecov-url]: https://codecov.io/gh/eggjs/create-egg
 [download-image]: https://img.shields.io/npm/dm/create-egg.svg?style=flat-square
 [download-url]: https://npmjs.org/package/create-egg
 
-Alias for [egg-init](https://github.com/eggjs/egg-init), so you could use `npm init egg showcase`.
+> Fork and refactor from [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite)
 
-Thanks to `npm init` feature introduced at npm@6, see [npm-init](https://docs.npmjs.com/cli/init) for more details.
+## Scaffolding Your First Egg.js Project
 
-## Usage
+> **Compatibility Note:**
+> Egg.js requires [Node.js](https://nodejs.org/) version 20.19+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.
+
+With NPM:
 
 ```bash
-npm init egg showcase
-npm init egg showcase --type=simple
+npm create egg@latest
 ```
 
-[MIT](LICENSE)
+With Yarn:
 
-<!-- GITCONTRIBUTOR_START -->
+```bash
+yarn create egg
+```
 
-## Contributors
+With PNPM:
+
+```bash
+pnpm create egg
+```
 
-|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|[<img src="https://avatars.githubusercontent.com/u/3297859?v=4" width="100px;"/><br/><sub><b>sinchang</b></sub>](https://github.com/sinchang)<br/>|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/106730421?v=4" width="100px;"/><br/><sub><b>jasonjiicloud</b></sub>](https://github.com/jasonjiicloud)<br/>|
-| :---: | :---: | :---: | :---: |
+Then follow the prompts!
+
+You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Egg.js + TypeScript project, run:
+
+```bash
+# npm 7+
+npm create egg@latest my-egg-app -- --template tegg
+
+# yarn
+yarn create egg my-egg-app --template tegg
+
+# pnpm
+pnpm create egg my-egg-app --template tegg
+```
 
+Currently supported template presets include:
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Tue Nov 28 2023 13:41:55 GMT+0800`.
+- `tegg`
+- `egg3-tegg`
+- `egg3-simple-js`
 
-<!-- GITCONTRIBUTOR_END -->
+You can use `.` for the project name to scaffold in the current directory.
+
+## Community Templates
+
+Check out Awesome Egg.js for [community maintained templates](https://github.com/eggjs/awesome-egg#boilerplates) that include other tools or target different frameworks. You can use a tool like [degit](https://github.com/Rich-Harris/degit) to scaffold your project with one of the templates.
+
+```bash
+npx degit user/project my-project
+cd my-project
+
+npm install
+npm run dev
+```
+
+If the project uses `main` as the default branch, suffix the project repo with `#main`
+
+```bash
+npx degit user/project#main my-project
+```
+
+[MIT](LICENSE)

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/cli.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { init } from "./index.js";
+
+//#region src/cli.ts
+init().catch((err) => {
+	console.error("create egg failed", err);
+	process.exit(1);
+});
+
+//#endregion
+export {  };

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+//#region src/index.d.ts
+declare function init(): Promise<void>;
+//#endregion
+export { init };

package/dist/index.js

@@ -0,0 +1,254 @@
+import fs from "node:fs";
+import path from "node:path";
+import spawn from "cross-spawn";
+import mri from "mri";
+import * as prompts from "@clack/prompts";
+import colors from "picocolors";
+
+//#region src/index.ts
+const { blue, blueBright, green, greenBright, yellow } = colors;
+const argv = mri(process.argv.slice(2), {
+	alias: {
+		h: "help",
+		t: "template"
+	},
+	boolean: ["help", "overwrite"],
+	string: ["template"]
+});
+const cwd = process.cwd();
+const helpMessage = `\
+Usage: create-egg [OPTION]... [DIRECTORY]
+
+Create a new Egg.js project.
+With no arguments, start the CLI in interactive mode.
+
+Options:
+  -t, --template NAME        use a specific template
+
+Available templates:
+${green("tegg")}                         egg@4 with tegg module
+${blue("simple-ts")}                    egg@4 with vanilla TypeScript
+${green("egg3-tegg")}                    egg@3 with tegg module
+${blue("egg3-simple-ts")}               egg@3 with vanilla TypeScript
+${yellow("egg3-simple-js")}               egg@3 with vanilla JavaScript
+`;
+const TEMPLATES = [
+	{
+		name: "tegg",
+		display: "Tegg starter, egg@4 with tegg module",
+		color: green
+	},
+	{
+		name: "simple-ts",
+		display: "Simple starter, egg@4 with vanilla TypeScript",
+		color: blue
+	},
+	{
+		name: "egg3-tegg",
+		display: "Tegg starter, egg@3 with tegg module",
+		color: green
+	},
+	{
+		name: "egg3-simple-ts",
+		display: "Simple starter, egg@3 with vanilla TypeScript",
+		color: blue
+	},
+	{
+		name: "egg3-simple-js",
+		display: "Simple starter, egg@3 with vanilla JavaScript",
+		color: yellow
+	}
+];
+const defaultTargetDir = "egg-project";
+async function init() {
+	const argTargetDir = argv._[0] ? formatTargetDir(String(argv._[0])) : void 0;
+	const argTemplate = argv.template;
+	const argOverwrite = argv.overwrite;
+	if (argv.help) {
+		console.log(helpMessage);
+		return;
+	}
+	const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
+	const cancel = () => prompts.cancel("Operation cancelled");
+	prompts.intro(`${greenBright("Egg.js")} - Born to build better enterprise application and framework`);
+	let targetDir = argTargetDir;
+	if (!targetDir) {
+		const projectName = await prompts.text({
+			message: "Project name:",
+			defaultValue: defaultTargetDir,
+			placeholder: defaultTargetDir,
+			validate: (value) => {
+				return value.length === 0 || formatTargetDir(value).length > 0 ? void 0 : "Invalid project name";
+			}
+		});
+		if (prompts.isCancel(projectName)) return cancel();
+		targetDir = formatTargetDir(projectName);
+	}
+	if (fs.existsSync(targetDir) && !isEmpty(targetDir)) {
+		const overwrite = argOverwrite ? "yes" : await prompts.select({
+			message: (targetDir === "." ? "Current directory" : `Target directory "${targetDir}"`) + ` is not empty. Please choose how to proceed:`,
+			options: [
+				{
+					label: "Cancel operation",
+					value: "no"
+				},
+				{
+					label: "Remove existing files and continue",
+					value: "yes"
+				},
+				{
+					label: "Ignore files and continue",
+					value: "ignore"
+				}
+			]
+		});
+		if (prompts.isCancel(overwrite)) return cancel();
+		switch (overwrite) {
+			case "yes":
+				emptyDir(targetDir);
+				break;
+			case "no":
+				cancel();
+				return;
+		}
+	}
+	let packageName = path.basename(path.resolve(targetDir));
+	if (!isValidPackageName(packageName)) {
+		const packageNameResult = await prompts.text({
+			message: "Package name:",
+			defaultValue: toValidPackageName(packageName),
+			placeholder: toValidPackageName(packageName),
+			validate(dir) {
+				if (!isValidPackageName(dir)) return "Invalid package.json name";
+			}
+		});
+		if (prompts.isCancel(packageNameResult)) return cancel();
+		packageName = packageNameResult;
+	}
+	let template = argTemplate;
+	let hasInvalidArgTemplate = false;
+	if (argTemplate && !TEMPLATES.some((t) => t.name === argTemplate)) {
+		template = void 0;
+		hasInvalidArgTemplate = true;
+	}
+	if (!template) {
+		const selectedTemplate = await prompts.select({
+			message: hasInvalidArgTemplate ? `"${argTemplate}" isn't a valid template. Please choose from below: ` : "Select a template:",
+			options: TEMPLATES.map((template$1) => {
+				const templateColor = template$1.color;
+				return {
+					label: templateColor(template$1.display || template$1.name),
+					value: template$1.name
+				};
+			})
+		});
+		if (prompts.isCancel(selectedTemplate)) return cancel();
+		template = selectedTemplate;
+	}
+	const root = path.join(cwd, targetDir);
+	fs.mkdirSync(root, { recursive: true });
+	const pkgManager = pkgInfo ? pkgInfo.name : "npm";
+	const { customCommand } = TEMPLATES.find((t) => t.name === template) ?? {};
+	if (customCommand) {
+		const [command, ...args] = getFullCustomCommand(customCommand, pkgInfo).split(" ");
+		const replacedArgs = args.map((arg) => arg.replace("TARGET_DIR", () => targetDir));
+		const { status } = spawn.sync(command, replacedArgs, { stdio: "inherit" });
+		process.exit(status ?? 0);
+	}
+	prompts.log.step(`Scaffolding project with ${blueBright(template)} in ${root}...`);
+	const templateDir = path.join(import.meta.dirname, `templates/${template}`);
+	const write = (file, content) => {
+		const targetPath = path.join(root, file.startsWith("_") ? file.slice(1) : file);
+		if (content) fs.writeFileSync(targetPath, content);
+		else copy(path.join(templateDir, file), targetPath);
+	};
+	const files = fs.readdirSync(templateDir);
+	for (const file of files.filter((f) => f !== "package.json")) write(file);
+	let pkgJsonContent = fs.readFileSync(path.join(templateDir, `package.json`), "utf-8");
+	pkgJsonContent = pkgJsonContent.replaceAll("{{name}}", packageName);
+	const pkg = JSON.parse(pkgJsonContent);
+	if (pkgInfo) pkg.packageManager = `${pkgInfo.name}@${pkgInfo.version}`;
+	write("package.json", JSON.stringify(pkg, null, 2) + "\n");
+	const cdProjectName = path.relative(cwd, root);
+	if (await prompts.confirm({
+		message: "Initialize git repository?",
+		initialValue: true
+	})) {
+		spawn.sync("git", ["init", cdProjectName], { stdio: "pipe" });
+		prompts.log.success("Git repository initialized");
+	}
+	let doneMessage = "";
+	doneMessage += `Done. Now run:\n`;
+	if (root !== cwd) doneMessage += `\n  cd ${cdProjectName.includes(" ") ? `"${cdProjectName}"` : cdProjectName}`;
+	switch (pkgManager) {
+		case "yarn":
+			doneMessage += "\n  yarn";
+			doneMessage += "\n  yarn dev";
+			break;
+		default:
+			doneMessage += `\n  ${pkgManager} install`;
+			doneMessage += `\n  ${pkgManager} run dev`;
+			break;
+	}
+	prompts.outro(greenBright(doneMessage));
+}
+function formatTargetDir(targetDir) {
+	return targetDir.trim().replace(/\/+$/g, "");
+}
+function copy(src, dest) {
+	if (fs.statSync(src).isDirectory()) copyDir(src, dest);
+	else fs.copyFileSync(src, dest);
+}
+function isValidPackageName(projectName) {
+	return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(projectName);
+}
+function toValidPackageName(projectName) {
+	return projectName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z\d\-~]+/g, "-");
+}
+function copyDir(srcDir, destDir) {
+	fs.mkdirSync(destDir, { recursive: true });
+	for (const file of fs.readdirSync(srcDir)) {
+		const srcFile = path.resolve(srcDir, file);
+		const destFile = path.resolve(destDir, file);
+		copy(srcFile, destFile);
+	}
+}
+function isEmpty(path$1) {
+	const files = fs.readdirSync(path$1);
+	return files.length === 0 || files.length === 1 && files[0] === ".git";
+}
+function emptyDir(dir) {
+	if (!fs.existsSync(dir)) return;
+	for (const file of fs.readdirSync(dir)) {
+		if (file === ".git") continue;
+		fs.rmSync(path.resolve(dir, file), {
+			recursive: true,
+			force: true
+		});
+	}
+}
+function pkgFromUserAgent(userAgent) {
+	if (!userAgent) return void 0;
+	const pkgSpecArr = userAgent.split(" ")[0].split("/");
+	return {
+		name: pkgSpecArr[0],
+		version: pkgSpecArr[1]
+	};
+}
+function getFullCustomCommand(customCommand, pkgInfo) {
+	const pkgManager = pkgInfo ? pkgInfo.name : "npm";
+	const isYarn1 = pkgManager === "yarn" && pkgInfo?.version.startsWith("1.");
+	return customCommand.replace(/^npm create (?:-- )?/, () => {
+		if (pkgManager === "bun") return "bun x create-";
+		if (pkgManager === "pnpm") return "pnpm create ";
+		return customCommand.startsWith("npm create -- ") ? `${pkgManager} create -- ` : `${pkgManager} create `;
+	}).replace("@latest", () => isYarn1 ? "" : "@latest").replace(/^npm exec/, () => {
+		if (pkgManager === "pnpm") return "pnpm dlx";
+		if (pkgManager === "yarn" && !isYarn1) return "yarn dlx";
+		if (pkgManager === "bun") return "bun x";
+		return "npm exec";
+	});
+}
+
+//#endregion
+export { init };

package/dist/templates/egg3-simple-js/.eslintignore

@@ -0,0 +1 @@
+coverage

package/dist/templates/egg3-simple-js/.eslintrc

@@ -0,0 +1,4 @@
+{
+  "extends": "eslint-config-egg",
+  "root": true
+}

package/dist/templates/egg3-simple-js/.vscode/launch.json

@@ -0,0 +1,26 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Egg Debug",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run", "dev", "--", "--inspect-brk"],
+      "console": "integratedTerminal",
+      "restart": true,
+      "autoAttachChildProcesses": true
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Egg Test",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run", "test:local", "--", "--inspect-brk"],
+      "autoAttachChildProcesses": true
+    }
+  ]
+}

package/dist/templates/egg3-simple-js/README.md

@@ -0,0 +1,31 @@
+# hello Egg.js
+
+hello Egg.js
+
+## QuickStart
+
+<!-- add docs here for user -->
+
+see [egg v3 docs][egg@3] for more detail.
+
+### Development
+
+```bash
+npm i
+npm run dev
+open http://localhost:7001/
+```
+
+### Deploy
+
+```bash
+npm start
+npm stop
+```
+
+### npm scripts
+
+- Use `npm run lint` to check code style.
+- Use `npm test` to run unit test.
+
+[egg@3]: https://v3.eggjs.org/

package/dist/templates/egg3-simple-js/_.gitignore

@@ -0,0 +1,15 @@
+logs/
+npm-debug.log
+yarn-error.log
+node_modules/
+*-lock.json
+*-lock.yaml
+yarn.lock
+coverage/
+.idea/
+run/
+.DS_Store
+*.sw*
+*.un~
+typings/
+.nyc_output/

package/dist/templates/egg3-simple-js/app/controller/home.js

@@ -0,0 +1,10 @@
+const { Controller } = require('egg');
+
+class HomeController extends Controller {
+  async index() {
+    const { ctx } = this;
+    ctx.body = 'hi, egg';
+  }
+}
+
+module.exports = HomeController;

package/dist/templates/egg3-simple-js/app/router.js

@@ -0,0 +1,7 @@
+/**
+ * @param {Egg.Application} app - egg application
+ */
+module.exports = app => {
+  const { router, controller } = app;
+  router.get('/', controller.home.index);
+};

package/dist/templates/egg3-simple-js/config/config.default.js

@@ -0,0 +1,28 @@
+/* eslint valid-jsdoc: "off" */
+
+/**
+ * @param {Egg.EggAppInfo} appInfo app info
+ */
+module.exports = appInfo => {
+  /**
+   * built-in config
+   * @type {Egg.EggAppConfig}
+   **/
+  const config = (exports = {});
+
+  // use for cookie sign key, should change to your own and keep security
+  config.keys = appInfo.name + '_{{keys}}';
+
+  // add your middleware config here
+  config.middleware = [];
+
+  // add your user config here
+  const userConfig = {
+    // myAppName: 'egg',
+  };
+
+  return {
+    ...config,
+    ...userConfig,
+  };
+};

package/dist/templates/egg3-simple-js/config/plugin.js

@@ -0,0 +1,7 @@
+/** @type Egg.EggPlugin */
+module.exports = {
+  // had enabled by egg
+  // static: {
+  //   enable: true,
+  // }
+};

package/dist/templates/egg3-simple-js/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "{{name}}",
+  "version": "1.0.0",
+  "description": "hello Egg.js",
+  "private": true,
+  "egg": {
+    "declarations": true
+  },
+  "dependencies": {
+    "egg": "^3.17.5",
+    "egg-scripts": "2"
+  },
+  "devDependencies": {
+    "egg-bin": "6",
+    "egg-mock": "5",
+    "eslint": "8",
+    "eslint-config-egg": "13"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "start": "egg-scripts start --daemon --title=egg-server-{{name}}",
+    "stop": "egg-scripts stop --title=egg-server-{{name}}",
+    "dev": "egg-bin dev",
+    "test": "npm run lint -- --fix && npm run test:local",
+    "test:local": "egg-bin test",
+    "cov": "egg-bin cov",
+    "lint": "eslint .",
+    "ci": "npm run lint && npm run cov"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "author": "{{author}}",
+  "license": "MIT"
+}

package/dist/templates/egg3-simple-js/test/app/controller/home.test.js

@@ -0,0 +1,20 @@
+const { strict: assert } = require('node:assert');
+const path = require('node:path');
+const { statSync } = require('node:fs');
+const { app } = require('egg-mock/bootstrap');
+
+describe('test/app/controller/home.test.js', () => {
+  it('should assert', async () => {
+    const pkg = require('../../../package.json');
+    assert(app.config.keys.startsWith(pkg.name));
+  });
+
+  it('should typings exists', async () => {
+    const typings = path.join(__dirname, '../../../typings');
+    assert(statSync(typings));
+  });
+
+  it('should GET /', async () => {
+    return app.httpRequest().get('/').expect('hi, egg').expect(200);
+  });
+});

package/dist/templates/egg3-simple-ts/.eslintignore

@@ -0,0 +1,3 @@
+**/*.d.ts
+node_modules/
+coverage

package/dist/templates/egg3-simple-ts/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "eslint-config-egg/typescript",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}

package/dist/templates/egg3-simple-ts/README.md

@@ -0,0 +1,33 @@
+# hackernews-async-ts
+
+[Hacker News](https://news.ycombinator.com/) showcase using typescript && egg
+
+## QuickStart
+
+### Development
+
+```bash
+$ npm i
+$ npm run dev
+$ open http://localhost:7001/
+```
+
+Don't tsc compile at development mode, if you had run `tsc` then you need to `npm run clean` before `npm run dev`.
+
+### Deploy
+
+```bash
+$ npm run tsc
+$ npm start
+```
+
+### Npm Scripts
+
+- Use `npm run lint` to check code style
+- Use `npm test` to run unit test
+- se `npm run clean` to clean compiled js at development mode once
+
+### Requirement
+
+- Node.js 8.x
+- Typescript 2.8+

package/dist/templates/egg3-simple-ts/_.gitignore

@@ -0,0 +1,20 @@
+logs/
+npm-debug.log
+node_modules/
+coverage/
+.idea/
+run/
+logs/
+.DS_Store
+.vscode
+*.swp
+*.lock
+*.js
+!.autod.conf.js
+
+app/**/*.js
+test/**/*.js
+config/**/*.js
+app/**/*.map
+test/**/*.map
+config/**/*.map

package/dist/templates/egg3-simple-ts/app/controller/home.ts

@@ -0,0 +1,8 @@
+import { Controller } from 'egg';
+
+export default class HomeController extends Controller {
+  public async index() {
+    const { ctx } = this;
+    ctx.body = await ctx.service.test.sayHi('egg');
+  }
+}

package/dist/templates/egg3-simple-ts/app/router.ts

@@ -0,0 +1,7 @@
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  const { controller, router } = app;
+
+  router.get('/', controller.home.index);
+};

package/dist/templates/egg3-simple-ts/app/service/Test.ts

@@ -0,0 +1,14 @@
+import { Service } from 'egg';
+
+/**
+ * Test Service
+ */
+export default class Test extends Service {
+  /**
+   * sayHi to you
+   * @param name - your name
+   */
+  public async sayHi(name: string) {
+    return `hi, ${name}, TypeScript`;
+  }
+}