mcpField
T
the-art-of-naming

the-art-of-naming

github.com/develite98開発1940 回インストール38 週間前に更新
リポジトリ

the-art-of-naming について

The Art of Namingは、変数、関数、型などのコード要素に名前を付けるためのガイドを提供するコーディングスキルです。一貫性と可読性を求める開発者やチーム向けに、優先度付きの規則と個別ファイルの例をまとめています。

主な機能

  1. 01要素に応じた大文字・小文字規則
  2. 02短く直感的で明確な名前
  3. 03接頭辞と真偽値の命名規則
  4. 04メンバー名で文脈を重複させない
  5. 05動作に応じた関数の動詞選び

活用シーン

  1. 01新しいコード要素の命名
  2. 02命名規則の一貫性レビュー
  3. 03読みやすさを高めるリネーム
  4. 04プロジェクトのlint規則の設定

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/develite98/angular-best-practices --skill the-art-of-naming

インストール後、Claude Code で/the-art-of-namingを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

AGENTS.md
metadata.json
rules/
naming-boolean.md
naming-casing-convention.md
naming-context-duplication.md
naming-function-pattern.md
naming-prefix-convention.md
naming-sid.md
naming-variable-pattern.md

詳細

名前付けの技法

名前を付けるのは難しいものです。このガイドでは、変数、関数、クラス、インターフェースなど、あらゆるものに名前を付けるための体系的な方法を紹介します。コードを自己説明的で、一貫性があり、読みやすいものにできます。

適用するタイミング

以下の場合に、このガイドラインを参照してください。

  • 新しい変数、関数、クラス、インターフェース、または型に名前を付けるとき
  • 名前付けの一貫性についてコードをレビューするとき
  • 読みやすさを高めるためにコードをリファクタリングするとき
  • 新しいプロジェクトにリンティングルールを設定するとき
  • コードベースの規約について新しいチームメンバーをオンボーディングするとき

基本原則

  • S-I-D — すべての名前は簡潔（Short）、直感的（Intuitive）、説明的（Descriptive）である必要があります
  • 短縮形は使わない — onItemClickを使い、onItmClkは使いません
  • 正しい大文字・小文字の使い分け — メンバーにはcamelCase、型にはPascalCase、定数にはUPPER_CASEを使います
  • 意味のある接頭辞 — インターフェースにはI、プライベートメンバーには_、ブール値にはis/has/shouldを使います
  • コンテキストの重複を避ける — MenuItem.handleMenuItemClick()ではなく、MenuItem.handleClick()とします
  • 構造化されたパターン — 変数にはP/HC/LC、関数にはA/HC/LCを使います
  • 適切な動詞を使う — get（同期）、fetch（非同期）、remove（コレクション）、delete（永続的な削除）

優先度別のルールカテゴリー

優先度ルール影響度ファイル
1大文字・小文字の規約CRITICALnaming-casing-convention
2S-I-Dと短縮形を使わないことCRITICALnaming-sid
3接頭辞の規約HIGHnaming-prefix-convention
4ブール値の名前付けHIGHnaming-boolean
5コンテキストの重複HIGHnaming-context-duplication
6関数の名前付け（A/HC/LC）HIGHnaming-function-pattern
7変数の名前付け（P/HC/LC）MEDIUMnaming-variable-pattern

クイックリファレンス

1. 大文字・小文字の規約（CRITICAL）
  • naming-casing-convention - 変数／関数にはcamelCase、クラス／列挙型／型にはPascalCase、エクスポートする定数にはUPPER_CASEを使います
2. S-I-Dと短縮形を使わないこと（CRITICAL）
  • naming-sid - 名前は簡潔、直感的、説明的にします。短縮形は決して使いません
3. 接頭辞の規約（HIGH）
  • naming-prefix-convention - インターフェースにはI、プライベートメンバーには_、ジェネリクスにはT/R/U/V/Kを使います
4. ブール値の名前付け（HIGH）
  • naming-boolean - ブール値にはis/has/should/canを接頭辞として付け、肯定的な名前にします
5. コンテキストの重複（HIGH）
  • naming-context-duplication - メンバー名にクラス名／コンポーネント名を繰り返し含めないでください
6. 関数の名前付け（HIGH）
  • naming-function-pattern - A/HC/LCパターンと適切な動詞（get/set/fetch/remove/delete/compose/handle）を使います
7. 変数の名前付け（MEDIUM）
  • naming-variable-pattern - 構造化された予測しやすい変数名にはP/HC/LCパターンを使います

使い方

詳しい説明とコード例については、個々のルールファイルを読んでください。

rules/naming-casing-convention.md
rules/naming-sid.md
rules/naming-prefix-convention.md
rules/naming-boolean.md
rules/naming-context-duplication.md
rules/naming-function-pattern.md
rules/naming-variable-pattern.md

各ルールファイルには、以下が含まれています。

  • 重要である理由の簡潔な説明
  • 説明付きの不適切なコード例
  • 説明付きの適切なコード例
  • まとめの表と参考資料

コンパイル済みドキュメント全文

すべてのルールを詳しく展開した完全なガイドについては、AGENTS.mdを参照してください。

コメント

Markdown 対応