Skip to content

Commit 2a4c085

Browse files
killaguclaude
andcommitted
docs: fix script descriptions and prepend corepack bootstrap
- .github/copilot-instructions.md: `ut run ci` actually runs tests with coverage only (no build); rewrite description accordingly. Site dev server uses VitePress' default port, not :8000; drop the hard-coded URL. Replace the `cd site && ut run build` invocation with the root `ut run site:build` script. - scripts/utils.js: clarify the workspace-file comment — utoo reads `pnpm-workspace.yaml` as-is, so naming the file matters. - README.md / README.zh-CN.md / packages/egg/README.md: prepend `corepack enable utoo` to the quickstart so clean machines get the pinned utoo before `ut create`/`ut install`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f88b87b commit 2a4c085

5 files changed

Lines changed: 9 additions & 5 deletions

File tree

.github/copilot-instructions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,16 @@ ut run lint
6161

6262
- `ut run test` - **Run all tests (~2 minutes). NEVER CANCEL. Set timeout to 180+ seconds.**
6363
- `ut run test:cov` - **Run tests with coverage (~2 minutes). NEVER CANCEL. Set timeout to 180+ seconds.**
64-
- `ut run ci` - **Run test coverage + build (~2.1 minutes). NEVER CANCEL. Set timeout to 180+ seconds.**
64+
- `ut run ci` - **Run tests with coverage (~2 minutes). NEVER CANCEL. Set timeout to 180+ seconds.**
6565

6666
### Linting Commands
6767

6868
- `ut run lint` - Run oxlint across all packages (~2 seconds)
6969

7070
### Documentation Commands
7171

72-
- `ut run site:dev` - Start documentation dev server at http://localhost:8000
73-
- `cd site && ut run build` - **Build documentation site (~24 seconds). NEVER CANCEL. Set timeout to 60+ seconds.**
72+
- `ut run site:dev` - Start documentation dev server (defaults to VitePress port 5173)
73+
- `ut run site:build` - **Build documentation site (~24 seconds). NEVER CANCEL. Set timeout to 60+ seconds.**
7474

7575
### Example Applications (Currently Not Working)
7676

@@ -219,7 +219,7 @@ After making changes, always verify:
219219

220220
1. **Build Success**: `ut run build` completes without errors
221221
2. **Linting Passes**: `ut run lint` shows no new errors
222-
3. **Documentation Loads**: `ut run site:dev` starts successfully and site loads at http://localhost:8000
222+
3. **Documentation Loads**: `ut run site:dev` starts successfully and the printed VitePress URL responds
223223
4. **Tests Run**: `ut run test` executes (some failures expected, focus on your changes)
224224

225225
**Remember**: This is a complex enterprise framework. Always build first, validate incrementally, and focus on the core packages (`egg`, `core`, `utils`) for most development work.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ English | [简体中文](./README.zh-CN.md)
2727
Follow the commands listed below.
2828

2929
```bash
30+
$ corepack enable utoo
3031
$ mkdir showcase && cd showcase
3132
$ ut create egg@beta
3233
$ ut install

README.zh-CN.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
## 快速开始
2727

2828
```bash
29+
corepack enable utoo
2930
mkdir showcase && cd showcase
3031
ut create egg@beta
3132
ut install

packages/egg/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
Follow the commands listed below.
2222

2323
```bash
24+
$ corepack enable utoo
2425
$ mkdir showcase && cd showcase
2526
$ npm init egg --type=simple # Optionally ut create egg --type=simple
2627
$ ut install

scripts/utils.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ import path from 'node:path';
33

44
import yaml from 'js-yaml';
55

6-
// Get all publishable packages from utoo workspace
6+
// Get all publishable packages by reading pnpm-workspace.yaml
7+
// (utoo consumes the same workspace manifest).
78

89
export function getPublishablePackages(baseDir) {
910
const workspaceFile = path.join(baseDir, 'pnpm-workspace.yaml');

0 commit comments

Comments
 (0)