Agent Skills › dzhng/jevgrep › ratchet-files

ratchet-files

GitHub

自动检测并拆分超大源代码文件,确保单文件在代理读取预算内。支持按概念拆分、配置预提交钩子及设置忽略规则,解决因文件过大导致的开发阻塞问题。

.agents/skills/ratchet-files/SKILL.md dzhng/jevgrep

Trigger Scenarios

文件超过大小预算导致提交被阻止 需要查找或拆分过大的‘上帝类’文件 请求添加文件大小限制或钩子

Install

npx skills add dzhng/jevgrep --skill ratchet-files -g -y
More Options

Non-standard path

npx skills add https://github.com/dzhng/jevgrep/tree/main/.agents/skills/ratchet-files -g -y

Use without installing

npx skills use dzhng/jevgrep@ratchet-files

指定 Agent (Claude Code)

npx skills add dzhng/jevgrep --skill ratchet-files -a claude-code -g -y

安装 repo 全部 skill

npx skills add dzhng/jevgrep --all -g -y

预览 repo 内 skill

npx skills add dzhng/jevgrep --list

SKILL.md

Frontmatter
{
    "name": "ratchet-files",
    "description": "Ratchet source file size so every file stays small enough for an agent to read whole: find every file over a token budget, split oversized files by concept, and set up the pre-commit ratchet that stops them from growing. Use when a commit is blocked because a file is over the size budget, when asked to find or split oversized\/long\/god files, when a file you need to change is too large to read in one pass, or when asked to add a file-size limit or hook to a repository or repair commit-hook coverage across worktrees."
}

Ratchet Files

A source file is over budget when it is past what an agent can read in one pass (8,000 tokens, counted as bytes / 4, unless the repository sets another). scripts/check-file-size.mjs owns what counts as source, the budget, the ratchet, and the split rules; run it with --help before anything else.

Splitting

  1. Run the script with --all from the repository root, passing the repository's --max-tokens if its hook sets one. Its list is the backlog.
  2. Pick the files to split: the one blocking the work in front of you, or with no blocker, the largest ones a change is about to touch.
  3. Split each one by the rules the script prints. A seam is a concept the file already owns, not a line count; when refactor-clean is installed, use it to find them.
  4. Prove the split changed no behaviour with the repository's own checks, and commit it alone, before the change that needed the room.

A file whose every split would cost more than it saves (one table or state machine that only reads whole) may opt out instead. Put @ratchet-files-ignore in a comment within its first 10 lines, in the file's own comment syntax, followed by why splitting fails:

// @ratchet-files-ignore: one opcode table; split, each half reads without the other.

The check then skips the file entirely, even as it grows, so opt out only after looking for a seam and finding none worth its cost, never to get past a refusal. Tell the user each file you opt out and why. --all counts opted-out files so they stay visible.

Done when every file you picked is under budget in its own commit, the behaviour checks pass, and --all no longer lists those files.

Setting up the ratchet

Never install the hook without the user's explicit yes, even when they asked to set up the repository. Installing it freezes every file already over budget, so audit first and leave the repository untouched while you do:

  1. Copy the script to a scratch directory outside the repository, run npm install --prefix <scratch> linguist-languages there, and run node <scratch>/check-file-size.mjs --all from the repository root (Node 18.3 or later). The script finds the package beside itself when the repository lacks it.
  2. Ask once, with everything the user is agreeing to: how many files the hook would freeze and which are largest, leaving out generated or vendored ones you will mark below (name those); the budget, 8,000 tokens unless they want another; and which pre-commit runner you will wire it into, including any you would add. In a repository without Node tooling, say the check adds it.

Once they agree, set up everything the check needs:

  • Script. The hook runs a copy committed in the repository, so every clone runs the same check. If this skill folder is committed in the repository, point the hook at its scripts/check-file-size.mjs; otherwise copy that file to where the repository keeps its tool scripts (scripts/ if it has none). The entries below use scripts/check-file-size.mjs; substitute the real path.

  • Dependency. Add linguist-languages at an exact version as a dev dependency of the repository's root package.json, with the package manager its lockfile names, or npm if there is none. The check needs Node even in a repository written in another language: with no package.json, create one at the root holding only "private": true and what this setup adds, and make sure .gitignore covers node_modules/. Choose dependency versions compatible with the repository's supported runtime; the check script's minimum Node version does not establish the runner's minimum.

  • Hook. Run the script on every staged file with node (or bun where the repository already runs its tools with it), appending --max-tokens N for a budget other than the default. Add it beside the existing entries of the pre-commit runner the repository already has:

    Runner Where Entry
    lint-staged its config "*": "node scripts/check-file-size.mjs"
    lefthook pre-commit.commands run: node scripts/check-file-size.mjs {staged_files}
    pre-commit .pre-commit-config.yaml, repo: local id: ratchet-files, name: source file size, entry: node scripts/check-file-size.mjs, language: system
    husky or a plain hook the pre-commit script git diff --cached --name-only -z | xargs -0 node scripts/check-file-size.mjs

    Inspect git config --show-origin --get core.hooksPath and the existing hooks first. The config is normally shared while a relative path resolves per checkout, so Husky's .husky/_ exists only where the package install ran and every other worktree commits unchecked. Keep an existing runner only if it installs into linked worktrees too.

    Otherwise add lint-staged as an exact dev dependency and call scripts/install-git-hooks.mjs from the root package's prepare script, after any existing prepare work. Use this skill's copy if the skill is committed in the repository, else commit an unchanged copy beside the repository's tool scripts; never point at a global skill path. It installs one hook in the shared hooks directory that runs the committing checkout's own lint-staged, refuses a checkout without dependencies with its lockfile's install command, and leaves custom hooks alone. Each committing worktree needs its own install; never share another checkout's dependencies or build output to provide them. If its logic must change, extend node --test scripts/install-git-hooks.test.mjs from this skill to cover it.

    When replacing a repository-owned runner such as Husky, move its other checks into lint-staged and remove its setup and dependency so no installer competes; never unset a user's own hooks path. Installing an older branch can still re-enable the old runner until a current branch installs again. Inspect any conflict the installer reports before going on.

  • Exclusions. Mark generated and vendored code linguist-generated or linguist-vendored in .gitattributes instead of adding skip lists. The script reads the staged .gitattributes, so stage it before rerunning --all.

  • Docs. Document the budget, the opt-out pragma, how package installation enables hooks across worktrees, that each committing checkout needs dependencies, and any replaced runner an older branch can re-enable, where the repository documents its other hooks; failing that, in a section of its README, creating one if needed.

Commit the setup through the new hook, without --no-verify.

Verify with real git commit attempts in disposable repository fixtures, using the committed installer, runner configuration, and size-check script. Install once, then create a linked worktree without rerunning installation there. Make its dependencies available and prove its own staged oversized new file is refused with the split rules while an under-budget commit succeeds and the main checkout stays unchanged. Also prove an existing oversized file cannot grow, a checkout without dependencies refuses with setup instructions, repeated installation from a linked worktree works, and custom hooks survive installation. Remove the fixtures afterwards.

Done when these commit checks pass in both checkout types and the setup commit passed the new hook without bypassing it.

Version History

  • 3dca47a Current 2026-11-02 09:26

Same Skill Collection

.agents/skills/audit-agents/SKILL.md
.agents/skills/audit-performance/SKILL.md
.agents/skills/audit-tests/SKILL.md
.agents/skills/auto-research/SKILL.md
.agents/skills/claude/SKILL.md
.agents/skills/code-review/SKILL.md
.agents/skills/codex/SKILL.md
.agents/skills/compare-screenshots/SKILL.md
.agents/skills/design-with-images/SKILL.md
.agents/skills/eli5/SKILL.md
.agents/skills/eval-skills/SKILL.md
.agents/skills/handoff-spec/SKILL.md
.agents/skills/implement-spec-with-codex/SKILL.md
.agents/skills/implement-spec/SKILL.md
.agents/skills/jevgrep/SKILL.md
.agents/skills/launch-video/SKILL.md
.agents/skills/marketing-pages/SKILL.md
.agents/skills/port-features/SKILL.md
.agents/skills/preview-shots/SKILL.md
.agents/skills/refactor-clean/SKILL.md
.agents/skills/review/SKILL.md
.agents/skills/screenshot-critique/SKILL.md
.agents/skills/write-docs/SKILL.md
.agents/skills/write-skills/SKILL.md
.agents/skills/write-tests/SKILL.md
skills/jevgrep/SKILL.md
.agents/skills/audit-choices/SKILL.md
.agents/skills/audit-decisions/SKILL.md
.agents/skills/close-spec/SKILL.md
.agents/skills/explore-unknowns/SKILL.md
.agents/skills/typesafe-ai/SKILL.md
.agents/skills/write-spec/SKILL.md

Metadata

Files
0
Version
3dca47a
Hash
3814d3ae
Indexed
2026-11-02 09:26

trang chủ - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-11-03 02:26
浙ICP备14020137号-1