diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 000000000..41cb73a3a --- /dev/null +++ b/.codespellrc @@ -0,0 +1,7 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,*.svg,package-lock.json,vendor,*-lock.yaml,*.css,.codespellrc,dist,*.caf,*/a2ui/*,.cache,*.prose,.npm +check-hidden = true +# Ignore camelCase and PascalCase identifiers (common in code) +ignore-regex = \b[a-z]+[A-Z]\w*\b|\b[A-Z][a-z]+[A-Z]\w*\b +ignore-words-list = inout,rouge,statics,caf,afterall,cript,fro,nd,ot,fo diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 000000000..c59e04737 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,25 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/.gitignore b/.gitignore index 9dc547c9c..310d20fd6 100644 --- a/.gitignore +++ b/.gitignore @@ -71,3 +71,4 @@ USER.md # local tooling .serena/ +.npm/ diff --git a/docs/token-use.md b/docs/token-use.md index b15b3a37a..bd26bd539 100644 --- a/docs/token-use.md +++ b/docs/token-use.md @@ -69,7 +69,7 @@ never show dollar cost. Provider prompt caching only applies within the cache TTL window. OpenClaw can optionally run **cache-ttl pruning**: it prunes the session once the cache TTL -has expired, then resets the cache window so subsequent requests can re-use the +has expired, then resets the cache window so subsequent requests can reuse the freshly cached context instead of re-caching the full history. This keeps cache write costs lower when a session goes idle past the TTL. diff --git a/docs/tools/browser.md b/docs/tools/browser.md index ca04ca5ec..45af231fe 100644 --- a/docs/tools/browser.md +++ b/docs/tools/browser.md @@ -410,7 +410,7 @@ Notes: - Role snapshot options (`--interactive`, `--compact`, `--depth`, `--selector`) force a role-based snapshot with refs like `ref=e12`. - `--frame "