create-egg 3.0.0 → 4.0.1-beta.0

package/dist/templates/simple-ts/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "{{name}}",
+  "description": "Hello Egg.js",
+  "type": "module",
+  "private": true,
+  "egg": {
+    "typescript": true
+  },
+  "scripts": {
+    "start": "eggctl start --daemon --title=egg-server-{{name}}",
+    "stop": "eggctl stop --title=egg-server-{{name}}",
+    "dev": "egg-bin dev",
+    "test:local": "vitest run",
+    "pretest": "npm run clean && npm run lint -- --fix",
+    "test": "vitest run",
+    "preci": "npm run clean && npm run lint",
+    "ci": "vitest run --coverage",
+    "postci": "npm run prepublishOnly && npm start && sleep 10 && npm stop && npm run clean",
+    "lint": "oxlint --type-aware",
+    "tsc": "tsc",
+    "clean": "tsc -b --clean",
+    "prepublishOnly": "npm run clean && npm run tsc"
+  },
+  "dependencies": {
+    "@eggjs/scripts": "^4.0.0",
+    "egg": "beta"
+  },
+  "devDependencies": {
+    "@eggjs/bin": "beta",
+    "@eggjs/mock": "beta",
+    "@eggjs/tsconfig": "beta",
+    "@types/node": "24",
+    "oxlint": "1",
+    "oxlint-tsgolint": "^0.2.0",
+    "typescript": "5",
+    "vitest": "beta"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "homepage": "https://github.com/YOUR_USERNAME/YOUR_REPO#readme",
+  "bugs": {
+    "url": "https://github.com/YOUR_USERNAME/YOUR_REPO/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/YOUR_USERNAME/YOUR_REPO.git"
+  },
+  "author": "Author Name <author.name@mail.com>",
+  "license": "MIT"
+}

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

@@ -0,0 +1,8 @@
+import { test, expect } from 'vitest';
+
+import { app } from '@eggjs/mock/bootstrap';
+
+test('should GET / status 200', async () => {
+  const res = await app.httpRequest().get('/').expect(200);
+  expect(res.text).toBe('hi, egg');
+});

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

@@ -0,0 +1,9 @@
+import { test, expect } from 'vitest';
+
+import { app } from '@eggjs/mock/bootstrap';
+
+test('sayHi should return hi, egg', async () => {
+  const ctx = app.mockContext();
+  const result = await ctx.service.test.sayHi('egg');
+  expect(result).toBe('hi, egg');
+});

package/dist/templates/simple-ts/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@eggjs/tsconfig",
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": false,
+    "baseUrl": "."
+  }
+}

package/dist/templates/simple-ts/typings/index.d.ts

@@ -0,0 +1,3 @@
+import 'egg';
+
+declare module 'egg' {}

package/dist/templates/tegg/.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/tegg/README.md

@@ -0,0 +1,33 @@
+# tegg app
+
+[Hacker News](https://news.ycombinator.com/) showcase using [tegg](https://github.com/eggjs/tegg)
+
+## 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 >= 18.x
+- Typescript >= 5.x

package/dist/templates/tegg/_.gitignore

@@ -0,0 +1,21 @@
+logs/
+npm-debug.log
+node_modules/
+coverage/
+.idea/
+run/
+logs/
+.DS_Store
+.vscode
+*.swp
+*.lock
+*.js
+.eslintcache
+
+app/**/*.js
+test/**/*.js
+config/**/*.js
+app/**/*.map
+test/**/*.map
+config/**/*.map
+.package-lock.json

package/dist/templates/tegg/app/module/bar/controller/home.ts

@@ -0,0 +1,24 @@
+import { EggLogger } from 'egg';
+import {
+  Inject,
+  HTTPController,
+  HTTPMethod,
+  HTTPMethodEnum,
+} from '@eggjs/tegg';
+
+@HTTPController({
+  path: '/',
+})
+export class HomeController {
+  @Inject()
+  private logger: EggLogger;
+
+  @HTTPMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/',
+  })
+  async index() {
+    this.logger.info('hello egg logger');
+    return 'hello egg';
+  }
+}

package/dist/templates/tegg/app/module/bar/controller/user.ts

@@ -0,0 +1,24 @@
+import {
+  Inject,
+  HTTPController,
+  HTTPMethod,
+  HTTPMethodEnum,
+  HTTPQuery,
+} from '@eggjs/tegg';
+import { HelloService } from '@/module/foo';
+
+@HTTPController({
+  path: '/bar',
+})
+export class UserController {
+  @Inject()
+  private helloService: HelloService;
+
+  @HTTPMethod({
+    method: HTTPMethodEnum.GET,
+    path: 'user',
+  })
+  async user(@HTTPQuery({ name: 'userId' }) userId: string) {
+    return await this.helloService.hello(userId);
+  }
+}

package/dist/templates/tegg/app/module/bar/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "bar",
+  "eggModule": {
+    "name": "bar"
+  }
+}

package/dist/templates/tegg/app/module/foo/index.ts

@@ -0,0 +1 @@
+export { HelloService } from './service/HelloService.ts';

package/dist/templates/tegg/app/module/foo/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "foo",
+  "eggModule": {
+    "name": "foo"
+  }
+}

package/dist/templates/tegg/app/module/foo/service/HelloService.ts

@@ -0,0 +1,19 @@
+import { EggLogger } from 'egg';
+import { SingletonProto, AccessLevel, Inject } from '@eggjs/tegg';
+
+@SingletonProto({
+  // 如果需要在上层使用，需要把 accessLevel 显示声明为 public
+  accessLevel: AccessLevel.PUBLIC,
+})
+export class HelloService {
+  // 注入一个 logger
+  @Inject()
+  private logger: EggLogger;
+
+  // 封装业务
+  async hello(userId: string): Promise<string> {
+    const result = { userId, handledBy: 'foo module' };
+    this.logger.info('[hello] get result: %j', result);
+    return `hello, ${result.userId}`;
+  }
+}

package/dist/templates/tegg/config/config.default.ts

@@ -0,0 +1,30 @@
+import { EggAppConfig, EggAppInfo, PowerPartial } from 'egg';
+
+export default (appInfo: EggAppInfo) => {
+  const config = {} as PowerPartial<EggAppConfig>;
+
+  // override config from framework / plugin
+  // use for cookie sign key, should change to your own and keep security
+  config.keys = appInfo.name + '_{{keys}}';
+
+  // add your egg config in here
+  config.middleware = [];
+
+  // change multipart mode to file
+  // @see https://github.com/eggjs/multipart/blob/master/src/config/config.default.ts#L104
+  config.multipart = {
+    mode: 'file',
+  };
+
+  // add your special config in here
+  // Usage: `app.config.bizConfig.sourceUrl`
+  const bizConfig = {
+    sourceUrl: `https://github.com/eggjs/examples/tree/master/${appInfo.name}`,
+  };
+
+  // the return config will combines to EggAppConfig
+  return {
+    ...config,
+    bizConfig,
+  };
+};

package/dist/templates/tegg/config/config.local.ts

@@ -0,0 +1,6 @@
+import { EggAppConfig, PowerPartial } from 'egg';
+
+export default () => {
+  const config = {} as PowerPartial<EggAppConfig>;
+  return config;
+};

package/dist/templates/tegg/config/config.prod.ts

@@ -0,0 +1,6 @@
+import { EggAppConfig, PowerPartial } from 'egg';
+
+export default () => {
+  const config = {} as PowerPartial<EggAppConfig>;
+  return config;
+};

package/dist/templates/tegg/config/config.unittest.ts

@@ -0,0 +1,6 @@
+import { EggAppConfig, PowerPartial } from 'egg';
+
+export default () => {
+  const config = {} as PowerPartial<EggAppConfig>;
+  return config;
+};

package/dist/templates/tegg/config/plugin.ts

@@ -0,0 +1,34 @@
+import { EggPlugin } from 'egg';
+
+const plugin: EggPlugin = {
+  tegg: {
+    enable: true,
+    package: '@eggjs/tegg-plugin',
+  },
+  teggConfig: {
+    enable: true,
+    package: '@eggjs/tegg-config',
+  },
+  teggController: {
+    enable: true,
+    package: '@eggjs/tegg-controller-plugin',
+  },
+  teggSchedule: {
+    enable: true,
+    package: '@eggjs/tegg-schedule-plugin',
+  },
+  eventbusModule: {
+    enable: true,
+    package: '@eggjs/tegg-eventbus-plugin',
+  },
+  aopModule: {
+    enable: true,
+    package: '@eggjs/tegg-aop-plugin',
+  },
+  tracer: {
+    enable: true,
+    package: '@eggjs/tracer',
+  },
+};
+
+export default plugin;

package/dist/templates/tegg/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "{{name}}",
+  "description": "Hello Egg.js",
+  "private": true,
+  "egg": {
+    "typescript": true
+  },
+  "scripts": {
+    "start": "eggctl start --daemon --title=egg-server-{{name}}",
+    "stop": "eggctl stop --title=egg-server-{{name}}",
+    "dev": "egg-bin dev",
+    "test:local": "vitest run",
+    "pretest": "npm run clean && npm run lint -- --fix",
+    "test": "vitest run",
+    "preci": "npm run clean && npm run lint",
+    "ci": "vitest run --coverage",
+    "postci": "npm run prepublishOnly && npm start && sleep 10 && npm stop && npm run clean",
+    "lint": "oxlint --type-aware",
+    "tsc": "tsc",
+    "clean": "tsc -b --clean",
+    "prepublishOnly": "npm run clean && npm run tsc"
+  },
+  "dependencies": {
+    "@eggjs/scripts": "^4.0.0",
+    "@eggjs/tegg": "^3.5.2",
+    "@eggjs/tegg-aop-plugin": "^3.5.2",
+    "@eggjs/tegg-config": "^3.5.2",
+    "@eggjs/tegg-controller-plugin": "^3.5.2",
+    "@eggjs/tegg-eventbus-plugin": "^3.5.2",
+    "@eggjs/tegg-plugin": "^3.5.2",
+    "@eggjs/tegg-schedule-plugin": "^3.5.2",
+    "@eggjs/tracer": "^3.0.0",
+    "egg": "beta"
+  },
+  "devDependencies": {
+    "@eggjs/bin": "beta",
+    "@eggjs/mock": "beta",
+    "@eggjs/tsconfig": "beta",
+    "@types/node": "24",
+    "oxlint": "1",
+    "oxlint-tsgolint": "^0.2.0",
+    "typescript": "5",
+    "vitest": "beta"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "homepage": "https://github.com/YOUR_USERNAME/YOUR_REPO#readme",
+  "bugs": {
+    "url": "https://github.com/YOUR_USERNAME/YOUR_REPO/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/YOUR_USERNAME/YOUR_REPO.git"
+  },
+  "author": "Author Name <author.name@mail.com>",
+  "license": "MIT"
+}

package/dist/templates/tegg/test/app/module/bar/controller/home.test.ts

@@ -0,0 +1,8 @@
+import { test, expect } from 'vitest';
+import { app } from '@eggjs/mock/bootstrap';
+
+test('should GET / status 200', async () => {
+  const res = await app.httpRequest().get('/');
+  expect(res.status).toBe(200);
+  expect(res.text).toBe('hello egg');
+});

package/dist/templates/tegg/test/app/module/bar/controller/user.test.ts

@@ -0,0 +1,11 @@
+import { test, expect } from 'vitest';
+import { app } from '@eggjs/mock/bootstrap';
+
+test('should GET /bar/user status 200', async () => {
+  const res = await app
+    .httpRequest()
+    .get('/bar/user')
+    .query({ userId: '20170901' });
+  expect(res.status).toBe(200);
+  expect(res.text).toBe('hello, 20170901');
+});

package/dist/templates/tegg/test/app/module/foo/service/HelloService.test.ts

@@ -0,0 +1,9 @@
+import { test, expect } from 'vitest';
+import { app } from '@eggjs/mock/bootstrap';
+import { HelloService } from '@/module/foo/service/HelloService';
+
+test('should hello() work', async () => {
+  const helloService = await app.getEggObject(HelloService);
+  const msg = await helloService.hello('123456');
+  expect(msg).toBe('hello, 123456');
+});

package/dist/templates/tegg/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@eggjs/tsconfig",
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": false,
+    "paths": {
+      "@/module/*": ["app/module/*"]
+    },
+    "baseUrl": "."
+  }
+}

package/package.json

@@ -1,44 +1,53 @@
 {
   "name": "create-egg",
-  "version": "3.0.0",
-  "description": "Alias for egg-init, so you could use `npm init egg showcase`.",
-  "dependencies": {
-    "egg-init": "3"
+  "version": "4.0.1-beta.0",
+  "publishConfig": {
+    "access": "public"
   },
+  "description": "Scaffolding Your First Egg.js Project",
+  "type": "module",
   "devDependencies": {
-    "coffee": "^5.1.0",
-    "egg-bin": "6",
-    "eslint": "8",
-    "eslint-config-egg": "13",
-    "git-contributor": "^2.1.5"
+    "@types/cross-spawn": "^6.0.6",
+    "@types/node": "24.5.2",
+    "execa": "^9.6.0",
+    "tsdown": "0.15.3"
   },
-  "bin": "./bin/create-egg.js",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=20.19.0"
   },
-  "scripts": {
-    "lint": "eslint .",
-    "test": "npm run lint -- --fix && npm run test-local",
-    "test-local": "egg-bin test",
-    "cov": "egg-bin cov",
-    "ci": "npm run lint && npm run cov",
-    "contributor": "git-contributor"
-  },
-  "eslintIgnore": [
-    "coverage",
-    "dist"
-  ],
   "repository": {
     "type": "git",
-    "url": "git@github.com:eggjs/create-egg.git"
+    "url": "git@github.com:eggjs/egg.git",
+    "directory": "tools/create-egg"
   },
-  "bug": {
+  "bugs": {
     "url": "https://github.com/eggjs/egg/issues"
   },
-  "homepage": "https://github.com/eggjs/create-egg",
+  "homepage": "https://github.com/eggjs/egg/tree/next/tools/create-egg",
   "files": [
-    "bin"
+    "dist"
   ],
   "author": "TZ <atian25@qq.com>",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./cli": "./dist/cli.js",
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "create-egg": "./dist/cli.js"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.11.0",
+    "cross-spawn": "^7.0.6",
+    "mri": "^1.2.0",
+    "picocolors": "^1.1.1"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "build": "tsdown"
+  }
+}

package/bin/create-egg.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-require('egg-init/bin/egg-init');