mirror of https://github.com/openclaw/openclaw.git synced 2026-07-15 10:06:03 +00:00

Files

Peter Steinberger ae12413ee2 chore(tooling): enforce no-floating-promises and drop DOM globals from Node-side typechecking (#104422 )

* chore(lint): enforce no-floating-promises repo-wide

* feat(tooling): split DOM globals out of the Node-side typecheck program

tsconfig.core.json now compiles src/ + packages/ with lib ES2023; new
tsconfig.ui.json owns ui/ with DOM. Web-global names used by Node code
alias to canonical undici/stream-web types; highlight.js loads through a
validated narrow API because its d.ts force-includes lib.dom. Boundary,
sparse-guard, changed-lane routing, and profile lanes cover the new ui
graph.

* chore(deps): declare undici-types and teach knip about the highlight.js runtime require

* ci: retrigger dropped pull_request synchronize event

* refactor(types): derive web-global aliases from @types/node fetch globals, drop undici-types dep

* ci: retrigger after dependency guard cleared

* fix(scripts): add ui lane to changed-lanes declaration union

2026-07-11 07:28:20 -07:00

2.3 KiB

Raw Blame History

OpenClaw Codebase Patterns

Always reuse existing code - no redundancy!

Tech Stack

Runtime: Node 22+ (Bun also supported for dev/scripts)
Language: TypeScript (ESM, strict mode)
Package Manager: pnpm (keep pnpm-lock.yaml in sync)
Lint/Format: Oxlint, Oxfmt (pnpm check)
Tests: Vitest with V8 coverage
CLI Framework: Commander + clack/prompts
Build: tsdown (outputs to dist/)

Anti-Redundancy Rules

Avoid files that just re-export from another file. Import directly from the original source.
If a function already exists, import it - do NOT create a duplicate in another file.
Before creating any formatter, utility, or helper, search for existing implementations first.

Source of Truth Locations

Formatting Utilities (`src/infra/`)

Time formatting: src\infra\format-time

NEVER create local formatAge, formatDuration, formatElapsedTime functions - import from centralized modules.

Terminal Output (`src/terminal/`)

Tables: src/terminal/table.ts (renderTable)
Themes/colors: src/terminal/theme.ts (theme.success, theme.muted, etc.)
Progress: src/cli/progress.ts (spinners, progress bars)

CLI Patterns

CLI option wiring: src/cli/
Commands: src/commands/
Dependency injection via createDefaultDeps

Import Conventions

Use .js extension for cross-package imports (ESM)
Direct imports only - no re-export wrapper files
Types: import type { X } for type-only imports

Code Quality

TypeScript (ESM), strict typing, avoid any
Keep files under ~700 LOC - extract helpers when larger
Colocated tests: *.test.ts next to source files
Run pnpm check before commits (production type check + lint + format)
Run pnpm check:test-types when you need test type coverage, or pnpm tsgo:all for a full production plus test type sweep

Stack & Commands

Package manager: pnpm (pnpm install)
Dev: pnpm openclaw ... or pnpm dev
Type-check: pnpm tsgo (core production), pnpm tsgo:prod (core + UI + extension production), pnpm check:test-types (tests)
Lint/format: pnpm check
Tests: pnpm test
Build: pnpm build

If you are coding together with a human, do NOT use scripts/committer, but git directly and run the above commands manually to ensure quality.

2.3 KiB Raw Blame History