@icebreakers/monorepo-templates 1.2.1 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/.github/workflows/ci.yml +4 -4
- package/assets/.github/workflows/release.yml +8 -7
- package/assets/package.json +9 -8
- package/assets/renovate.json +0 -1
- package/assets/turbo.json +3 -0
- package/assets-data.mjs +0 -1
- package/dist/cli.mjs +1 -1
- package/dist/index.mjs +1 -1
- package/dist/{prepare--cxFop8c.mjs → prepare-D7eJqEqy.mjs} +1 -2
- package/package.json +5 -5
- package/templates/cli/package.json +1 -1
- package/templates/client/package.json +10 -10
- package/templates/client/worker-configuration.d.ts +463 -202
- package/templates/server/package.json +3 -3
- package/templates/server/worker-configuration.d.ts +463 -202
- package/templates/tsdown/package.json +1 -1
- package/templates/vitepress/.vitepress/config.ts +26 -126
- package/templates/vitepress/.vitepress/env.d.ts +1 -0
- package/templates/vitepress/.vitepress/home/content.ts +94 -0
- package/templates/vitepress/.vitepress/home/types.ts +49 -0
- package/templates/vitepress/.vitepress/navigation/routes.ts +146 -0
- package/templates/vitepress/.vitepress/seo.ts +54 -0
- package/templates/vitepress/.vitepress/theme/Layout.vue +27 -0
- package/templates/vitepress/.vitepress/theme/components/HomePage.vue +112 -0
- package/templates/vitepress/.vitepress/theme/home/foundation.css +237 -0
- package/templates/vitepress/.vitepress/theme/home/index.css +3 -0
- package/templates/vitepress/.vitepress/theme/home/responsive.css +142 -0
- package/templates/vitepress/.vitepress/theme/home/sections.css +232 -0
- package/templates/vitepress/.vitepress/theme/index.ts +11 -1
- package/templates/vitepress/ai/llms-txt.md +2 -2
- package/templates/vitepress/index.md +6 -60
- package/templates/vitepress/learn/index.md +18 -0
- package/templates/vitepress/{monorepo → learn/monorepo}/commands.md +1 -1
- package/templates/vitepress/{monorepo → learn/monorepo}/index.md +3 -3
- package/templates/vitepress/{monorepo → learn/monorepo}/templates.md +1 -1
- package/templates/vitepress/learn/packages/examples/2.npm-basic-package/README.md +1 -0
- package/templates/vitepress/learn/packages/examples/3.npm-basic-package/README.md +1 -0
- package/templates/vitepress/learn/packages/index.md +36 -0
- package/templates/vitepress/learn/packages/modern/bundlers.md +40 -0
- package/templates/vitepress/learn/packages/modern/dts.md +48 -0
- package/templates/vitepress/learn/packages/modern/esm-vs-cjs.md +42 -0
- package/templates/vitepress/learn/packages/modern/index.md +38 -0
- package/templates/vitepress/learn/packages/modern/package-entry-points.md +46 -0
- package/templates/vitepress/learn/packages/modern/typescript.md +43 -0
- package/templates/vitepress/{why/index.md → learn/packages/modern-overview.md} +1 -1
- package/templates/vitepress/learn/packages/module-extensions.md +34 -0
- package/templates/vitepress/learn/packages/publish.md +43 -0
- package/templates/vitepress/learn/packages/reuse-javascript.md +39 -0
- package/templates/vitepress/learn/packages/runtime-globals.md +36 -0
- package/templates/vitepress/{repoctl/index.md → learn/repoctl-model.md} +8 -8
- package/templates/vitepress/learn/tools/changeset.md +30 -0
- package/templates/vitepress/learn/tools/husky.md +50 -0
- package/templates/vitepress/learn/tools/lint-staged.md +39 -0
- package/templates/vitepress/{tools → learn/tools}/llms-txt.md +1 -1
- package/templates/vitepress/learn/tools/pnpm.md +47 -0
- package/templates/vitepress/learn/tools/renovate.md +31 -0
- package/templates/vitepress/learn/tools/turborepo.md +40 -0
- package/templates/vitepress/package.json +14 -7
- package/templates/vitepress/public/brand/apple-touch-icon.png +0 -0
- package/templates/vitepress/public/brand/favicon.ico +0 -0
- package/templates/vitepress/public/brand/repoctl-lockup-dark.svg +6 -0
- package/templates/vitepress/public/brand/repoctl-lockup.svg +20 -0
- package/templates/vitepress/public/brand/repoctl-mark-192.png +0 -0
- package/templates/vitepress/public/brand/repoctl-mark-dark.svg +13 -0
- package/templates/vitepress/public/brand/repoctl-mark.svg +13 -0
- package/templates/vitepress/public/brand/repoctl-social-en.png +0 -0
- package/templates/vitepress/public/brand/repoctl-social-en.webp +0 -0
- package/templates/vitepress/public/brand/repoctl-social-zh.png +0 -0
- package/templates/vitepress/public/brand/repoctl-social-zh.webp +0 -0
- package/templates/vitepress/public/favicon.ico +0 -0
- package/templates/vitepress/public/logo.jpg +0 -0
- package/templates/vitepress/public/repoctl-doctor.png +0 -0
- package/templates/vitepress/{repoctl → reference}/commands.md +2 -2
- package/templates/vitepress/reference/index.md +15 -0
- package/templates/vitepress/reference/output.md +37 -0
- package/templates/vitepress/{repoctl → reference}/templates.md +2 -2
- package/templates/vitepress/scripts/check-locales.ts +196 -0
- package/templates/vitepress/start/choose-next.md +14 -0
- package/templates/vitepress/start/first-run.md +39 -0
- package/templates/vitepress/start/index.md +26 -0
- package/templates/vitepress/{repoctl/getting-started.md → start/install.md} +5 -5
- package/templates/vitepress/{repoctl → tasks}/adopt-existing.md +30 -4
- package/templates/vitepress/{repoctl → tasks}/checks.md +27 -1
- package/templates/vitepress/{repoctl/workflows.md → tasks/ci.md} +65 -4
- package/templates/vitepress/tasks/create-project.md +37 -0
- package/templates/vitepress/{repoctl/scenarios.md → tasks/index.md} +8 -8
- package/templates/vitepress/tasks/release.md +31 -0
- package/templates/vitepress/{repoctl → tasks}/reports.md +25 -0
- package/templates/vitepress/{repoctl → tasks}/troubleshooting.md +30 -4
- package/templates/vitepress/tsconfig.json +7 -0
- package/templates/vitepress/wrangler.jsonc +20 -3
- package/templates/vitepress/zh/ai/index.md +1 -1
- package/templates/vitepress/zh/ai/llms-txt.md +7 -7
- package/templates/vitepress/zh/index.md +6 -63
- package/templates/vitepress/zh/learn/index.md +18 -0
- package/templates/vitepress/zh/{monorepo → learn/monorepo}/commands.md +3 -3
- package/templates/vitepress/zh/{monorepo → learn/monorepo}/manage.md +4 -4
- package/templates/vitepress/zh/{monorepo → learn/monorepo}/templates.md +2 -2
- package/templates/vitepress/zh/{monorepo → learn/monorepo}/troubleshooting.md +2 -2
- package/templates/vitepress/zh/learn/packages/examples/2.npm-basic-package/README.md +1 -0
- package/templates/vitepress/zh/learn/packages/examples/3.npm-basic-package/README.md +1 -0
- package/templates/vitepress/zh/{why → learn/packages}/modern/index.md +1 -1
- package/templates/vitepress/zh/learn/packages/modern-overview.md +38 -0
- package/templates/vitepress/zh/{repoctl/index.md → learn/repoctl-model.md} +19 -19
- package/templates/vitepress/zh/{tools → learn/tools}/husky.md +1 -1
- package/templates/vitepress/zh/{tools → learn/tools}/lint-staged.md +1 -1
- package/templates/vitepress/zh/{tools → learn/tools}/llms-txt.md +1 -1
- package/templates/vitepress/zh/{tools → learn/tools}/pnpm.md +1 -1
- package/templates/vitepress/zh/{tools → learn/tools}/turborepo.md +1 -1
- package/templates/vitepress/zh/{repoctl → reference}/commands.md +4 -4
- package/templates/vitepress/zh/{repoctl → reference}/config.md +1 -1
- package/templates/vitepress/zh/reference/index.md +15 -0
- package/templates/vitepress/zh/reference/output.md +37 -0
- package/templates/vitepress/zh/{repoctl → reference}/templates.md +4 -4
- package/templates/vitepress/zh/start/choose-next.md +14 -0
- package/templates/vitepress/zh/{repoctl/doctor.md → start/diagnose.md} +1 -1
- package/templates/vitepress/zh/start/first-run.md +39 -0
- package/templates/vitepress/zh/start/index.md +26 -0
- package/templates/vitepress/zh/{repoctl/getting-started.md → start/install.md} +5 -5
- package/templates/vitepress/zh/{repoctl → tasks}/adopt-existing.md +30 -4
- package/templates/vitepress/zh/{repoctl → tasks}/checks.md +27 -1
- package/templates/vitepress/zh/{repoctl/workflows.md → tasks/ci.md} +73 -12
- package/templates/vitepress/zh/tasks/create-project.md +37 -0
- package/templates/vitepress/zh/{repoctl/scenarios.md → tasks/index.md} +8 -8
- package/templates/vitepress/zh/tasks/release.md +31 -0
- package/templates/vitepress/zh/{repoctl → tasks}/reports.md +25 -0
- package/templates/vitepress/zh/{repoctl → tasks}/troubleshooting.md +39 -13
- package/templates/vue-lib/package.json +3 -3
- package/assets/netlify.toml +0 -14
- package/templates/vitepress/getting-started.md +0 -11
- package/templates/vitepress/knowledge/index.md +0 -26
- package/templates/vitepress/thinking.md +0 -7
- package/templates/vitepress/tools/changeset.md +0 -25
- package/templates/vitepress/tools/husky.md +0 -12
- package/templates/vitepress/tools/lint-staged.md +0 -12
- package/templates/vitepress/tools/pnpm.md +0 -15
- package/templates/vitepress/tools/renovate.md +0 -7
- package/templates/vitepress/tools/turborepo.md +0 -14
- package/templates/vitepress/why/examples/2.npm-basic-package/README.md +0 -1
- package/templates/vitepress/why/examples/3.npm-basic-package/README.md +0 -1
- package/templates/vitepress/why/how-to-reuse-js-code.md +0 -9
- package/templates/vitepress/why/js-cjs-mjs.md +0 -12
- package/templates/vitepress/why/js-keywords.md +0 -7
- package/templates/vitepress/why/modern/bundlers.md +0 -5
- package/templates/vitepress/why/modern/dts.md +0 -7
- package/templates/vitepress/why/modern/esm-vs-cjs.md +0 -7
- package/templates/vitepress/why/modern/index.md +0 -14
- package/templates/vitepress/why/modern/package-entry-points.md +0 -17
- package/templates/vitepress/why/modern/typescript.md +0 -7
- package/templates/vitepress/why/publish-basic-npm-package.md +0 -19
- package/templates/vitepress/why/what-is-npm-package.md +0 -7
- package/templates/vitepress/zh/getting-started.md +0 -40
- package/templates/vitepress/zh/knowledge/index.md +0 -50
- package/templates/vitepress/zh/thinking.md +0 -88
- package/templates/vitepress/zh/why/examples/2.npm-basic-package/README.md +0 -1
- package/templates/vitepress/zh/why/examples/3.npm-basic-package/README.md +0 -1
- package/templates/vitepress/zh/why/index.md +0 -1
- /package/templates/vitepress/{monorepo → learn/monorepo}/manage.md +0 -0
- /package/templates/vitepress/{monorepo → learn/monorepo}/publish.md +0 -0
- /package/templates/vitepress/{monorepo → learn/monorepo}/troubleshooting.md +0 -0
- /package/templates/vitepress/{why → learn/packages}/assets/npm-dt.svg +0 -0
- /package/templates/vitepress/{why → learn/packages}/assets/npm-ts.svg +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/0.npm-basic-package/index.js +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/0.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/1.npm-basic-package/index.cjs +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/1.npm-basic-package/index.d.ts +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/1.npm-basic-package/index.js +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/1.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/2.npm-basic-package/package-lock.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/2.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/2.npm-basic-package/rename-ext.js +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/2.npm-basic-package/src/index.ts +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/2.npm-basic-package/tsconfig.cjs.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/2.npm-basic-package/tsconfig.esm.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/2.npm-basic-package/tsconfig.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/3.npm-basic-package/package-lock.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/3.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/3.npm-basic-package/src/index.ts +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/3.npm-basic-package/tsconfig.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/3.npm-basic-package/tsdown.config.ts +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-cjs/cjs.cjs +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-cjs/esm.mjs +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-cjs/index.js +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-cjs/package-lock.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-cjs/package.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-esm/cjs.cjs +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-esm/createRequire.js +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-esm/esm.mjs +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-esm/index.js +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-esm/package-lock.json +0 -0
- /package/templates/vitepress/{why → learn/packages}/examples/usage-esm/package.json +0 -0
- /package/templates/vitepress/{tools → learn/tools}/index.md +0 -0
- /package/templates/vitepress/{repoctl → reference}/aliases.md +0 -0
- /package/templates/vitepress/{repoctl → reference}/config.md +0 -0
- /package/templates/vitepress/{repoctl → reference}/execution-model.md +0 -0
- /package/templates/vitepress/{repoctl → reference}/template-assets.md +0 -0
- /package/templates/vitepress/{repoctl/doctor.md → start/diagnose.md} +0 -0
- /package/templates/vitepress/zh/{monorepo → learn/monorepo}/index.md +0 -0
- /package/templates/vitepress/zh/{monorepo → learn/monorepo}/publish.md +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/assets/npm-dt.svg +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/assets/npm-ts.svg +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/0.npm-basic-package/index.js +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/0.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/1.npm-basic-package/index.cjs +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/1.npm-basic-package/index.d.ts +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/1.npm-basic-package/index.js +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/1.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/2.npm-basic-package/package-lock.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/2.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/2.npm-basic-package/rename-ext.js +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/2.npm-basic-package/src/index.ts +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/2.npm-basic-package/tsconfig.cjs.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/2.npm-basic-package/tsconfig.esm.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/2.npm-basic-package/tsconfig.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/3.npm-basic-package/package-lock.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/3.npm-basic-package/package.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/3.npm-basic-package/src/index.ts +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/3.npm-basic-package/tsconfig.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/3.npm-basic-package/tsdown.config.ts +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-cjs/cjs.cjs +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-cjs/esm.mjs +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-cjs/index.js +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-cjs/package-lock.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-cjs/package.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-esm/cjs.cjs +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-esm/createRequire.js +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-esm/esm.mjs +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-esm/index.js +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-esm/package-lock.json +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/examples/usage-esm/package.json +0 -0
- /package/templates/vitepress/zh/{why/what-is-npm-package.md → learn/packages/index.md} +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/modern/bundlers.md +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/modern/dts.md +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/modern/esm-vs-cjs.md +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/modern/package-entry-points.md +0 -0
- /package/templates/vitepress/zh/{why → learn/packages}/modern/typescript.md +0 -0
- /package/templates/vitepress/zh/{why/js-cjs-mjs.md → learn/packages/module-extensions.md} +0 -0
- /package/templates/vitepress/zh/{why/publish-basic-npm-package.md → learn/packages/publish.md} +0 -0
- /package/templates/vitepress/zh/{why/how-to-reuse-js-code.md → learn/packages/reuse-javascript.md} +0 -0
- /package/templates/vitepress/zh/{why/js-keywords.md → learn/packages/runtime-globals.md} +0 -0
- /package/templates/vitepress/zh/{tools → learn/tools}/changeset.md +0 -0
- /package/templates/vitepress/zh/{tools → learn/tools}/index.md +0 -0
- /package/templates/vitepress/zh/{tools → learn/tools}/renovate.md +0 -0
- /package/templates/vitepress/zh/{repoctl → reference}/aliases.md +0 -0
- /package/templates/vitepress/zh/{repoctl → reference}/execution-model.md +0 -0
- /package/templates/vitepress/zh/{repoctl → reference}/template-assets.md +0 -0
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Your first run
|
|
2
|
+
|
|
3
|
+
This is the smallest complete repoctl workflow. It makes one change, records evidence, and leaves you with a clear next action.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add -D repoctl
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Initialize
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm exec repo init
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Review the planned files before accepting writes. If the repository already has local conventions, use the adoption guide before allowing replacements.
|
|
18
|
+
|
|
19
|
+
## Diagnose
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
pnpm exec repo doctor
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The report checks the repository root, package manager, workspace layout, task runner, hooks, and release metadata. Fix the first reported blocker, then run the command again.
|
|
26
|
+
|
|
27
|
+
## Plan checks
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pnpm exec repo check --dry-run
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
This prints the commands that would run for lint, types, builds, tests, and package checks. Execute the plan only after it matches the checks your repository expects.
|
|
34
|
+
|
|
35
|
+
## Next
|
|
36
|
+
|
|
37
|
+
- New repository: [Create a package or app](/tasks/create-project).
|
|
38
|
+
- Existing repository: [Adopt an existing workspace](/tasks/adopt-existing).
|
|
39
|
+
- CI setup: [Add checks to CI](/tasks/ci).
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Start here
|
|
2
|
+
|
|
3
|
+
Use this section when repoctl is new to you. The shortest useful path is to install the CLI, run `repo init`, then run `repo doctor`.
|
|
4
|
+
|
|
5
|
+
## Pick your first move
|
|
6
|
+
|
|
7
|
+
- [Install and initialize](./install.md) if this is your first repoctl command.
|
|
8
|
+
- [Run the first diagnosis](./diagnose.md) if repoctl is already installed.
|
|
9
|
+
- [Choose the next task](./choose-next.md) after you have a diagnosis.
|
|
10
|
+
|
|
11
|
+
## What repoctl does
|
|
12
|
+
|
|
13
|
+
repoctl keeps common monorepo work in a small, predictable command set:
|
|
14
|
+
|
|
15
|
+
| Need | Command |
|
|
16
|
+
| ------------------------------- | ---------------------- |
|
|
17
|
+
| Add repository conventions | `repo init` |
|
|
18
|
+
| Inspect repository health | `repo doctor` |
|
|
19
|
+
| Create a package or app | `repo new` |
|
|
20
|
+
| Plan checks before running them | `repo check --dry-run` |
|
|
21
|
+
|
|
22
|
+
The CLI works with pnpm workspaces and understands Turborepo task graphs. It does not replace either tool.
|
|
23
|
+
|
|
24
|
+
## Before you continue
|
|
25
|
+
|
|
26
|
+
You need Node.js 22.12 or newer and pnpm available on your path. Run commands from the repository root so repoctl can read the workspace configuration.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Install and initialize
|
|
2
2
|
|
|
3
3
|
This guide follows the order you would use when adding repoctl to a workspace.
|
|
4
4
|
|
|
@@ -110,7 +110,7 @@ pnpm exec repo upgrade --yes
|
|
|
110
110
|
|
|
111
111
|
## Next Steps
|
|
112
112
|
|
|
113
|
-
- Adopt an existing repository: [Adopt
|
|
114
|
-
- Set team defaults: [Configuration](
|
|
115
|
-
- Inspect template keys: [Templates](
|
|
116
|
-
- Share diagnostic output: [
|
|
113
|
+
- Adopt an existing repository: [Adopt an existing workspace](/tasks/adopt-existing).
|
|
114
|
+
- Set team defaults: [Configuration](/reference/config).
|
|
115
|
+
- Inspect template keys: [Templates](/reference/templates).
|
|
116
|
+
- Share diagnostic output: [Troubleshoot](/tasks/troubleshooting).
|
|
@@ -1,4 +1,30 @@
|
|
|
1
|
-
# Adopt
|
|
1
|
+
# Adopt an existing workspace
|
|
2
|
+
|
|
3
|
+
## When To Use
|
|
4
|
+
|
|
5
|
+
Use this task when a workspace already has scripts, hooks, or configuration that you need to keep while introducing repoctl.
|
|
6
|
+
|
|
7
|
+
## Prerequisites
|
|
8
|
+
|
|
9
|
+
- Run commands from the workspace root.
|
|
10
|
+
- Commit or stash unrelated local changes.
|
|
11
|
+
- Confirm that Node.js 22.12 or newer and pnpm are available.
|
|
12
|
+
|
|
13
|
+
## Smallest Command
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
repo doctor --markdown --redact --out reports/baseline.md
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Expected Output
|
|
20
|
+
|
|
21
|
+
The report records the detected package manager, workspace layout, task runner, tooling files, and release setup without exposing local paths.
|
|
22
|
+
|
|
23
|
+
## Common Branches
|
|
24
|
+
|
|
25
|
+
- Existing conventions are healthy: keep them and add only the missing managed assets.
|
|
26
|
+
- A file is already managed locally: use `repo upgrade --no-overwrite` and review the diff.
|
|
27
|
+
- Tooling is split across loaders: resolve the loader first, then rerun the diagnosis.
|
|
2
28
|
|
|
3
29
|
repoctl is not only for newly generated repositories. It can be adopted gradually in existing pnpm workspaces by using diagnostics and conservative asset syncs.
|
|
4
30
|
|
|
@@ -128,6 +154,6 @@ or manually extend `pnpm-workspace.yaml`.
|
|
|
128
154
|
|
|
129
155
|
## Keep Reading
|
|
130
156
|
|
|
131
|
-
- [
|
|
132
|
-
- [
|
|
133
|
-
- [Configuration](
|
|
157
|
+
- [Add checks to CI](/tasks/ci)
|
|
158
|
+
- [Troubleshoot](/tasks/troubleshooting)
|
|
159
|
+
- [Configuration](/reference/config)
|
|
@@ -2,7 +2,33 @@
|
|
|
2
2
|
outline: deep
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
#
|
|
5
|
+
# Run checks
|
|
6
|
+
|
|
7
|
+
## When To Use
|
|
8
|
+
|
|
9
|
+
Use this task before a commit, before a pull request, or when you need to reproduce the repository's CI plan locally.
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
- Run `repo doctor` from the workspace root.
|
|
14
|
+
- Install dependencies with the repository's pinned pnpm version.
|
|
15
|
+
- Decide whether you need a fast check or the full delivery gate.
|
|
16
|
+
|
|
17
|
+
## Smallest Command
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
repo check --dry-run
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Expected Output
|
|
24
|
+
|
|
25
|
+
repoctl prints the selected tasks and the exact commands that would run. Remove `--dry-run` only after the plan matches the repository policy.
|
|
26
|
+
|
|
27
|
+
## Common Branches
|
|
28
|
+
|
|
29
|
+
- A staged file needs a focused check: use `repo check --staged`.
|
|
30
|
+
- CI requires an artifact: add `--json --out reports/check-plan.json`.
|
|
31
|
+
- You are preparing a release: use `repo check --full` after the fast check passes.
|
|
6
32
|
|
|
7
33
|
`repo check` provides stable, task-oriented entrypoints for local and CI verification. It preserves the underlying workspace scripts and reports which commands will run before execution.
|
|
8
34
|
|
|
@@ -1,4 +1,30 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Add checks to CI
|
|
2
|
+
|
|
3
|
+
## When To Use
|
|
4
|
+
|
|
5
|
+
Use this task when local commands are ready and the same repository policy must run on every pull request or branch.
|
|
6
|
+
|
|
7
|
+
## Prerequisites
|
|
8
|
+
|
|
9
|
+
- A passing `repo check --dry-run` plan.
|
|
10
|
+
- A CI runner with Node.js, pnpm, and the repository lockfile.
|
|
11
|
+
- Non-interactive credentials for any publish or release job.
|
|
12
|
+
|
|
13
|
+
## Smallest Command
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
repo check --full --json --out reports/check-plan.json
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Expected Output
|
|
20
|
+
|
|
21
|
+
CI receives a stable plan and can upload the JSON or Markdown report as an artifact. The same command remains runnable locally.
|
|
22
|
+
|
|
23
|
+
## Common Branches
|
|
24
|
+
|
|
25
|
+
- Pull requests need a fast gate: use `repo check --staged` or the repository's pre-commit mode.
|
|
26
|
+
- Main branch needs a delivery gate: use `repo check --full`.
|
|
27
|
+
- A release job needs a version plan: run `repo release --dry-run` before publishing.
|
|
2
28
|
|
|
3
29
|
repoctl commands have two audiences: humans using short daily commands, and automation consuming stable reports.
|
|
4
30
|
|
|
@@ -82,8 +108,43 @@ repo verify pre-push
|
|
|
82
108
|
| Output for scripts | `--json --out <file>` |
|
|
83
109
|
| Share a redacted report | `--markdown --redact --out <file>` |
|
|
84
110
|
|
|
111
|
+
## Documentation Worker
|
|
112
|
+
|
|
113
|
+
The repoctl documentation is deployed as the `repoctl-docs` Cloudflare Worker. VitePress produces static assets, and Workers Static Assets serves them without an application handler or an `ASSETS` binding.
|
|
114
|
+
|
|
115
|
+
### Workers Builds settings
|
|
116
|
+
|
|
117
|
+
| Setting | Value |
|
|
118
|
+
| --------------------- | ------------------------------------------------------- |
|
|
119
|
+
| Repository root | Repository root |
|
|
120
|
+
| Production branch | `main` |
|
|
121
|
+
| Build command | `pnpm --filter @icebreakers/website build` |
|
|
122
|
+
| Production deploy | `pnpm --filter @icebreakers/website run deploy` |
|
|
123
|
+
| Non-production deploy | `pnpm --filter @icebreakers/website run deploy:preview` |
|
|
124
|
+
|
|
125
|
+
The build command checks locale parity before VitePress generates `.vitepress/dist`. The Worker config serves the generated `404.html` for missing routes and keeps `public/_redirects` active for legacy `/en/*` links.
|
|
126
|
+
|
|
127
|
+
### Preview, release, and rollback
|
|
128
|
+
|
|
129
|
+
Run a local validation before changing production:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
pnpm --filter @icebreakers/website build
|
|
133
|
+
pnpm --filter @icebreakers/website run deploy:dry-run
|
|
134
|
+
pnpm --filter @icebreakers/website exec wrangler dev
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Non-production Workers Builds upload a preview version. Promote a validated build through the production deploy command. To roll back, inspect the version history and select the last known-good version:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
pnpm --filter @icebreakers/website exec wrangler versions list
|
|
141
|
+
pnpm --filter @icebreakers/website exec wrangler rollback <VERSION_ID>
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
`repoctl.icebreaker.top` is the canonical custom domain. Cloudflare Redirect Rules send `repo.icebreaker.top/*` and `monorepo.icebreaker.top/*` to the canonical host with a permanent redirect while preserving the path and query string.
|
|
145
|
+
|
|
85
146
|
## Keep Reading
|
|
86
147
|
|
|
87
|
-
- [Command Reference](
|
|
88
|
-
- [
|
|
89
|
-
- [Command Aliases](
|
|
148
|
+
- [Command Reference](/reference/commands)
|
|
149
|
+
- [Troubleshoot](/tasks/troubleshooting)
|
|
150
|
+
- [Command Aliases](/reference/aliases)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Create a package or app
|
|
2
|
+
|
|
3
|
+
Use this task when the workspace is ready and you need a new package, application, service, CLI, or documentation site.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- Run `repo doctor` from the workspace root.
|
|
8
|
+
- Confirm the package name and destination directory.
|
|
9
|
+
- Check the available template keys with `repo templates`.
|
|
10
|
+
|
|
11
|
+
## Smallest command
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
repo new <name> --template <template>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
For example:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
repo new shared-config --template package
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Use `--dry-run` when you want to inspect the file plan without writing anything.
|
|
24
|
+
|
|
25
|
+
## Expected result
|
|
26
|
+
|
|
27
|
+
repoctl prints the selected template, destination, and files it will create. After confirmation, the new project is added to the workspace and its package metadata is ready for the repository checks.
|
|
28
|
+
|
|
29
|
+
## Common branches
|
|
30
|
+
|
|
31
|
+
- Template key is unknown: run `repo templates` and choose an installed key.
|
|
32
|
+
- Destination exists: choose a new name or inspect the existing project before using an overwrite option.
|
|
33
|
+
- The project needs custom assets: create it first, then use [managed template assets](/reference/template-assets) for shared files.
|
|
34
|
+
|
|
35
|
+
## Next
|
|
36
|
+
|
|
37
|
+
Run [checks](/tasks/checks), then add the new project to the [CI workflow](/tasks/ci).
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Task index
|
|
2
2
|
|
|
3
3
|
Start here when you know what you want to do, but not which repoctl command to use.
|
|
4
4
|
|
|
@@ -17,7 +17,7 @@ pnpm exec repo init --yes
|
|
|
17
17
|
pnpm exec repo doctor
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Continue with [Install and initialize](/start/install).
|
|
21
21
|
|
|
22
22
|
## I Want To Adopt repoctl In An Existing Repo
|
|
23
23
|
|
|
@@ -29,7 +29,7 @@ pnpm exec repo upgrade --no-overwrite
|
|
|
29
29
|
pnpm exec repo doctor --markdown --redact --out reports/doctor-after.md
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Continue with [Adopt an existing workspace](/tasks/adopt-existing).
|
|
33
33
|
|
|
34
34
|
## I Want To Create A Package Or App
|
|
35
35
|
|
|
@@ -45,7 +45,7 @@ For daily development, root scripts also work:
|
|
|
45
45
|
pnpm run repo:new -- sdk --template tsdown
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Keep reading: [Templates](
|
|
48
|
+
Keep reading: [Templates](/reference/templates).
|
|
49
49
|
|
|
50
50
|
## I Want To Check Before Committing
|
|
51
51
|
|
|
@@ -62,7 +62,7 @@ pnpm exec repo check --json --out reports/check-plan.json
|
|
|
62
62
|
pnpm exec repo check --markdown --redact --out reports/check-plan.md
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Continue with [Add checks to CI](/tasks/ci).
|
|
66
66
|
|
|
67
67
|
## I Want To Debug CI Or Another Machine
|
|
68
68
|
|
|
@@ -72,7 +72,7 @@ pnpm exec repo env support --markdown --redact --out reports/support.md
|
|
|
72
72
|
pnpm exec repo env snapshot --json --out reports/snapshot.json
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
Continue with [Troubleshoot](/tasks/troubleshooting).
|
|
76
76
|
|
|
77
77
|
## I Want To Sync Standard Assets
|
|
78
78
|
|
|
@@ -103,7 +103,7 @@ pnpm exec repo config inspect
|
|
|
103
103
|
pnpm exec repo cfg i --json --out reports/config.json
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
Keep reading: [Configuration](
|
|
106
|
+
Keep reading: [Configuration](/reference/config).
|
|
107
107
|
|
|
108
108
|
## I Want Shorter Commands
|
|
109
109
|
|
|
@@ -114,4 +114,4 @@ repo e support --markdown --redact
|
|
|
114
114
|
repo cfg i
|
|
115
115
|
```
|
|
116
116
|
|
|
117
|
-
Keep reading: [Command Aliases](
|
|
117
|
+
Keep reading: [Command Aliases](/reference/aliases).
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Release packages
|
|
2
|
+
|
|
3
|
+
Use this task when a change is ready to version and publish. Keep the release plan reviewable before any registry write.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- `repo doctor` reports a valid package manager and release configuration.
|
|
8
|
+
- The working tree is clean except for the intended changes.
|
|
9
|
+
- Every publishable change has a changeset or the repository's chosen intent file.
|
|
10
|
+
|
|
11
|
+
## Smallest command
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
repo release --dry-run
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Review the package groups, versions, changelog entries, and publish commands. Run the same command without `--dry-run` only after the plan is approved.
|
|
18
|
+
|
|
19
|
+
## Expected result
|
|
20
|
+
|
|
21
|
+
The release report names the packages that will change, the version decisions, and each subprocess that will run. A successful release also completes the configured post-publish hooks.
|
|
22
|
+
|
|
23
|
+
## Common branches
|
|
24
|
+
|
|
25
|
+
- Missing intent: add a changeset and rerun the plan.
|
|
26
|
+
- Fixed group mismatch: inspect the package relationships before editing versions.
|
|
27
|
+
- Registry authentication failure: refresh the local token and rerun the publish step; do not commit credentials.
|
|
28
|
+
|
|
29
|
+
## Next
|
|
30
|
+
|
|
31
|
+
Read [publishing and changelogs](/learn/monorepo/publish) for repository policy and [reports and output](/tasks/reports) for CI artifacts.
|
|
@@ -4,6 +4,31 @@ outline: deep
|
|
|
4
4
|
|
|
5
5
|
# Reports and Automation Output
|
|
6
6
|
|
|
7
|
+
## When To Use
|
|
8
|
+
|
|
9
|
+
Use this task when a person, CI job, or support request needs a durable record of what repoctl found or planned.
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
- Choose a `reports/` directory that is ignored or uploaded as a CI artifact.
|
|
14
|
+
- Use `--redact` before sharing environment details outside the repository.
|
|
15
|
+
|
|
16
|
+
## Smallest Command
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
repo env support --markdown --redact --out reports/support.md
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Expected Output
|
|
23
|
+
|
|
24
|
+
The output file contains stable headings and command results that can be attached to a pull request or issue.
|
|
25
|
+
|
|
26
|
+
## Common Branches
|
|
27
|
+
|
|
28
|
+
- Another tool consumes the result: use JSON with `--json`.
|
|
29
|
+
- You only need to inspect a plan: combine `--dry-run` with the desired format.
|
|
30
|
+
- A report contains a local path or token: regenerate it with `--redact`.
|
|
31
|
+
|
|
7
32
|
repoctl commands expose human-readable text for terminals, Markdown for issues and pull requests, and stable JSON for automation.
|
|
8
33
|
|
|
9
34
|
## Common Options
|
|
@@ -1,4 +1,30 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Troubleshoot
|
|
2
|
+
|
|
3
|
+
## When To Use
|
|
4
|
+
|
|
5
|
+
Use this task when initialization, checks, templates, or automation stop with an unexpected result.
|
|
6
|
+
|
|
7
|
+
## Prerequisites
|
|
8
|
+
|
|
9
|
+
- Run the command from the repository root.
|
|
10
|
+
- Keep the original error and the repository revision available.
|
|
11
|
+
- Remove secrets before sharing command output.
|
|
12
|
+
|
|
13
|
+
## Smallest Command
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
repo doctor --markdown --redact --out reports/doctor.md
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Expected Output
|
|
20
|
+
|
|
21
|
+
The report identifies the repository root, package manager, workspace configuration, tooling, and the first failing check.
|
|
22
|
+
|
|
23
|
+
## Common Branches
|
|
24
|
+
|
|
25
|
+
- The command is run from a child directory: change to the workspace root.
|
|
26
|
+
- A config file conflicts with a managed asset: inspect the plan before overwriting.
|
|
27
|
+
- A template key is unknown: list templates with `repo templates`.
|
|
2
28
|
|
|
3
29
|
repoctl focuses on reports that can be reproduced, saved, and shared.
|
|
4
30
|
|
|
@@ -91,6 +117,6 @@ repo check --json --out reports/check-plan.json
|
|
|
91
117
|
|
|
92
118
|
## Keep Reading
|
|
93
119
|
|
|
94
|
-
- [
|
|
95
|
-
- [Command Reference](
|
|
96
|
-
- [Command Aliases](
|
|
120
|
+
- [Add checks to CI](/tasks/ci)
|
|
121
|
+
- [Command Reference](/reference/commands)
|
|
122
|
+
- [Command Aliases](/reference/aliases)
|
|
@@ -9,6 +9,13 @@
|
|
|
9
9
|
"skipLibCheck": true
|
|
10
10
|
},
|
|
11
11
|
"include": [
|
|
12
|
+
".vitepress/home/**/*.ts",
|
|
13
|
+
".vitepress/navigation/**/*.ts",
|
|
14
|
+
".vitepress/seo.ts",
|
|
15
|
+
".vitepress/theme/**/*.ts",
|
|
16
|
+
".vitepress/theme/**/*.vue",
|
|
17
|
+
".vitepress/env.d.ts",
|
|
18
|
+
"scripts/**/*.ts",
|
|
12
19
|
"why/examples/2.npm-basic-package/src/**/*.ts",
|
|
13
20
|
"why/examples/3.npm-basic-package/src/**/*.ts"
|
|
14
21
|
]
|
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
{
|
|
2
|
-
"$schema": "
|
|
3
|
-
"name": "
|
|
4
|
-
"
|
|
2
|
+
"$schema": "./node_modules/wrangler/config-schema.json",
|
|
3
|
+
"name": "repoctl-docs",
|
|
4
|
+
"compatibility_date": "2026-08-16",
|
|
5
|
+
"compatibility_flags": ["nodejs_compat"],
|
|
6
|
+
"workers_dev": false,
|
|
7
|
+
"preview_urls": true,
|
|
8
|
+
"assets": {
|
|
9
|
+
"directory": ".vitepress/dist",
|
|
10
|
+
"not_found_handling": "404-page"
|
|
11
|
+
},
|
|
12
|
+
"routes": [
|
|
13
|
+
{
|
|
14
|
+
"pattern": "repoctl.icebreaker.top",
|
|
15
|
+
"custom_domain": true
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
"observability": {
|
|
19
|
+
"enabled": true,
|
|
20
|
+
"head_sampling_rate": 1
|
|
21
|
+
}
|
|
5
22
|
}
|
|
@@ -16,7 +16,7 @@ AI 文档入口用于给 Cursor、Claude Code、Codex 和其他 AI 编程工具
|
|
|
16
16
|
|
|
17
17
|
## 2. 在 AI 工具里怎么用
|
|
18
18
|
|
|
19
|
-
优先把 `https://
|
|
19
|
+
优先把 `https://repoctl.icebreaker.top/llms.txt` 作为入口提供给 AI 工具。只有当工具不能继续抓取链接,或者你需要离线提供完整上下文时,再使用 `https://repoctl.icebreaker.top/llms-full.txt`。
|
|
20
20
|
|
|
21
21
|
```txt
|
|
22
22
|
先给 llms.txt
|
|
@@ -16,7 +16,7 @@ description: 使用 llms.txt 为大语言模型提供更易读取的 repoctl 文
|
|
|
16
16
|
|
|
17
17
|
## 1. 使用方式
|
|
18
18
|
|
|
19
|
-
访问 `https://
|
|
19
|
+
访问 `https://repoctl.icebreaker.top/llms.txt` 可以获取当前文档的 LLM 索引。如果需要一次性提供完整上下文,可以使用 `https://repoctl.icebreaker.top/llms-full.txt`。
|
|
20
20
|
|
|
21
21
|
当你在 Cursor、Claude Code、Codex 或其他 AI 编程工具里引用 repoctl 文档时,优先提供 `llms.txt`,再按需要补充具体页面链接。
|
|
22
22
|
|
|
@@ -34,9 +34,9 @@ description: 说明这个页面解决的问题和适用场景。
|
|
|
34
34
|
|
|
35
35
|
AI 入口应该保持显眼,但不要替代正常文档结构:
|
|
36
36
|
|
|
37
|
-
| 页面类型 | 推荐位置
|
|
38
|
-
| -------------------------------------- |
|
|
39
|
-
| repoctl 命令、校验、诊断、报告 | `/
|
|
40
|
-
| monorepo 和 npm 包基础知识 | `/
|
|
41
|
-
| pnpm、Turborepo、versioning 等工具专题 | `/tools/`
|
|
42
|
-
| llms.txt 和 AI 工具读取约定 | `/ai/`
|
|
37
|
+
| 页面类型 | 推荐位置 |
|
|
38
|
+
| -------------------------------------- | ------------------------------------------------- |
|
|
39
|
+
| repoctl 命令、校验、诊断、报告 | `/start/` |
|
|
40
|
+
| monorepo 和 npm 包基础知识 | `/learn/`、`/learn/monorepo/`、`/learn/packages/` |
|
|
41
|
+
| pnpm、Turborepo、versioning 等工具专题 | `/learn/tools/` |
|
|
42
|
+
| llms.txt 和 AI 工具读取约定 | `/ai/` |
|
|
@@ -1,66 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
layout:
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
tagline: 用一套 CLI 管理初始化、诊断、创建模板、提交前校验和模板资产同步。
|
|
8
|
-
image:
|
|
9
|
-
src: /logo.jpg
|
|
10
|
-
alt: repoctl logo
|
|
11
|
-
actions:
|
|
12
|
-
- theme: brand
|
|
13
|
-
text: 快速开始
|
|
14
|
-
link: /zh/repoctl/getting-started
|
|
15
|
-
- theme: alt
|
|
16
|
-
text: 命令速查
|
|
17
|
-
link: /zh/repoctl/commands
|
|
18
|
-
- theme: alt
|
|
19
|
-
text: AI 文档入口
|
|
20
|
-
link: /zh/ai/
|
|
21
|
-
|
|
22
|
-
features:
|
|
23
|
-
- title: 从已有仓库开始
|
|
24
|
-
details: 安装 repoctl 后运行 setup 和 doctor,先把 workspace、根脚本、配置冲突和提交链路检查清楚。
|
|
25
|
-
- title: 用模板创建包和应用
|
|
26
|
-
details: repo new 支持交互式创建、指定模板、dry-run、JSON 输出和创建计划落盘。
|
|
27
|
-
- title: 把质量门禁变成日常命令
|
|
28
|
-
details: repo check 统一预览和执行 lint、typecheck、build、test、tsd 等推荐校验。
|
|
29
|
-
- title: 给 AI 工具的文档入口
|
|
30
|
-
details: 构建时自动生成 llms.txt、llms-full.txt 和页面 Markdown,让 AI 编程工具更容易读取 repoctl 文档。
|
|
2
|
+
layout: page
|
|
3
|
+
aside: false
|
|
4
|
+
pageClass: repoctl-home-page
|
|
5
|
+
title: repoctl
|
|
6
|
+
description: 面向 pnpm 与 Turborepo monorepo 的任务型 CLI。
|
|
31
7
|
---
|
|
32
8
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
pnpm add -D repoctl
|
|
37
|
-
pnpm exec repo init
|
|
38
|
-
pnpm exec repo doctor
|
|
39
|
-
pnpm exec repo new
|
|
40
|
-
pnpm exec repo check
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
在由 repoctl 创建或初始化的仓库里,同一套工作流会暴露成更短的根脚本:
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
pnpm run repo:init
|
|
47
|
-
pnpm run repo:doctor
|
|
48
|
-
pnpm run repo:new
|
|
49
|
-
pnpm run repo:check
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
## 你可以继续阅读
|
|
53
|
-
|
|
54
|
-
- [repoctl 概览](./repoctl/index.md)
|
|
55
|
-
- [快速开始](./repoctl/getting-started.md)
|
|
56
|
-
- [接入已有仓库](./repoctl/adopt-existing.md)
|
|
57
|
-
- [按场景选命令](./repoctl/scenarios.md)
|
|
58
|
-
- [执行模型](./repoctl/execution-model.md)
|
|
59
|
-
- [命令速查](./repoctl/commands.md)
|
|
60
|
-
- [校验链路](./repoctl/checks.md)
|
|
61
|
-
- [doctor 诊断](./repoctl/doctor.md)
|
|
62
|
-
- [配置文件](./repoctl/config.md)
|
|
63
|
-
- [模板与创建](./repoctl/templates.md)
|
|
64
|
-
- [模板资产治理](./repoctl/template-assets.md)
|
|
65
|
-
- [工作流与 CI](./repoctl/workflows.md)
|
|
66
|
-
- [报告与自动化输出](./repoctl/reports.md)
|
|
9
|
+
<HomePage locale="zh" />
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# 理解这套系统
|
|
2
|
+
|
|
3
|
+
第一次流程跑通后,再进入 Learn。这里解释 repoctl、monorepo、包、模板和底层工具之间的边界。
|
|
4
|
+
|
|
5
|
+
## 核心概念
|
|
6
|
+
|
|
7
|
+
- [repoctl 如何融入仓库](./repoctl-model)
|
|
8
|
+
- [Monorepo 基础](./monorepo/)
|
|
9
|
+
- [现代 npm 包](./packages/)
|
|
10
|
+
- [模板体系](./monorepo/templates)
|
|
11
|
+
|
|
12
|
+
## 工具
|
|
13
|
+
|
|
14
|
+
[工具专题](/zh/learn/tools/)解释 pnpm、Turborepo、版本管理、hooks、暂存区校验和依赖自动化。
|
|
15
|
+
|
|
16
|
+
## 建议阅读顺序
|
|
17
|
+
|
|
18
|
+
先了解仓库模型,再按需要选择 monorepo 基础或包发布。需要可执行步骤时,回到[任务](/zh/tasks/)章节。
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
repoctl 现在是这套文档的主线。完整命令说明请阅读:
|
|
4
4
|
|
|
5
|
-
- [repoctl 命令速查](
|
|
6
|
-
- [repoctl 模板与创建](
|
|
7
|
-
- [repoctl
|
|
5
|
+
- [repoctl 命令速查](/zh/reference/commands)
|
|
6
|
+
- [repoctl 模板与创建](/zh/reference/templates)
|
|
7
|
+
- [repoctl 排障](/zh/tasks/troubleshooting)
|
|
8
8
|
|
|
9
9
|
## monorepo 知识点:为什么要统一命令入口
|
|
10
10
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
这一页是 repoctl 文档后面的知识库页面。它不再重新解释所有命令参数,而是解释:为什么这些命令能让 monorepo 日常管理变简单。
|
|
4
4
|
|
|
5
|
-
如果你只想查命令,直接看 [
|
|
5
|
+
如果你只想查命令,直接看 [把校验加入 CI](/zh/tasks/ci) 或 [repoctl 命令速查](/zh/reference/commands)。
|
|
6
6
|
|
|
7
7
|
## 先记住默认工作流
|
|
8
8
|
|
|
@@ -237,7 +237,7 @@ pnpm test
|
|
|
237
237
|
|
|
238
238
|
## 继续阅读
|
|
239
239
|
|
|
240
|
-
- [
|
|
241
|
-
- [repoctl 命令速查](
|
|
242
|
-
- [repoctl
|
|
240
|
+
- [把校验加入 CI](/zh/tasks/ci)
|
|
241
|
+
- [repoctl 命令速查](/zh/reference/commands)
|
|
242
|
+
- [repoctl 排障](/zh/tasks/troubleshooting)
|
|
243
243
|
- [发包与变更日志](./publish.md)
|