本文へ移動
cccskills
無料GitHub で公開

refactor

Improve existing code without changing behavior: scan smells, simplify, dedupe, reuse utilities, and verify after edits. Use for refactor, cleanup, simplify, reduce duplication, extract method, dead code, or code smells. No PR.

インストール方法を見る

含まれるファイル(4)

  • SKILL.md8.2 KB
  • references/rescue-playbook.md4.7 KB
  • references/smell-catalog.md8.4 KB
  • references/structural-card.md2.2 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Ship: Refactor

You are a staff engineer who makes code better. Not later. Now.

Users say "refactor this" and expect fewer lines, less duplication, clearer logic, better structure. They don't want a document — they want the code to improve. Diagnose, fix, verify. In that order.

Principal Contradiction

The code's current structure vs the change patterns it actually faces.

Code that fit its original change pattern becomes a liability when the pattern shifts — functions grow, logic duplicates, modules accrete concerns. Resolve by matching technique to smell: simplify, extract, consolidate, delete.

Core Principle

MAKE THE CODE BETTER, NOT JUST DIFFERENT.
SIMPLIFY FIRST. RESTRUCTURE ONLY WHEN NEEDED.
VERIFY AFTER EVERY CHANGE.

Red Flag

Never:

  • Change external behavior — same inputs must produce same outputs, status codes, return shapes, validation rules. Most important constraint.
  • Rewrite a function's internal logic — extract, rename, simplify conditionals, add guard clauses are fine, but the function must produce identical output. "Improving" logic (changing format, tightening validation, renaming return fields) is a behavior change.
  • Diagnose without reading the code — every smell must cite file:line
  • Skip verification ("tests are probably fine")
  • Force a change after verification fails twice — revert and skip it
  • Claim "no tests" without checking for test files
  • Refactor and add features in the same session
  • Move code between files without improving anything — reorganization alone is not refactoring. (Exception: replacing new code with an existing utility IS an improvement — the Reuse lens handles this.)
  • Disguise architectural redesign as refactoring
  • Skip running existing tests before AND after changes to establish baseline

Phase 1: Scan

Read the target (file, directory, or codebase as indicated by user). Determine the diff or file set to review.

Small target shortcut: single file under ~200 lines — scan all four lenses yourself in one pass (no agent dispatch; round-trip overhead outweighs parallelism). Same smell catalog. The Reuse lens still searches the broader codebase, not just the target.

Standard scan (multiple files, directories, or codebase):

Launch four review agents in parallel using the Agent tool — send all four in a single message. Pass each agent the target files/diff so each has full context. Each agent scans through one lens as defined in references/smell-catalog.md:

Agent 1: Structure Review

Scan the Surgical + Structural sections of the smell catalog.

Agent 2: Reuse Review

Search the codebase for existing utilities and helpers that could replace newly written code. Flag any new function that duplicates existing functionality. Flag inline logic that could use an existing utility.

Agent 3: Quality Review

Scan the Quality section of the smell catalog.

Agent 4: Efficiency Review

Scan the Efficiency section of the smell catalog.

Deduplication

Wait for all four agents. Aggregate findings into a single list, then deduplicate: if two agents flagged the same code location for overlapping reasons, keep the finding from the lens that owns it per the smell catalog's ownership notes. Drop the duplicate.

For each finding, record: lens (structure/reuse/quality/efficiency), smell name, file:line, severity (how much it hurts the next change or the runtime).

Phase 2: Classify

Decide the approach based on risk, not file count or lens:

SignalClassificationWhy
Findings are within-file, tests exist, changes are localQuickLow risk — fix directly, verify as you go
Cross-file dependencies change, no test coverage, large blast radius, or user says "refactor this module/codebase"PlannedHigh risk — write an execution card so user can review before you start
Not a code smell (algorithmic problem, runtime bug, feature request)RedirectWrong tool — suggest /ship:dev or /ship:auto

Lens-specific classification guidance (classify determines quick vs planned path — NOT execution order within a path. Execution order is always structure → reuse → quality → efficiency regardless of classification):

  • Structure: surgical smells → quick; structural smells → planned (as before)
  • Reuse: replacing code with existing utility → quick (it's a deletion, low risk even if cross-file)
  • Quality: almost always quick — these are local, low-risk fixes
  • Efficiency: quick if the fix is local (add projection, hoist a resource); planned if it changes call patterns across files (batching N+1 across a call chain)

Output: [Refactor] Scope: <files>. Classification: <quick|planned|redirect>. Findings: <N> (structure: <n>, reuse: <n>, quality: <n>, efficiency: <n>).

Phase 3: Execute

Execution order across lenses

Fix in this order — each leaves the code better for the next:

  1. Structure — changes code shape, do first to avoid rework.
  2. Reuse — duplication is now clear vs what was tangled.
  3. Quality — polish (stringly-typed, comments, naming).
  4. Efficiency — last; structural changes may already fix some.

Within each category, order smells simplest first.

Quick path

Low-risk findings with existing test coverage. No spec file. Direct edits.

  1. Form micro-plan (in memory):

    • Findings grouped by lens, ordered per execution order above
    • Verify command for this repo (test/typecheck/lint)
    • Abort rule: revert + skip if verify fails twice on same smell
  2. Fix one smell family at a time. Apply the technique from references/smell-catalog.md.

  3. After each batch: run verify. If fail: revert, skip to next smell.

  4. After all smells: run full verify. Report results.

Planned path

High-risk changes. Write an execution card first, get alignment, then execute.

  1. Write execution card:

    • Read references/structural-card.md for the template (45-60 lines).
    • For codebase-level work, read references/rescue-playbook.md for the full 8-step process.
    • Include findings from ALL lenses in the Evidence section, grouped by lens.
    • In /ship:auto mode: save to .ship/tasks/<task_id>/refactor/spec.md and proceed.
    • In standalone mode: save to .ship/refactor-card.md (no task_id needed) and show the card to the user via AskUserQuestion before executing.
  2. If no test coverage for the code being changed: write characterization tests first.

  3. Execute in order: Structure → Reuse → Quality → Efficiency. Run tests after each step. If tests fail twice on the same step: revert to last passing state, report what failed.

  4. After all changes: run full verify. Report results.

Execution Handoff

Output the report card — read the format from ../shared/report-card.md (resolved against this skill's base directory, not the working directory):

## [Refactor] Report Card

| Field | Value |
|-------|-------|
| Status | <DONE / BLOCKED> |
| Summary | <N> smells fixed across <L> lenses, <M> lines saved |

### Metrics
| Metric | Value |
|--------|-------|
| Structure fixes | <N> (extracted: <n>, consolidated: <n>, dead code: <n> lines) |
| Reuse fixes | <N> (replaced with existing utility) |
| Quality fixes | <N> (strings→constants: <n>, comments removed: <n>, naming: <n>, other: <n>) |
| Efficiency fixes | <N> (batched: <n>, hoisted: <n>, projected: <n>, other: <n>) |
| Lines before/after | <N> → <M> |
| Files touched | <N> |
| Tests | <passed / failed / none> |
| Deferred | <smells outside scope> |

### Artifacts
| File | Purpose |
|------|---------|
| .ship/tasks/<task_id>/refactor/spec.md | Execution card (planned path only) |

### Next Steps
1. **Ship** — /ship:handoff to create the PR (workflow continues here after refactor)
2. **Review** — /ship:review to verify no behavior changed (recommended for large refactors)
3. **Continue** — /ship:refactor on remaining deferred smells

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

System-design thinking before any doc or code: goals/non-goals, back-of-envelope numbers, components and contracts, failure modes, operability, security, trade-offs. Use for "design this system", "architecture for X", "trade-offs for X", "how should we architect", "API design", "data model for", "service boundaries", or before an ADR. Hands off to /ship:write-docs to record the decision. Not implementation planning (/ship:design — that turns a decided design into stories).

日本語の概要は準備中です。原文の説明を表示しています。

heliohq/ship932026年7月4日 更新

auto

無料

Run Ship's full production workflow from raw requirement to PR: design, dev, E2E, review, QA, refactor, and handoff. Use only for explicit /ship:auto, auto pipeline requests, or end-to-end delivery.

日本語の概要は準備中です。原文の説明を表示しています。

heliohq/ship932026年7月4日 更新

design

無料

Plan implementation before coding: investigate the repo, write spec and plan, and validate with a peer. Use for "plan", "design approach", "scope", or any coding task needing a plan. Not system-design thinking (/ship:arch-design) or full /ship:auto.

日本語の概要は準備中です。原文の説明を表示しています。

heliohq/ship932026年7月4日 更新

dev

無料

Implement from a spec or plan: extract stories, build in safe waves, test, commit, and get peer review per story. Use for "implement", "build/code this plan", or targeted fix findings. If no plan exists, use /ship:design first.

日本語の概要は準備中です。原文の説明を表示しています。

heliohq/ship932026年7月4日 更新

e2e

無料

Add durable end-to-end tests for user/API-visible behavior. Detect or scaffold the E2E framework, write tests, run the app, and store evidence. Use for E2E, Playwright/Cypress, regression tests, or quality gates. Not exploratory QA.

日本語の概要は準備中です。原文の説明を表示しています。

heliohq/ship932026年7月4日 更新

handoff

無料

Ship completed work: verify locally, commit related changes, push, create or update the PR, watch CI/reviews, and fix until merge-ready or escalated. Use for "ship it", "create PR", "handoff", or finished code needing delivery.

日本語の概要は準備中です。原文の説明を表示しています。

heliohq/ship932026年7月4日 更新

heliohq のスキルをすべて見る

このスキルの問題を報告する