メインコンテンツへスキップ
ルールライブラリは、すぐに使える Kody Rules のカタログで、トピックごとのパックにまとめられています。ルールを追加すると、自分のルールにコピーされ、他のルールと同じように編集、一時停止、削除できます。

ライブラリを開く

  • Code review → Kody Rules の Review Rules タブで、Discovery をクリックします。
  • ルール一覧が空の場合は、Browse the library をクリックします。一覧には、出発点となるライブラリのルールも 3 つ表示されます。
  • ⌘K コマンドパレットで Rules library を検索します。
パンくずリスト Kody Rules → Rules Library から、元のルールページに戻れます。

ルールを探す

ライブラリには、左側のナビゲーションに Featured と Browse の 2 つのビューがあります。
  • Featured: Recommended for you は、接続済みのリポジトリで Kody が最近指摘した内容に関連するライブラリのルールを提案します(Refresh で再読み込み)。続いて Plug and play コレクションといくつかのパックが表示されます。
  • Browse: すべてのルールを 48 件ずつ表示します(残りは Load more)。
Search rules… に入力すると Browse に切り替わります。Browse では、次の条件で絞り込めます。 Browse は、Kodus がチームの言語を把握している場合、その言語で絞り込まれた状態で開きます。解除するには Language で All を選択します。Reset で、設定したフィルターをクリアします。

パック

パックは、セキュリティ強化、テスト、オブザーバビリティ、アクセシビリティ、コンプライアンス(GDPR、HIPAA、SOC 2、PCI DSS、LGPD)、スタック(React、Next.js、Vue、Node.js、Python、PHP、Flutter)など、1 つのトピックに関するルールのセットです。Browse all packs で Rules Packs ページが開き、パックの検索やサンプルルールの確認ができます。Explore pack は、そのパックのルールを Browse で開きます。

ルールを読む

各カードには、タイトル、重大度、言語が表示され、そのまま使えるルールには Plug-and-Play バッジが付きます。カードをクリックすると開きます。
  • Why is it important?
  • Instructions:Kody がチェックする内容です。
  • Bad example と Good example(ルールにある場合)。
ルールを評価するには、サムズアップとサムズダウンを使います。投票した内容はカードに表示されます。

ルールを追加する

  1. ルールを開き、Add to my rules の横にある矢印をクリックします。
  2. 追加先を選択します。Global、1 つ以上のリポジトリ、またはディレクトリです。ルールを作成できる場所だけが一覧表示されます。Global を選ぶと、リポジトリはそれを継承するため、ルールは Global にのみ追加されます。
  3. Add to my rules をクリックします。確認画面に、ルールが追加された場所が一覧表示されます。
空の Kody Rules ページに表示される 3 つのルールのいずれかを開いた場合、Add to my rules はそのスコープに直接追加し、Kody Rules ページに戻ります。 追加されたルールには、次の特徴があります。
  • 有効な状態で追加され、常に Per file で実行され(ライブラリのルールが PR 全体のチェックを説明している場合でも同様です)、ライブラリの重大度と例を維持し、Library のオリジンが表示されます。
  • パスがないため、すべてのファイルに適用されます。例外が 2 つあります。言語を持つルールはその言語のファイルに限定され、ディレクトリスコープ内から追加されたルールは、そのディレクトリの最初のフォルダーをパス <folder>/** として持ちます。
  • Free プランの有効ルール 10 個の上限にカウントされます。上限を超えると、ルールは追加されますが Locked になります。ルールの上限 を参照してください。
ワークスペースで 集中設定 を使用している場合、ルールを追加すると、代わりに設定リポジトリにプルリクエストが作成されます。