• pnpm-lock.yaml: Language not supported

tools/create-egg/CHANGELOG.md (8)

27-27: Remove accidental generator noise.

"fatal: No names found, cannot describe anything." looks like a changelog tool artifact; drop it.

-**features**
-  * [[`08e69e2`](http://github.com/eggjs/create-egg/commit/08e69e22dbe309af648d01c46882415ac4ee785a)] - feat: update egg-init@2 (#5) (TZ | 天猪 <<[email protected]>>),fatal: No names found, cannot describe anything.
+**features**
+  * [[`08e69e2`](https://github.com/eggjs/create-egg/commit/08e69e22dbe309af648d01c46882415ac4ee785a)] - feat: update egg-init@2 (#5) (TZ | 天猪 <<[email protected]>>)

---

35-35: Fix typo: “fist” → “first”.

-  * feat: fist version (#1)
+  * feat: first version (#1)

---

21-21: Use HTTPS for GitHub links.

Avoid plain HTTP in commit links.

-  * [[`7fd4d4b`](http://github.com/eggjs/create-egg/commit/7fd4d4bb0a5eccf47f2a5cc624cb4acff7431025)] - fix: npm publish files (#6) (TZ | 天猪 <<[email protected]>>)
+  * [[`7fd4d4b`](https://github.com/eggjs/create-egg/commit/7fd4d4bb0a5eccf47f2a5cc624cb4acff7431025)] - fix: npm publish files (#6) (TZ | 天猪 <<[email protected]>>)

---

17-25: Normalize section headings for consistency.

Mixing Setext and ATX styles hurts readability. Convert old entries to ATX like 3.0.0.

-2.0.1 / 2020-08-04
-==================
+## 2.0.1 - 2020-08-04
@@
-2.0.0 / 2020-08-04
-==================
+## 2.0.0 - 2020-08-04

---

32-33: Normalize 1.0.0 heading style.

-1.0.0 / 2018-09-28
-==================
+## 1.0.0 - 2018-09-28

---

20-30: Promote bolded category labels to headings.

Align with 3.0.0’s “### Features” style.

-**fixes**
+### Fixes
@@
-**features**
+### Features
@@
-**others**
+### Others

---

3-5: Clarify pre-/post-migration history.

Add a one-liner noting entries below are from the old repo; new releases live on eggjs/egg.

 > [!IMPORTANT]
 > Moving forwards we are using the GitHub releases page at <https://github.com/eggjs/egg/releases> in combination with [release.yml](https://github.com/eggjs/egg/actions/workflows/release.yml) for publishing releases and their changelogs.
+
+Historical entries below were migrated from the former repository (eggjs/create-egg).

---

1-37: EOF newline and general polish.

Ensure the file ends with a newline (some linters flag this). No behavior impact.

tools/create-egg/src/templates/egg3-simple-js/.vscode/launch.json (2)

7-16: Improve debug ergonomics: skip Node internals and node_modules

Add skipFiles (and optionally cwd) so stepping isn’t noisy.

     {
       "type": "node",
       "request": "launch",
       "name": "Egg Debug",
       "runtimeExecutable": "npm",
       "runtimeArgs": ["run", "dev", "--", "--inspect-brk"],
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "cwd": "${workspaceFolder}",
       "console": "integratedTerminal",
       "restart": true,
       "autoAttachChildProcesses": true
     },

---

17-24: Align test launch config with debug

Surface test output in the terminal too. Consider non-breaking attach by default.

     {
       "type": "node",
       "request": "launch",
       "name": "Egg Test",
       "runtimeExecutable": "npm",
-      "runtimeArgs": ["run", "test:local", "--", "--inspect-brk"],
+      "runtimeArgs": ["run", "test:local", "--", "--inspect"], // use --inspect-brk if you prefer break-at-first-line
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
       "autoAttachChildProcesses": true
     }

tools/create-egg/src/templates/tegg/.vscode/launch.json (2)

7-16: Mirror debug QoL: skipFiles/cwd

Same QoL as other templates to reduce stepping noise.

     {
       "type": "node",
       "request": "launch",
       "name": "Egg Debug",
       "runtimeExecutable": "npm",
       "runtimeArgs": ["run", "dev", "--", "--inspect-brk"],
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "cwd": "${workspaceFolder}",
       "console": "integratedTerminal",
       "restart": true,
       "autoAttachChildProcesses": true
     },

---

17-24: Terminal output for tests + optional non-breaking inspect

Keep parity with debug config and avoid breaking on first line unless desired.

     {
       "type": "node",
       "request": "launch",
       "name": "Egg Test",
       "runtimeExecutable": "npm",
-      "runtimeArgs": ["run", "test:local", "--", "--inspect-brk"],
+      "runtimeArgs": ["run", "test:local", "--", "--inspect"],
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
       "autoAttachChildProcesses": true
     }

tools/create-egg/src/templates/egg3-tegg/.vscode/launch.json (2)

7-16: Apply the same debug QoL defaults

Match other templates: skipFiles/cwd.

     {
       "type": "node",
       "request": "launch",
       "name": "Egg Debug",
       "runtimeExecutable": "npm",
       "runtimeArgs": ["run", "dev", "--", "--inspect-brk"],
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "cwd": "${workspaceFolder}",
       "console": "integratedTerminal",
       "restart": true,
       "autoAttachChildProcesses": true
     },

---

17-24: Paritize test launcher settings

Surface test logs in terminal and avoid break-on-first-line by default.

     {
       "type": "node",
       "request": "launch",
       "name": "Egg Test",
       "runtimeExecutable": "npm",
-      "runtimeArgs": ["run", "test:local", "--", "--inspect-brk"],
+      "runtimeArgs": ["run", "test:local", "--", "--inspect"],
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
       "autoAttachChildProcesses": true
     }

tools/create-egg/src/templates/egg3-simple-js/.eslintignore (1)

1-1: Ignore common Egg runtime artifacts

ESLint doesn’t need to traverse run/ and logs/. Keep coverage/ as added.

 coverage
+run
+logs
+coverage/lcov-report

tools/create-egg/src/templates/egg3-simple-js/.eslintrc (1)

1-4: Add test overrides for Mocha globals

Prevents lint errors on describe/it in test files.

 {
   "extends": "eslint-config-egg",
-  "root": true
+  "root": true,
+  "overrides": [
+    {
+      "files": ["test/**/*.test.js", "test/**/*.spec.js"],
+      "env": { "mocha": true }
+    }
+  ]
 }

tools/create-egg/src/templates/egg3-simple-js/README.md (3)

5-9: State the Node.js requirement (>= 20.19.0) upfront

Aligns docs with PR’s stated engine baseline.

 ## QuickStart
+
+Requirements
+
+- Node.js >= 20.19.0

---

13-17: Optionally include pnpm usage and clarify test debug script

If the generator emits a test:local script (used by launch.json), mention it here.

 ```bash
-npm i
-npm run dev
+npm i # or: pnpm i / yarn
+npm run dev # or: pnpm dev / yarn dev
 open http://localhost:7001/

---

`26-30`: **Document the debug-friendly test script if present**

Keep npm test, but add test:local for debug parity with launch.json.



```diff
 ### npm scripts
 
 - Use `npm run lint` to check code style.
-- Use `npm test` to run unit test.
+- Use `npm test` to run unit tests.
+- Use `npm run test:local` to debug unit tests with the Node inspector (if available).

tools/create-egg/src/templates/egg3-simple-js/_.gitignore (1)

5-7: Consider committing lockfiles for deterministic installs

Ignoring npm/yarn/pnpm lockfiles hurts reproducibility for scaffolded apps. Templates generally benefit from checked‑in lockfiles.

Apply this diff to stop ignoring lockfiles:

-*-lock.json
-*-lock.yaml
-yarn.lock

tools/create-egg/src/templates/egg3-simple-js/package.json (1)

32-37: Repository URL is empty

Empty repository.url can confuse npm init flows; either drop the block or use a placeholder.

Apply one of:

• Remove the repository block entirely, or
• Set to "url": "https://example.com/your-repo" as a placeholder string.

tools/create-egg/src/templates/egg3-simple-js/config/config.default.js (1)

13-15: Minor: make keys composition explicit

Template string is simpler to read and avoids accidental numeric coercion.

-  config.keys = appInfo.name + '_{{keys}}';
+  config.keys = `${appInfo.name}_{{keys}}`;

tools/create-egg/src/templates/egg3-simple-js/test/app/controller/home.test.js (1)

17-19: Don’t mix async and returned Promise

Either return the Promise or use async/await. Prefer await for clarity.

-  it('should GET /', async () => {
-    return app.httpRequest().get('/').expect('hi, egg').expect(200);
-  });
+  it('should GET /', async () => {
+    await app.httpRequest().get('/').expect('hi, egg').expect(200);
+  });

tools/create-egg/src/templates/egg3-tegg/app/module/bar/package.json (1)

1-6: Mark template packages private to prevent accidental publish.

Add "private": true.

 {
   "name": "bar",
+  "private": true,
   "eggModule": {
     "name": "bar"
   }
 }

tools/create-egg/src/templates/tegg/tsconfig.json (1)

2-3: Template tsconfig “extends” differs from monorepo guideline.

Guidelines say sub-project tsconfigs should extend "../../tsconfig.json", while this template extends "@eggjs/tsconfig". If templates are exempt, add a brief comment or rename to a templated filename (e.g., tsconfig.json.hbs) to avoid automated checks; otherwise switch to the monorepo extend.

packages/tsconfig/package.json (1)

28-30: Engines set to Node >=22.17.1 — intentional?

This exceeds the repo baseline (>=20.19.0). If not required, align; if required, note rationale in README or package description.

   "engines": {
-    "node": ">=22.17.1"
+    "node": ">= 20.19.0"
   },

tools/create-egg/src/templates/tegg/config/config.local.ts (1)

1-6: Use type-only import to avoid runtime dependency

Avoid emitting an unnecessary ESM import at runtime.

Apply:

-import { EggAppConfig, PowerPartial } from 'egg';
+import type { EggAppConfig, PowerPartial } from 'egg';

tools/create-egg/src/templates/egg3-tegg/config/config.local.ts (1)

1-6: Prefer import type for pure type usage

Prevents emitting a runtime import.

-import { EggAppConfig, PowerPartial } from 'egg';
+import type { EggAppConfig, PowerPartial } from 'egg';

tools/create-egg/src/templates/tegg/config/config.prod.ts (1)

1-6: Type-only import

Same rationale as other config templates.

-import { EggAppConfig, PowerPartial } from 'egg';
+import type { EggAppConfig, PowerPartial } from 'egg';

tools/create-egg/src/templates/tegg/config/plugin.ts (1)

1-1: Tighten typing and avoid runtime import

Use type-only import and satisfies for stronger checks without widening.

Please confirm the plugin keys (eventbusModule, aopModule, etc.) match the expected names in TEgg docs.

-import { EggPlugin } from 'egg';
+import type { EggPlugin } from 'egg';

-const plugin: EggPlugin = {
+const plugin = {
   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',
   },
-};
+} as const satisfies EggPlugin;

Also applies to: 3-32

tools/create-egg/src/templates/tegg/config/config.default.ts (1)

14-18: Avoid brittle GitHub line anchor; link drifts over time

The comment points to a specific line in a GitHub file, which will age poorly. Either drop it or link to Vitest/multipart docs instead.

Apply:

-  // @see https://github.com/eggjs/multipart/blob/master/src/config/config.default.ts#L104
+  // See egg-multipart config for options.

vitest.config.ts (1)

5-9: Point projects at concrete config files to avoid accidental double runs

File: vitest.config.ts — fd shows per-package/plugin/tool vitest.config.ts files plus a root vitest.config.ts; switch the projects entries to explicit config files.

Apply:

   test: {
     projects: [
-      'packages/*',
-      'plugins/*',
-      'tools/*',
+      'packages/*/vitest.config.ts',
+      'plugins/*/vitest.config.ts',
+      'tools/*/vitest.config.ts',

tools/create-egg/src/templates/tegg/package.json (3)

49-56: Update placeholder URLs in template metadata.

The template includes placeholder GitHub URLs that should be replaced during project generation to match the actual repository structure.

Ensure these placeholders are properly replaced in the CLI generation process:

-  "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"
-  },
+  "homepage": "https://github.com/{{username}}/{{name}}#readme",
+  "bugs": {
+    "url": "https://github.com/{{username}}/{{name}}/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/{{username}}/{{name}}.git"
+  },

---

25-31: Update TEgg package versions to latest available.

The template specifies TEgg packages at version ^3.5.2, but the current latest version of @eggjs/tegg is 3.57.14. The template should use more recent versions for better functionality and security.

Consider updating to the latest stable versions:

-    "@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/tegg": "^3.57.14",
+    "@eggjs/tegg-aop-plugin": "^3.52.0",
+    "@eggjs/tegg-config": "^3.57.14",
+    "@eggjs/tegg-controller-plugin": "^3.41.0",
+    "@eggjs/tegg-eventbus-plugin": "^3.57.14",
+    "@eggjs/tegg-plugin": "^3.57.14",
+    "@eggjs/tegg-schedule-plugin": "^3.57.5",

Please verify compatibility and run tests after updating to ensure all functionality works correctly with the newer versions.

---

23-34: Prefer catalog: references for TEgg deps in the template

pnpm-workspace.yaml defines catalog entries for @eggjs/tegg and related packages (catalogMode: prefer, @eggjs/tegg: ^3.2.2) and the repo widely uses "catalog:" — replace the explicit versions in tools/create-egg/src/templates/tegg/package.json (currently ^3.5.2 and egg: "beta") with "catalog:" references, or document why the pinned/newer versions are intentional.

tools/create-egg/src/templates/egg3-tegg/test/app/module/bar/controller/home.test.ts (1)

1-11: Update test to use Vitest imports instead of global describe/it.

Based on the coding guidelines, template tests should import test functions from Vitest rather than relying on globals.

Apply this diff to align with Vitest best practices:

+import { describe, it } from 'vitest';
 import { strict as assert } from 'node:assert';

 import { app } from 'egg-mock/bootstrap';

tools/create-egg/src/templates/tegg/test/app/module/foo/service/HelloService.test.ts (1)

1-9: Mixed testing patterns - consider consistency across templates.

This test uses Vitest's test and expect, while other template tests use describe/it with Node.js assert. For better consistency across templates, consider standardizing on one approach.

Apply this diff to align with the pattern used in other template tests:

-import { test, expect } from 'vitest';
+import { describe, it } from 'vitest';
+import { strict as assert } from 'node:assert';
 import { app } from '@eggjs/mock/bootstrap';
 import { HelloService } from '@/module/foo/service/HelloService';

-test('should hello() work', async () => {
+describe('test/app/module/foo/service/HelloService.test.ts', () => {
+  it('should hello() work', async () => {
-  const helloService = await app.getEggObject(HelloService);
-  const msg = await helloService.hello('123456');
-  expect(msg).toBe('hello, 123456');
-});
+    const helloService = await app.getEggObject(HelloService);
+    const msg = await helloService.hello('123456');
+    assert.equal(msg, 'hello, 123456');
+  });
+});

tools/create-egg/src/templates/egg3-tegg/_.gitignore (1)

1-21: Tighten ignores: remove duplication, avoid over-broad '*.js', add common build dirs.

• Duplicate logs/ (Line 7).
• '*.js' (Line 12) will hide non-build JS (e.g., scripts). You already ignore compiled JS per dirs.
• Consider ignoring dist/ and out/, and pnpm-lock.yaml for pnpm-based setups.

Apply:

 logs/
 npm-debug.log
 node_modules/
 coverage/
 .idea/
 run/
-logs/
 .DS_Store
 .vscode
 *.swp
 *.lock
-*.js
 .eslintcache
+dist/
+out/
 
 app/**/*.js
 test/**/*.js
 config/**/*.js
 app/**/*.map
 test/**/*.map
 config/**/*.map
 .package-lock.json
+pnpm-lock.yaml

tools/create-egg/src/templates/tegg/test/app/module/bar/controller/user.test.ts (1)

1-11: Test reads well and asserts the expected contract.

Vitest style with expect is fine here. Keep as-is.

For consistency across templates, consider standardizing on either Node assert or Vitest expect in all TEgg tests.

tools/create-egg/src/templates/egg3-tegg/test/app/module/bar/controller/user.test.ts (1)

1-14: Looks good; matches egg-mock bootstrap style.

Mocha-style globals via egg-mock/bootstrap are fine. Using Node assert aligns with guidance.

If these tests will be run under Vitest in some setups, explicitly import { describe, it } from 'vitest' to avoid relying on globals.

tools/create-egg/src/templates/egg3-tegg/app/module/bar/controller/user.ts (4)

14-15: Fix strictPropertyInitialization for DI field.

With strict mode, property injection needs a definite assignment assertion.

Apply:

-  @Inject()
-  private helloService: HelloService;
+  @Inject()
+  private helloService!: HelloService;

---

18-20: Normalize method path to '/user' (verify TEgg join semantics).

Using a leading slash avoids subtle join issues when concatenating with the controller path.

Proposed change:

   @HTTPMethod({
     method: HTTPMethodEnum.GET,
-    path: 'user',
+    path: '/user',
   })

Please confirm TEgg’s path-join behavior for 'user' vs '/user' to ensure the route is '/bar/user'.

---

21-23: Drop redundant await in return.

Avoids an extra microtask and reads cleaner.

-    return await this.helloService.hello(userId);
+    return this.helloService.hello(userId);

---

21-21: Consider validating required query param.

If userId is required, enforce it (e.g., via decorator option or explicit guard) to prevent “hello, undefined”.

If TEgg supports it, prefer:

@HTTPQuery({ name: 'userId', required: true })

Otherwise add an early guard and respond 400.

tools/create-egg/src/templates/tegg/test/app/module/bar/controller/home.test.ts (1)

1-8: Align with repo test style: vitest + Node assert.

Use describe/it and node:assert to match project guidelines.

-import { test, expect } from 'vitest';
+import { describe, it } from 'vitest';
+import assert from 'node:assert/strict';
 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');
-});
+describe('GET /', () => {
+  it('should return 200', async () => {
+    const res = await app.httpRequest().get('/');
+    assert.equal(res.status, 200);
+    assert.equal(res.text, 'hello egg');
+  });
+});

tools/create-egg/src/templates/egg3-tegg/test/app/module/foo/service/HelloService.test.ts (1)

1-14: Import vitest globals explicitly and fix typo in ts-expect-error comment.

Keeps tests consistent and tidies copy.

+import { describe, it } from 'vitest';
 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
+    // @ts-expect-error getEggObject has no type definition
     const helloService = await app.getEggObject(HelloService);
     const msg = await helloService.hello('123456');
     assert.equal(msg, 'hello, 123456');
   });
 });

tools/create-egg/src/templates/tegg/app/module/bar/controller/home.ts (1)

13-21: Satisfy strict property init and add explicit return type.

Prevents TS strictPropertyInitialization error and clarifies API.

   @Inject()
-  private logger: EggLogger;
+  private logger!: EggLogger;

   @HTTPMethod({
     method: HTTPMethodEnum.GET,
     path: '/',
   })
-  async index() {
+  async index(): Promise<string> {

tools/create-egg/src/templates/egg3-tegg/app/module/foo/service/HelloService.ts (1)

9-17: Add definite assignment on injected logger.

Avoids strictPropertyInitialization error under strict mode.

   // 注入一个 logger
   @Inject()
-  private logger: EggLogger;
+  private logger!: EggLogger;

tools/create-egg/src/templates/egg3-tegg/app/module/bar/controller/home.ts (1)

13-21: Same strict init and return-type polish as other controllers.

Keeps controllers consistent.

   @Inject()
-  private logger: EggLogger;
+  private logger!: EggLogger;

   @HTTPMethod({
     method: HTTPMethodEnum.GET,
     path: '/',
   })
-  async index() {
+  async index(): Promise<string> {

tools/create-egg/tsdown.config.ts (1)

3-16: Build config looks correct; add small DX tweaks and ensure dotfiles are copied

• Optional: add clean: true and sourceMap: true for nicer local builds.
• Confirmed: tsdown's copy does NOT include dotfiles by default — add explicit dotfile patterns or list specific dotfiles in the copy array (e.g. add 'src/templates/**/' and 'src/templates/.', or include '.eslintrc', '.gitignore' explicitly).

 export default defineConfig({
   entry: ['src/index.ts', 'src/cli.ts'],
   unbundle: true,
   dts: true,
   exports: {
     devExports: true,
   },
+  clean: true,
+  sourceMap: true,
   copy: [
     {
       from: 'src/templates',
       to: 'dist/templates',
     },
   ],
 });

tools/create-egg/test/cli.test.ts (1)

127-131: --overwrite is parsed as boolean; "ignore" arg is ignored.

mri treats --overwrite as boolean here, so passing "ignore" has no effect (it behaves like "yes"). Either:

• change the test to pass only --overwrite, or
• change CLI to parse overwrite as an enum (yes|no|ignore).

tools/create-egg/src/templates/tegg/app/module/bar/controller/user.ts (1)

1-9: Type-only import, definite assignment, and drop redundant await.

Improves type safety under strict mode and avoids superfluous await.

-import { HelloService } from '@/module/foo';
+import type { HelloService } from '@/module/foo';
@@
-  private helloService: HelloService;
+  private helloService!: HelloService;
@@
-  async user(@HTTPQuery({ name: 'userId' }) userId: string) {
-    return await this.helloService.hello(userId);
+  async user(@HTTPQuery({ name: 'userId' }) userId: string) {
+    return this.helloService.hello(userId);
   }

Ensure the template’s tsconfig.json configures the "@/..." path alias to the correct directory (e.g., "paths": { "@/": ["app/"] }) so this import resolves after scaffolding.

Also applies to: 14-16, 21-23

tools/create-egg/src/index.ts (2)

103-137: Non-interactive override could support enum via CLI.

Current boolean --overwrite maps to “yes”. If you want parity with prompts (yes|no|ignore), parse overwrite as a string enum.

-  overwrite?: boolean;
+  overwrite?: string;
@@
-  boolean: ['help', 'overwrite'],
-  string: ['template'],
+  boolean: ['help'],
+  string: ['template', 'overwrite'],
@@
-  const argOverwrite = argv.overwrite;
+  const argOverwrite = argv.overwrite as 'yes' | 'no' | 'ignore' | undefined;
@@
-    const overwrite = argOverwrite
-      ? 'yes'
+    const overwrite = argOverwrite
+      ? argOverwrite
       : await prompts.select({

Update tests accordingly.

---

206-221: Template dir read: guard for missing template.

If an invalid template slips through, fs.readdirSync throws. Consider a clearer error.

-  const files = fs.readdirSync(templateDir);
+  if (!fs.existsSync(templateDir)) {
+    throw new Error(`Unknown template: ${template}`);
+  }
+  const files = fs.readdirSync(templateDir);

tools/create-egg/src/templates/tegg/package.json (6)

23-44: Template should not depend on moving "beta" tags; parameterize or pin to stable ranges.

Using tags like "beta" and broad majors ("24", "5", "1") in a scaffolded app makes installs non‑deterministic and prone to breakage when the tag moves. Prefer:

• Parameterized placeholders resolved by the generator, defaulting to stable caret ranges, or
• Explicit semver ranges (e.g., ^x.y.z).

If you intend to let users opt into “next/beta”, gate it via a prompt that swaps versions accordingly.

Example diff converting moving tags to template placeholders (adjust placeholder names to your templating system and defaults in the generator):

@@
   "dependencies": {
     "@eggjs/scripts": "^4.0.0",
     "@eggjs/tegg": "^3.5.2",
@@
-    "egg": "beta"
+    "egg": "{{eggVersion}}"
   },
   "devDependencies": {
-    "@eggjs/bin": "beta",
-    "@eggjs/mock": "beta",
-    "@eggjs/tsconfig": "beta",
-    "@types/node": "24",
-    "oxlint": "1",
-    "oxlint-tsgolint": "^0.2.0",
-    "typescript": "5",
-    "vitest": "beta"
+    "@eggjs/bin": "{{eggBinVersion}}",
+    "@eggjs/mock": "{{eggMockVersion}}",
+    "@eggjs/tsconfig": "{{eggTsconfigVersion}}",
+    "@types/node": "{{typesNodeVersion}}",
+    "oxlint": "{{oxlintVersion}}",
+    "oxlint-tsgolint": "{{oxlintTsgolintVersion}}",
+    "typescript": "{{typescriptVersion}}",
+    "vitest": "{{vitestVersion}}"
   }

---

17-17: Replace ‘sleep’ with a cross‑platform pause.

‘sleep’ isn’t available on Windows shells. Use a Node one‑liner to ensure CI/dev parity.

Apply:

-    "postci": "npm run prepublishOnly && npm start && sleep 10 && npm stop && npm run clean",
+    "postci": "npm run prepublishOnly && npm start && node -e \"setTimeout(() => process.exit(0), 10_000)\" && npm stop && npm run clean",

---

21-21: Consider renaming/build step clarity for apps.

For a private app template, “prepublishOnly” is a misnomer and won’t run in most workflows. Prefer a neutral “build” script and call it from CI.

Example:

-    "prepublishOnly": "npm run clean && npm run tsc"
+    "build": "npm run clean && npm run tsc"

If you adopt this, also update “postci” to run “npm run build”.

---

12-16: Avoid duplicate test scripts.

“test:local” and “test” both run vitest. Make “test:local” delegate to “test” to keep behavior in one place.

-    "test:local": "vitest run",
+    "test:local": "npm run test",

---

48-57: Template these metadata fields to reduce post‑scaffold edits.

Use placeholders tied to user/org input (like {{githubUser}} and {{name}}) so generated apps have correct links out of the box.

-  "homepage": "https://github.com/YOUR_USERNAME/YOUR_REPO#readme",
+  "homepage": "https://github.com/{{githubUser}}/{{name}}#readme",
@@
-  "bugs": {
-    "url": "https://github.com/YOUR_USERNAME/YOUR_REPO/issues"
-  },
+  "bugs": { "url": "https://github.com/{{githubUser}}/{{name}}/issues" },
@@
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/YOUR_USERNAME/YOUR_REPO.git"
-  },
+  "repository": { "type": "git", "url": "git+https://github.com/{{githubUser}}/{{name}}.git" },
-  "author": "Author Name <[email protected]>",
+  "author": "{{authorName}} <{{authorEmail}}>",

---

1-58: Catalog/workspace rule applicability to templates.

Repo guidelines say tools//package.json should use “catalog:” and “workspace:*”. Applying that inside a project template would break installs outside this monorepo. Please confirm templates are exempt from this rule; if not, consider scoping the guideline to exclude tools//src/templates/**.

Suggestion: Update the lint rule/docs to explicitly exclude “tools//src/templates//package.json” from the catalog/workspace requirement to avoid future churn.

tools/create-egg/src/templates/simple-ts/config/plugin.ts (1)

3-9: Prefer satisfies for safer typing and better inference.

This keeps literal inference while validating against EggPlugin.

Apply this diff:

-const plugins: EggPlugin = {
+const plugins = {
   // static: true,
   // nunjucks: {
   //   enable: true,
   //   package: 'egg-view-nunjucks',
   // },
-};
+} satisfies EggPlugin;

tools/create-egg/src/templates/egg3-simple-ts/config/plugin.ts (3)

1-1: Use type-only import to avoid a runtime dependency on 'egg'.

This prevents emitting an import in JS when the type erases, keeping the config side-effect free.

-import { EggPlugin } from 'egg';
+import type { EggPlugin } from 'egg';

---

3-11: Inline the default export and use satisfies for stricter key checking.

Terser template; TS will validate keys against EggPlugin without widening the value type.

-const plugin: EggPlugin = {
-  // static: true,
-  // nunjucks: {
-  //   enable: true,
-  //   package: 'egg-view-nunjucks',
-  // },
-};
-
-export default plugin;
+export default {
+  // static: true,
+  // nunjucks: {
+  //   enable: true,
+  //   package: 'egg-view-nunjucks',
+  // },
+} satisfies EggPlugin;

---

4-9: Add a quick install hint for optional plugins.

Prevents template users from enabling Nunjucks without installing the package.

   // nunjucks: {
+  //   // Enable after installing: pnpm add egg-view-nunjucks
     //   enable: true,
     //   package: 'egg-view-nunjucks',
   // },

tools/create-egg/src/templates/egg3-simple-ts/_.gitignore (5)

7-7: Remove duplicate ignore for logs/

logs/ is listed twice. Keep a single entry.

-logs/

---

11-11: Don’t blanket-ignore “*.lock”; either commit lockfiles or scope explicitly

Ignoring all “*.lock” can hide non-package-manager locks. Prefer committing lockfiles for apps, or narrow to specific ones if you truly want them ignored.

Option A (recommended: commit lockfiles) — remove the rule:

-*.lock

Option B — scope explicitly:

-*.lock
+package-lock.json
+yarn.lock
+pnpm-lock.yaml

---

2-2: Match rotated npm logs

Use a wildcard to catch rotated/debug variants.

-npm-debug.log
+npm-debug.log*

---

20-21: Add common TS/coverage artifacts to ignore

If the template uses nyc and typings (common in Egg TS projects), ignore them as well. If compilation emits to dist/, include it too.

 config/**/*.map
+.nyc_output/
+typings/
+# add only if outDir is "dist"
+dist/

Run the verification script in my earlier comment to confirm outDir before adding dist/.

---

21-21: Add trailing newline at EOF

POSIX tools expect a newline-terminated file.

-<no newline at end of file>
+

tools/create-egg/src/index.ts (3)

208-212: Exit code handling for customCommand may report success on failure.

status can be null or undefined; defaulting to 0 masks errors. Check error and fall back to non‑zero.

-    const { status } = spawn.sync(command, replacedArgs, {
-      stdio: 'inherit',
-    });
-    process.exit(status ?? 0);
+    const result = spawn.sync(command, replacedArgs, { stdio: 'inherit' });
+    if (result.error) {
+      prompts.log.error(`Failed to run: ${fullCustomCommand}`);
+      process.exit(1);
+    }
+    process.exit(result.status ?? 1);

---

116-149: “Ignore files and continue” currently overwrites collisions. Clarify or honor ‘ignore’.

Selecting “Ignore files and continue” should not overwrite existing files. Add a skip‑existing policy and enforce it in write().

@@
-  // 2. Handle directory if exist and not empty
+  // 2. Handle directory if exist and not empty
+  let skipExistingFiles = false;
   if (fs.existsSync(targetDir) && !isEmpty(targetDir)) {
@@
     switch (overwrite) {
       case 'yes':
         emptyDir(targetDir);
         break;
       case 'no':
         cancel();
         return;
+      case 'ignore':
+        skipExistingFiles = true;
+        break;
     }
   }
@@
-  const write = (file: string, content?: string) => {
+  const write = (file: string, content?: string) => {
     const targetPath = path.join(
       root,
       file.startsWith('_') ? file.slice(1) : file
     );
+    if (skipExistingFiles && fs.existsSync(targetPath)) return;
     if (content) {
       fs.writeFileSync(targetPath, content);
     } else {
       copy(path.join(templateDir, file), targetPath);
     }
   };

Alternatively, rename the option label to “Proceed and overwrite conflicts” to match current behavior.

Also applies to: 220-230

---

11-19: Avoid parsing argv at module import time.

Parsing argv at top‑level creates side effects when imported by tests or other tools. Parse inside init() or accept args from the CLI wrapper.

-const argv = mri<{ ...
-}>(process.argv.slice(2), { ... });
+function parseArgv() {
+  return mri<{ template?: string; help?: boolean; overwrite?: boolean }>(
+    process.argv.slice(2),
+    { alias: { h: 'help', t: 'template' }, boolean: ['help', 'overwrite'], string: ['template'] },
+  );
+}
@@
 export async function init() {
+  const argv = parseArgv();

Also applies to: 78-90

tools/create-egg/src/templates/simple-ts/typings/index.d.ts (1)

1-3: Replace empty augmentation with a scaffold (or remove).

declare module 'egg' {} is a no‑op. Either remove it or keep a commented scaffold for users to extend types later.

 import 'egg';
 
-declare module 'egg' {}
+// Augment Egg types here when needed, e.g.:
+// declare module 'egg' {
+//   interface IService {
+//     // foo: FooService;
+//   }
+// }

tools/create-egg/src/templates/egg3-simple-ts/typings/index.d.ts (1)

1-3: Same here: avoid empty augmentation.

Remove the no‑op augmentation or replace with a commented scaffold to guide users.

 import 'egg';
 
-declare module 'egg' {}
+// Augment Egg types here when needed, e.g.:
+// declare module 'egg' {
+//   interface IService {
+//     // foo: FooService;
+//   }
+// }

tools/create-egg/src/templates/egg3-simple-ts/app/service/Test.ts (1)

6-6: File naming: prefer lowercase with hyphens per repo style.

Rename Test.ts → test.ts to align with “lowercase-with-hyphens” rule and avoid case‑sensitivity pitfalls.

tools/create-egg/src/templates/egg3-simple-ts/test/app/service/Test.test.ts (2)

1-1: Use strict assertions and Node prefix.

Prefer assert.strictEqual for clearer diffs, and import from node:assert.

-import assert from 'assert';
+import { strict as assert } from 'node:assert';
@@
-    assert(result === 'hi, egg');
+    assert.strictEqual(result, 'hi, egg');

Also applies to: 13-15

---

5-5: Correct describe title extension.

It’s a .ts file.

-describe('test/app/service/Test.test.js', () => {
+describe('test/app/service/Test.test.ts', () => {

tools/create-egg/src/templates/simple-ts/package.json (5)

18-18: postci is not cross‑platform (sleep).

sleep breaks on Windows. Use a Node-based delay or condition check.

-    "postci": "npm run prepublishOnly && npm start && sleep 10 && npm stop && npm run clean",
+    "postci": "npm run prepublishOnly && npm start && node -e \"setTimeout(() => {}, 10_000)\" && npm stop && npm run clean",

---

32-33: Align @types/node with engines.

Engines require Node >=20.19.0 but types target "24". Recommend matching the LTS major to reduce type drift.

-    "@types/node": "24",
+    "@types/node": "^20",

---

19-22: Consider using project references for build scripts.

If the template uses TS project references, prefer tsc -b for builds (you already do for clean). Not blocking.

-    "tsc": "tsc",
+    "tsc": "tsc -b",

---

41-49: Placeholder repository metadata may leak to generated projects.

Either omit these fields or template them properly; otherwise users get broken links.

-  "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"
-  },
+  "//": "Set these after repo is created",

---

33-35: oxlint plugin present but unused.

Without a config enabling oxlint-tsgolint, the plugin won’t apply. Add a config file or remove the dep.

tools/create-egg/src/templates/simple-ts/test/app/controller/home.test.ts (1)

1-1: Prefer Node assert in Vitest tests (repo convention).

Swap to assert for consistency with guidelines.

-import { test, expect } from 'vitest';
+import { test } from 'vitest';
+import assert from 'assert';

-  expect(res.text).toBe('hi, egg');
+  assert.strictEqual(res.text, 'hi, egg');

tools/create-egg/src/templates/egg3-simple-ts/test/app/controller/home.test.ts (1)

2-2: Unify mock bootstrap import.

Use '@eggjs/mock/bootstrap' for the monorepo ESM-first tooling.

-import { app } from 'egg-mock/bootstrap';
+import { app } from '@eggjs/mock/bootstrap';

tools/create-egg/src/templates/simple-ts/test/app/service/Test.test.ts (1)

1-1: Prefer Node assert in Vitest tests (repo convention).

Adopt assert for consistency.

-import { test, expect } from 'vitest';
+import { test } from 'vitest';
+import assert from 'assert';

-  expect(result).toBe('hi, egg');
+  assert.strictEqual(result, 'hi, egg');

tools/create-egg/src/templates/simple-ts/app/router.ts (1)

1-1: Use type‑only import for Application.

Avoids emitting an unnecessary runtime import in ESM builds.

-import { Application } from 'egg';
+import type { Application } from 'egg';

tools/create-egg/src/templates/simple-ts/app/service/Test.ts (1)

6-14: Add explicit return type.

Minor: makes the public API clearer in templates.

tools/create-egg/src/templates/egg3-simple-ts/app/router.ts (1)

1-1: Use type‑only import for Application.

Keep ESM output clean.

-import { Application } from 'egg';
+import type { Application } from 'egg';

tools/create-egg/src/templates/egg3-simple-ts/app/controller/home.ts (1)

4-4: Add explicit return type on public method

Make the return type clear to TS users and templates that enable explicit returns.

-  public async index() {
+  public async index(): Promise<void> {

tools/create-egg/src/templates/egg3-simple-ts/tsconfig.json (1)

3-3: Tighten exclude glob.

Use "node_modules" instead of "node_modules*" to avoid surprising exclusions.

-  "exclude": ["app/public", "app/views", "node_modules*"]
+  "exclude": ["app/public", "app/views", "node_modules"]

tools/create-egg/src/templates/egg3-simple-ts/README.md (1)

28-28: Fix typo in npm script documentation.

There's a typo "se" that should be "Use".

- - se `npm run clean` to clean compiled js at development mode once
+ - Use `npm run clean` to clean compiled js at development mode once

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to packages/egg/tsconfig.json : packages/egg/tsconfig.json must extend eggjs/tsconfig and enable strict mode

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to tools/egg-bin/tsdown.config.ts : egg-bin tool must use tsdown for TypeScript compilation

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to packages/egg/tsdown.config.ts : packages/egg must use tsdown configured for unbundled ESM output

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to {packages,plugins,tools}/**/tsconfig.json : All sub-project tsconfig.json files must extend the root tsconfig.json using "extends": "../../tsconfig.json"

Learnt from: CR
PR: eggjs/egg#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-14T08:41:30.618Z
Learning: Applies to packages/*/tsconfig.json : All sub-project tsconfig.json files must extend from the root via "extends": "../../tsconfig.json"

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to tools/egg-bin/test/**/*.test.ts : egg-bin (CLI tool) tests must use Mocha

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to plugins/*/package.json : Plugin package.json must export TS sources in development ("exports": { ".": "./src/index.ts", "./agent": "./src/agent.ts", "./app": "./src/app.ts", "./package.json": "./package.json" })

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to plugins/*/package.json : Plugin package.json must include an eggPlugin configuration field

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to plugins/**/tsdown.config.ts : All plugins must use the standard tsdown configuration template (entry: 'src/**/*.ts', unbundle: true, dts: true, exports.devExports: true)

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to {packages,plugins}/**/test/**/*.test.ts : Vitest test files should follow the naming pattern test/**/*.test.ts and import from vitest

Learnt from: CR
PR: eggjs/egg#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-14T08:41:30.618Z
Learning: Applies to packages/**/test/**/*.test.ts : Name test files as test/**/*.test.ts and run them with Vitest

Learnt from: CR
PR: eggjs/egg#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-14T08:41:30.618Z
Learning: Applies to packages/**/test/**/*.test.ts : Use import { describe, it } from 'vitest' in tests

Learnt from: CR
PR: eggjs/egg#0
File: AGENTS.md:0-0
Timestamp: 2025-09-18T07:56:17.417Z
Learning: For features affecting HTTP or process orchestration, add regression tests that exercise both the CommonJS and TypeScript example apps

Learnt from: CR
PR: eggjs/egg#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-15T01:56:16.297Z
Learning: Applies to {packages,plugins}/**/test/**/*.test.ts : Use Node.js built-in assert for assertions in Vitest tests

Learnt from: CR
PR: eggjs/egg#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-14T08:41:30.618Z
Learning: Applies to packages/**/test/**/*.test.ts : Use Node.js built-in assert module for test assertions

Learnt from: CR
PR: eggjs/egg#0
File: AGENTS.md:0-0
Timestamp: 2025-09-18T07:56:17.417Z
Learning: Applies to **/*.ts : Prefer TypeScript and ESM: write sources and exports in .ts (ESM-first) rather than CommonJS

Learnt from: CR
PR: eggjs/egg#0
File: AGENTS.md:0-0
Timestamp: 2025-09-18T07:56:17.417Z
Learning: Applies to **/*.ts : Use two-space indentation, trailing commas, and semicolons (Prettier/oxlint defaults)