typescript-coding-standards について
フロントエンド、バックエンド、Worker、共有ライブラリの変更に向けた、TypeScript のコーディングスキルです。リポジトリ固有の指示を優先し、作業に応じたガイドを参照します。
主な機能
- 01リポジトリ固有の指示確認
- 02作業別のコーディングガイド
- 03フロントエンドとバックエンドの規約
- 04変更範囲の管理
活用シーン
- 01TypeScript の作成やレビュー
- 02関数や型のリファクタリング
- 03依存関係やモジュールの変更
- 04コードやテストの検証
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ berachain/ skills --skill typescript-coding-standardsインストール後、Claude Code で/typescript-coding-standardsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
rules/comments.mddependencies.mdfile-naming-and-size.mdmodules.mdreact.mdruntime.mdtesting.mdtooling.mdtypescript.md詳細
TypeScript コーディング規約
フロントエンドアプリ、バックエンドサービス、ワーカー、共有ライブラリで TypeScript を記述、レビュー、またはリファクタリングする際は、これらの規約を適用してください。
最初に、対象リポジトリの AGENTS.md、パッケージスクリプト、リンター/テストの設定を確認してください。明示されたローカル要件は、これらの共通デフォルトに優先します。変更は依頼された範囲内にとどめてください。既存の違反があっても、無関係なリポジトリ全体の移行を行う理由にはなりません。
ガイド
編集する前に、変更に関連するガイドを読んでください。
| ガイド | 読むタイミング |
|---|---|
| TypeScript の契約 | 関数、引数、型、定数を記述またはレビューするとき。 |
| ファイルの命名とサイズ | ファイルを作成、名前変更、分割するとき。 |
| コメントと JSDoc | 関数、型、または自明でないロジックを文書化するとき。 |
| モジュールと構成 | エクスポート、インポートの境界、コードの配置場所を決めるとき。 |
| 依存関係とカタログ | 依存関係、パッケージマニフェスト、カタログ、ロックファイルを追加または更新するとき。 |
| ランタイムの動作 | エラー、外部データ、サービス依存関係、バックエンドのインポート境界を扱うとき。 |
| React と Next.js | コンポーネント、コールバック、フックを変更するとき。Next.js のセクションは Next.js アプリでのみ読んでください。 |
| テスト | テストが有用か判断するとき、カバレッジを追加するとき、アサーションをレビューするとき。 |
| ツールと検証 | ツールを選択するとき、またはコード変更を検証するとき。 |
バックエンドのみの作業では、React ガイドは読み飛ばしてください。利用側の既存のツールとランタイムの規約を使用してください。このスキルでは、別のリポジトリのフレームワーク、フォーマッター、依存関係を採用する必要はありません。
コメント
Markdown 対応