
single-file-topdown-ordering
by iplaylf2
Personal coding profile kit for reusable defaults and setup
SKILL.md
name: single-file-topdown-ordering description: 'Use when a single file is difficult to understand top-down because the public surface is buried or definitions appear before the behavior they support. Goal: restore a clear reading flow without changing semantics.' metadata: short-description: Read top-down
Code Ordering
Restore a top-down narrative inside a single file: start from the public surface, then unfold supporting details.
Core Rule
Blocks that depend on other blocks appear earlier. Their dependencies appear later.
Only reorder when language semantics remain correct.
Block Scope
Blocks are structural units such as exported/public declarations, classes, functions/methods, and relevant type definitions. Imports and module-level conventions stay untouched.
Dependency Detection
For a block, collect dependencies in this order:
- Signature dependencies: types and interfaces referenced by the declaration.
- Body dependencies: symbols required by the implementation, ordered by semantic execution and control flow.
Ordering Process
Treat the file as breadth-first expansion from public entry blocks.
-
Collect exported/public entry blocks.
-
Sort entry blocks by dependency-after: if an entry block depends on another entry block, place the dependent first. If no ordering is implied, keep original order.
-
Repeat the following layer step until no new blocks are discovered:
- Scan every block in the current layer and collect dependencies using Dependency Detection.
- Remove blocks already placed and anything out of scope.
- The remaining blocks become the next layer, preserving first-encounter order across the scan.
- Append the next layer after the current layer.
Cycles
Cycles are common. Keep best-effort ordering and treat a cycle as a single group during layering.
Warn only when the cycle prevents a stable, semantics-preserving top-down order. Otherwise, do not warn.
Review Checklist
- Public surface appears before supporting details.
- A block appears before the blocks it depends on whenever a valid order exists.
- Signature dependencies are introduced before body dependencies for the same dependent.
- The result reads top-down without changing behavior.
Score
Total Score
Based on repository quality metrics
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
1ヶ月以内に更新
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
Reviews
Reviews coming soon
