create-egg 3.0.0 → 4.0.1-beta.0

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

@@ -0,0 +1,23 @@
+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 = [];
+
+  // add your special config in here
+  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/egg3-simple-ts/config/config.local.ts

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

package/dist/templates/egg3-simple-ts/config/config.prod.ts

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

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

@@ -0,0 +1,11 @@
+import { EggPlugin } from 'egg';
+
+const plugin: EggPlugin = {
+  // static: true,
+  // nunjucks: {
+  //   enable: true,
+  //   package: 'egg-view-nunjucks',
+  // },
+};
+
+export default plugin;

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

@@ -0,0 +1,45 @@
+{
+  "name": "{{name}}",
+  "version": "1.0.0",
+  "description": "hello Egg.js",
+  "private": true,
+  "egg": {
+    "typescript": true,
+    "declarations": true
+  },
+  "scripts": {
+    "start": "egg-scripts start --daemon --title=egg-server-{{name}}",
+    "stop": "egg-scripts stop --title=egg-server-{{name}}",
+    "dev": "egg-bin dev",
+    "test-local": "egg-bin test",
+    "test": "npm run lint -- --fix && npm run test-local",
+    "cov": "egg-bin cov",
+    "tsc": "ets && tsc -p tsconfig.json",
+    "ci": "npm run lint && npm run cov && npm run tsc",
+    "lint": "eslint . --ext .ts --resolve-plugins-relative-to .",
+    "clean": "ets clean"
+  },
+  "dependencies": {
+    "egg": "^3.31.0",
+    "egg-scripts": "3"
+  },
+  "devDependencies": {
+    "@types/mocha": "10",
+    "@types/node": "24",
+    "@eggjs/tsconfig": "1",
+    "egg-bin": "6",
+    "egg-mock": "5",
+    "eslint": "8",
+    "eslint-config-egg": "13",
+    "typescript": "5"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "author": "Author Name <author.name@mail.com>",
+  "license": "MIT"
+}

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

@@ -0,0 +1,9 @@
+import assert from 'assert';
+import { app } from 'egg-mock/bootstrap';
+
+describe('test/app/controller/home.test.ts', () => {
+  it('should GET /', async () => {
+    const result = await app.httpRequest().get('/').expect(200);
+    assert(result.text === 'hi, egg');
+  });
+});

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

@@ -0,0 +1,16 @@
+import assert from 'assert';
+import { Context } from 'egg';
+import { app } from 'egg-mock/bootstrap';
+
+describe('test/app/service/Test.test.js', () => {
+  let ctx: Context;
+
+  before(async () => {
+    ctx = app.mockContext();
+  });
+
+  it('sayHi', async () => {
+    const result = await ctx.service.test.sayHi('egg');
+    assert(result === 'hi, egg');
+  });
+});

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

@@ -0,0 +1,4 @@
+{
+  "extends": "@eggjs/tsconfig",
+  "exclude": ["app/public", "app/views", "node_modules*"]
+}

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

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

package/dist/templates/egg3-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/egg3-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 >= 20.x
+- Typescript >= 5.x

package/dist/templates/egg3-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/egg3-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/egg3-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/egg3-tegg/app/module/bar/package.json

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

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

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

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

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

package/dist/templates/egg3-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/egg3-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/egg3-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/egg3-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/egg3-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/egg3-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: 'egg-tracer',
+  },
+};
+
+export default plugin;

package/dist/templates/egg3-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",
+    "pretest": "npm run clean && npm run lint -- --fix",
+    "test": "egg-bin test",
+    "preci": "npm run clean && npm run lint",
+    "ci": "egg-bin cov",
+    "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": {
+    "egg-scripts": "^3.1.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",
+    "egg-scripts": "^2.17.0",
+    "egg-tracer": "^2.0.0",
+    "egg": "^3.31.0"
+  },
+  "devDependencies": {
+    "egg-bin": "^6.13.0",
+    "egg-mock": "^5.15.2",
+    "@eggjs/tsconfig": "1",
+    "@types/mocha": "10",
+    "@types/node": "24",
+    "oxlint": "1",
+    "oxlint-tsgolint": "^0.2.0",
+    "typescript": "5"
+  },
+  "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/egg3-tegg/test/app/module/bar/controller/home.test.ts

@@ -0,0 +1,11 @@
+import { strict as assert } from 'node:assert';
+
+import { app } from 'egg-mock/bootstrap';
+
+describe('test/app/module/bar/controller/home.test.ts', () => {
+  it('should GET / status 200', async () => {
+    const res = await app.httpRequest().get('/');
+    assert.equal(res.status, 200);
+    assert.equal(res.text, 'hello egg');
+  });
+});

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

@@ -0,0 +1,14 @@
+import { strict as assert } from 'node:assert';
+
+import { app } from 'egg-mock/bootstrap';
+
+describe('test/app/module/bar/controller/user.test.ts', () => {
+  it('should GET /bar/user status 200', async () => {
+    const res = await app
+      .httpRequest()
+      .get('/bar/user')
+      .query({ userId: '20170901' });
+    assert.equal(res.status, 200);
+    assert.equal(res.text, 'hello, 20170901');
+  });
+});

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

@@ -0,0 +1,14 @@
+import { strict as assert } from 'node:assert';
+
+import { app } from 'egg-mock/bootstrap';
+
+import { HelloService } from '@/module/foo/service/HelloService';
+
+describe('test/app/module/foo/service/HelloService.test.ts', () => {
+  it('should hello() work', async () => {
+    // @ts-expect-error getEggObject no type defination
+    const helloService = await app.getEggObject(HelloService);
+    const msg = await helloService.hello('123456');
+    assert.equal(msg, 'hello, 123456');
+  });
+});

package/dist/templates/egg3-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/dist/templates/simple-ts/README.md

@@ -0,0 +1,33 @@
+# Hello Egg.js
+
+[Hello Egg.js](https://eggjs.org/) 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 20.x
+- Typescript 5.x

package/dist/templates/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/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/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/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`;
+  }
+}

package/dist/templates/simple-ts/config/config.default.ts

@@ -0,0 +1,23 @@
+import type { 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 = [];
+
+  // add your special config in here
+  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/simple-ts/config/config.local.ts

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

package/dist/templates/simple-ts/config/config.prod.ts

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

package/dist/templates/simple-ts/config/plugin.ts

@@ -0,0 +1,11 @@
+import type { EggPlugin } from 'egg';
+
+const plugins: EggPlugin = {
+  // static: true,
+  // nunjucks: {
+  //   enable: true,
+  //   package: 'egg-view-nunjucks',
+  // },
+};
+
+export default plugins;