mirror of
https://fastgit.cc/github.com/openclaw/openclaw
synced 2026-04-22 05:42:22 +08:00
28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
# Scripts Guide
|
|
|
|
This directory owns local tooling, script wrappers, and generated-artifact helper rules.
|
|
|
|
## Wrapper Rules
|
|
|
|
- Prefer existing wrappers over raw tool entrypoints when the repo already has a curated seam.
|
|
- For tests, prefer `scripts/run-vitest.mjs` or the root `pnpm test ...` entrypoints over raw `vitest run` calls.
|
|
- For lint/typecheck flows, prefer `scripts/run-oxlint.mjs` and `scripts/run-tsgo.mjs` when adding or editing package scripts or CI steps that should honor repo-local runtime behavior.
|
|
- For changed-file verification, prefer `scripts/check-changed.mjs` and keep lane classification in `scripts/changed-lanes.mjs`. Do not copy path-scope rules into new hooks or ad hoc CI snippets.
|
|
|
|
## Local Heavy-Check Lock
|
|
|
|
- Respect the local heavy-check lock behavior in `scripts/lib/local-heavy-check-runtime.mjs`.
|
|
- Do not bypass that lock for real heavy commands just to make a local loop look faster.
|
|
- Metadata-only or explicitly narrow commands may skip the lock when the existing helper logic says that is safe.
|
|
- If you change the lock heuristics, add or update the narrow tests under `test/scripts/`.
|
|
|
|
## Generated Outputs
|
|
|
|
- If a script writes generated artifacts, keep the source-of-truth generator, the package script, and the matching verification/check command aligned.
|
|
- Prefer additive generator/check pairs like `*:gen` and `*:check` over one-off undocumented scripts.
|
|
|
|
## Scope
|
|
|
|
- Keep script-runner behavior, wrapper expectations, and generated-artifact guidance here.
|
|
- Leave repo-global verification policy in the root `AGENTS.md`.
|