القائمة
Essential rules and methods you must follow when refactoring code. Use when this capability is needed.
يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.
اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.
استنادا إلى تصنيف SOC المهني
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.
npx skills add https://github.com/tomevault-io/skills-registry --skill unspaghettify-your-codeيبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.
تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.
عرض SKILL.md
| Use when this capability is needed.
> Use when this capability is needed.
Review architecture and API design for the vfs-s3 project. Use when the user mentions @architect, asks to review an issue's design, discuss module boundaries, API shape, or architectural decisions for vfs-s3. Also trigger when the user wants to create an ADR (Architecture Decision Record) or evaluate a technical approach for the project. Intended for dispatch from Codex automation or Claude routines; GitHub trigger phrase: @vfs-s3-bot please prepare design doc Use when this capability is needed.
| name | unspaghettify-your-code |
| description | Essential rules and methods you must follow when refactoring code. Use when this capability is needed. |
| metadata | {"author":"dj-oyu"} |
エージェントスキル: 成熟したコードを3層アーキテクチャにリファクタリングする
原則: "Premature optimization is the root of all evil" (早すぎる最適化は諸悪の根源)
以下のすべてを満たす場合:
原則: "Make it work, make it right, make it fast"
| 指標 | しきい値 | アクション |
|---|---|---|
| ファイル行数 | > 500行 | 分割を検討 |
| 関数行数 | > 100行 | 分割を検討 |
| 関数内の責務 | 3つ以上 | 分離を検討 |
| 重複コード | 3箇所以上 | 抽象化を検討 |
┌─────────────────────────────────────────┐
│ Layer 3: Application Layer │
│ - main(), CLI parsing, signal handling │
│ - 責務: ライフサイクル管理 │
│ - サイズ: ~100行 │
└─────────────────────────────────────────┘
↓
┌─────────────────────────────────────────┐
│ Layer 2: Pipeline/Business Logic │
│ - ワークフロー統合、データフロー │
│ - 責務: 複数のHALを組み合わせた処理 │
│ - サイズ: ~200-300行/ファイル │
└─────────────────────────────────────────┘
↓
┌─────────────────────────────────────────┐
│ Layer 1: Hardware Abstraction (HAL) │
│ - ハードウェアAPI の薄いラッパー │
│ - 責務: 単一ハードウェアの操作 │
│ - サイズ: ~200-300行/ファイル │
└─────────────────────────────────────────┘
DO (推奨):
DON'T (禁止):
サンプル (今回の実装):
// vio_lowlevel.h - VIO HAL
int vio_create(vio_context_t *ctx, int camera_index, ...);
int vio_start(vio_context_t *ctx);
int vio_get_frame(vio_context_t *ctx, hbn_vnode_image_t *frame, int timeout_ms);
void vio_destroy(vio_context_t *ctx);
DO (推奨):
DON'T (禁止):
サンプル (今回の実装):
// camera_pipeline.h - VIO + Encoder統合
typedef struct {
vio_context_t vio; // HAL層を利用
encoder_context_t encoder; // HAL層を利用
SharedFrameBuffer *shm_h264;
volatile bool *running_flag;
} camera_pipeline_t;
int pipeline_run(camera_pipeline_t *pipeline, volatile bool *running_flag);
DO (推奨):
DON'T (禁止):
サンプル (今回の実装):
// camera_daemon_main.c
int main(int argc, char *argv[]) {
// 1. Parse arguments
// 2. Signal handling
// 3. Create pipeline (Pipeline層を利用)
// 4. Start pipeline
// 5. Run pipeline
// 6. Cleanup
}
| 層 | パターン | 例 |
|---|---|---|
| HAL | {hardware}_lowlevel.c/h | vio_lowlevel.c, encoder_lowlevel.c |
| Pipeline | {domain}_pipeline.c/h | camera_pipeline.c |
| Application | {app}_main.c | camera_daemon_main.c |
| 層 | パターン | 例 |
|---|---|---|
| HAL | {hardware}_{verb}() | vio_create(), encoder_encode_frame() |
| Pipeline | pipeline_{verb}() | pipeline_run(), pipeline_create() |
要件:
実装: logger.c/h
使い方:
#include "logger.h"
// 初期化 (main関数で1回)
log_init(LOG_LEVEL_INFO, stdout, 0);
// 各モジュールで使用
LOG_INFO("VIO", "Pipeline created successfully");
LOG_ERROR("Encoder", "hb_mm_mc_configure failed: %d", ret);
推奨:
printf/fprintf の代わりにLOG_*マクロを使う禁止:
printfでエラーを出力しない (LOG_ERRORを使う)既存コードの理解
境界の特定
1つのハードウェアに集中
最小限のAPIを設計
既存コードから抽出
テスト
ワークフローを特定
HAL層を組み合わせる
テスト
main()をシンプルに
テスト
| 項目 | 制限 | 対処 |
|---|---|---|
| H.264 Bitrate | <= 700 kbps | デフォルト600kbps推奨 |
| Camera Index | 0 or 1 | Camera 0→MIPI Host 0, Camera 1→MIPI Host 2 |
| bus_select | 常に0 | 両カメラで0を使用 |
VIO (Low-level):
hbn_camera_create() - カメラ初期化hbn_vnode_open() - VIN/ISP/VSEノード作成hbn_vflow_bind_vnode() - パイプライン接続hbn_vnode_getframe() - フレーム取得Encoder (Low-level):
hb_mm_mc_initialize() - エンコーダー初期化hb_mm_mc_configure() - エンコーダー設定hb_mm_mc_start() - エンコーダー起動hb_mm_mc_queue_input_buffer() - NV12入力hb_mm_mc_dequeue_output_buffer() - H.264出力必須ライブラリ:
LDLIBS := -lrt -lpthread -lcam -lvpf -lhbmem -lmultimedia
ヘッダーインクルード:
#include "hb_camera_interface.h"
#include "hb_camera_data_config.h"
#include "hbn_api.h"
#include "hb_media_codec.h"
#include "hb_mem_mgr.h"
リファクタリングが成功したかの判断基準:
User: "camera_daemon_drobotics.c (886行) をリファクタリングしたい"
Agent:
1. まず判断基準を確認します
- 要件は固まっていますか？
- 動作検証は済んでいますか？
- 保守・拡張の予定はありますか？
2. (条件を満たす場合) Phase 1: 分析
- ファイルを読み、責務を列挙
- HAL層候補を特定
3. Phase 2-4: 実装
- HAL層を抽出
- Pipeline層を作成
- Application層を簡素化
4. 検証
- パフォーマンステスト
- 動作確認
エージェントは以下の状況で自動的にリファクタリングを提案します:
提案形式:
"このファイルは{行数}行で、{責務1}と{責務2}が混在しています。
3層アーキテクチャにリファクタリングすることで:
- 各ファイルが{予想行数}行程度に収まる
- テスタビリティが向上する
- 保守性が向上する
リファクタリングを実施しますか？"
NG例:
// たった50行の単純なスクリプトを3層に分割
// → 過度な複雑化、メンテナンスコストが上がるだけ
正解: 小さくシンプルなコードはそのまま残す
NG例:
// 1箇所でしか使わない処理をわざわざ関数化
AbstractFactoryBuilder* builder = createAbstractFactoryBuilder();
// → YAGNI違反
正解: 3箇所以上で重複してから抽象化を検討
NG例:
// getter/setterだけのファイル
// utils.c に何でも詰め込む
// → 責務が不明確
正解: 明確な責務を持つ単位で分割
camera_poc_lowlevel.c - 639行→ リファクタリング決定
vio_lowlevel.c/h - 334行 (HAL)encoder_lowlevel.c/h - 203行 (HAL)camera_pipeline.c/h - 217行 (Pipeline)camera_daemon_main.c - 177行 (Application)logger.c/h - 106行 (Infrastructure)合計: 1037行 (PoC 639行から400行増)
トレードオフ:
結果:
リファクタリングの金言:
"Make it work, make it right, make it fast"
まず動かせ。次に正しくしろ。最後に速くしろ。
リファクタリングすべきタイミング:
要件が固まり、動作が確認でき、長期保守が必要になったとき。 それまでは、汚くても素早く回せ。
Converted and distributed by TomeVault — claim your Tome and manage your conversions.