Squashed 'docs/standards/playbook/' changes from c3f8137..25d895d
25d895d 🐛 fix(gitea_workflow): clean up temp repos after job steps 2bc3b11 🐛 fix(gitea_workflow): clean up temporary repo dirs in workflows 98c3f30 📝 docs(agent_rules): allow plan execution on current branch 16c7230 📝 docs(prompts): define custom verify layering 8efc4dd 🐛 fix(skills): quote commit-message description bc8498f 🐛 fix(ci): install tomli for gitea tests 55cda3b 🐛 fix(tests): report missing toml parser clearly c0729c7 🐛 fix(playbook): import Optional for cli compatibility 63e24bf 📦 deps(skills): sync thirdparty skills d2f9356 🐛 fix(ci): isolate gitea workflow repos 588b81d 🐛 fix(ci): inline gitea workflow bootstrap e0b1c3a ♻️ refactor(skills): standardize first-party skill contracts 2c5050d ♻️ refactor(skills): rename repo skills source dir f049dfb 📦 deps(skills): drop duplicate first-party superpowers skills 234b335 ✨ feat(workflow): add superpowers planning and execution state tracking c1702a6 📝 docs(markdown): format tracked markdown and drop stale templates 2325409 📝 docs(markdown): clarify optional markdownlint usage 214c44e 🔧 chore(markdown): add markdownlint baseline and lint fixes a22b324 📝 docs(templates): add execution and memory-bank prompt templates 223a797 📝 docs(templates): update README for Claude Code and current features 4ac8672 📝 docs: simplify README + platform-agnostic tools + auto-create local rules 2431c9d 📝 docs: add claude_md config and use cross-platform paths d64b248 📝 docs: fix README.md inaccuracies and add Claude Code info c8d6bf2 🐛 fix(playbook): use relative paths in CLAUDE.md when not at project root 6518f0f ✨ feat(playbook): auto-create CLAUDE.md with path discovery 6ec9a45 ✨ feat(skills): add skill_link symlink support + platform-agnostic prompt 9f8b6b5 📝 docs: update README and config example for Claude Code support 79cff6c 📝 docs(skills): add Claude Code platform support 452c6f5 ✨ feat(playbook): auto-inject AGENTS.md into CLAUDE.md e1dbf3c 🐛 fix(skills): remove dual-path from commit-message skill f3a7259 🔧 chore(ci): use prepare_repo.sh in both workflows da08212 🔧 chore(ci): extract prepare_repo.sh and clean up workflows 7ade85e 🗑️ remove(tsl): drop syntax_book/, data/ source and build script f94dba0 ♻️ refactor(skills): update playbook.py and tests for thirdparty/ layout b3df412 ♻️ refactor(skills): separate thirdparty skills into thirdparty/ subdirectory 64950e7 📦 deps(skills): sync thirdparty skills a2e3cb0 ✨ feat(playbook): add no_backup deploy controls 8609d59 🐛 fix(docs): repair reference catalog source links 956da11 🐛 fix(playbook): publish hidden ci test fixes 3f67754 📦 deps(skills): sync thirdparty skills 08ca87b 📦 deps(skills): add karpathy thirdparty sync 96b705b 📝 docs(tsl): rebuild canonical syntax and routing manual 3ed5052 📦 deps(skills): sync thirdparty skills 60108dd 📦 deps(skills): sync thirdparty skills da85d4e 🐛 fix(thirdparty): prune nested project snapshots a2a697e 📦 deps(skills): sync thirdparty skills 9df610a 🐛 fix(thirdparty): exclude duplicated superpowers skills 33dd5bb 🐛 fix(thirdparty): preserve optional manifest fields 91b0ea7 🐛 fix(thirdparty): preserve manifest during snapshot update 2e26f98 🔧 chore(thirdparty): generalize skills sync pipeline 5b9c1e3 📦 deps(skills): sync superpowers 2f2d34a 📝 docs(readme): normalize subtree command spacing 62db7db 🐛 fix(ci): serialize superpowers update and sync 3463223 🐛 fix(ci): use literal superpowers sync paths 48f6de8 📦 deps(skills): sync superpowers 4b23529 🔧 chore(ci): merge superpowers update and sync workflow a56d75b 📦 deps(skills): sync superpowers 84bcefa 🔧 chore(ci): use ci[bot] commit author name 00a07e5 📦 deps(skills): sync superpowers 7b84daf 🐛 fix(templates): enforce main loop progress tracking 51373d7 🔧 chore(ci): automate superpowers sync workflow eaaa39c 🐛 fix(ci): prevent stale superpowers sync from restoring skills block 79755c6 📦 deps(skills): sync superpowers 836d878 📦 deps(skills): sync superpowers 8216c9f 📦 deps(skills): sync superpowers 9439505 🐛 fix(playbook): address reported repo issues git-subtree-dir: docs/standards/playbook git-subtree-split: 25d895d8b3f56624ccfe99ad7289e9eb49e0f316
This commit is contained in:
@@ -0,0 +1,107 @@
|
||||
---
|
||||
name: style-cleanup
|
||||
description: Use when the user asks to format code, fix lint issues, or align style with the repository's existing toolchain without changing behavior.
|
||||
---
|
||||
|
||||
# Style Cleanup Workflow（整理代码风格 / 格式化）
|
||||
|
||||
## Overview
|
||||
|
||||
Apply the repository's existing formatter and lint toolchain without changing
|
||||
behavior. Core principle: trust repo truth, keep scope tight, and verify with a
|
||||
rerun.
|
||||
|
||||
## When to Use
|
||||
|
||||
- The user asks for formatting, `fmt`, `format`, or lint cleanup
|
||||
- A code change is done and needs a final style pass before review or commit
|
||||
- A mechanical change produced noisy diff that should be normalized by the repo's
|
||||
existing toolchain
|
||||
|
||||
## When Not to Use
|
||||
|
||||
- This is not for semantic refactors or behavior changes
|
||||
- This is not for introducing a new formatter or lint configuration
|
||||
- This is not for full-repo reformatting unless the user explicitly requests that
|
||||
scope
|
||||
|
||||
## Inputs
|
||||
|
||||
- Target scope: staged files, unstaged files, explicit file list, or explicit
|
||||
directory
|
||||
- Relevant languages in scope
|
||||
- Verification commands available in the repository
|
||||
|
||||
## Procedure
|
||||
|
||||
1. **Baseline the scope**
|
||||
|
||||
- Record `git status --short`.
|
||||
- Default to changed files only unless the user requested broader scope.
|
||||
- Resolve the target file set before running any formatter.
|
||||
|
||||
2. **Detect the repo toolchain**
|
||||
|
||||
- Prefer repository scripts and checked-in config over ad hoc commands.
|
||||
- Use the repo's existing formatter/linter stack:
|
||||
- JS/TS: `package.json`, prettier, biome, eslint
|
||||
- Python: `pyproject.toml`, `isort`, `black`, `ruff`, `flake8`,
|
||||
`pre-commit`
|
||||
- C/C++: `.clang-format`, optional `.clang-tidy`
|
||||
- Shell: `shfmt`, `shellcheck` if already present
|
||||
- Markdown: prettier/markdownlint only if the repo already uses them
|
||||
|
||||
3. **Run cleanup in a fixed loop**
|
||||
|
||||
- Use `formatter -> lint/check -> lint --fix -> final check`.
|
||||
- Prefer repository entrypoints over raw tool invocations.
|
||||
- Keep execution scoped to the chosen files whenever the toolchain supports it.
|
||||
|
||||
4. **Control blast radius**
|
||||
|
||||
- If the formatter expands the diff far beyond the requested scope, stop and
|
||||
explain the tradeoff.
|
||||
- Offer a scoped pass vs. a full-repo normalization pass instead of silently
|
||||
widening scope.
|
||||
|
||||
5. **Verify**
|
||||
|
||||
- Re-run the lightweight checks after fixes.
|
||||
- Confirm that the second formatter run produces no additional diff.
|
||||
- If the repo has a canonical lint or test command for style verification, run
|
||||
that command and report the result.
|
||||
|
||||
## Playbook as Authority
|
||||
|
||||
When the target repo vendors this playbook, prefer these references for style
|
||||
judgment:
|
||||
|
||||
- TSL: `docs/tsl/code_style.md`, `docs/tsl/naming.md`, `docs/tsl/toolchain.md`
|
||||
- C++: `docs/cpp/code_style.md`, `docs/cpp/naming.md`, `docs/cpp/toolchain.md`
|
||||
- Python: `docs/python/style_guide.md`, `docs/python/tooling.md`,
|
||||
`docs/python/configuration.md`
|
||||
|
||||
## Output Contract
|
||||
|
||||
- `Scope:` actual files/directories/languages processed
|
||||
- `Toolchain:` repo configs and commands used
|
||||
- `Commands:` execution order
|
||||
- `Changes:` modified files plus diff-size summary
|
||||
- `Remaining:` unresolved lint/style issues plus why they remain
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Style cleanup stays within the requested or agreed scope
|
||||
- The second formatter run produces no additional diff
|
||||
- Verification commands pass, or any remaining exception is explicitly explained
|
||||
- No semantic behavior change is introduced
|
||||
|
||||
## Failure Handling
|
||||
|
||||
- If the repo lacks a formatter/linter, say so and fall back to minimal manual
|
||||
cleanup only with clear limits
|
||||
- If tools are missing locally, report the missing dependency and stop before
|
||||
inventing a new toolchain
|
||||
- If two configured tools conflict, follow checked-in repo config and surface the
|
||||
conflict instead of papering over it
|
||||
- If cleanup would require wider scope than requested, stop and ask for approval
|
||||
Reference in New Issue
Block a user