Ctrlk
Changelog NotificationsAPIAikido login
For the complete documentation index, see llms.txt. This page is also available as Markdown.

カスタムコードルールを追加

カスタムコードルールを使用すると、チーム固有のコーディング標準や、組織独自のパターンを強制できます。特定のコードパターンを検出したり、命名規則を適用したり、既定のチェックではカバーされないアーキテクチャ違反をフラグ付けするルールを作成できます。

カスタムコードルールとは？

カスタムコードルールは、チームの特定要件に合わせて定義するAI搭載のチェックです。一般的なベストプラクティスを適用する既定のチェックとは異なり、カスタムルールはコードベース、アーキテクチャ、またはビジネスロジックに固有の標準を強制します。

グローバルまたはリポジトリ固有のガイドラインを実装したい場合は、こちらをご覧ください： コードコンテキスト 機能。

カスタムコードルールの作成

1

ルールを定義する

  1. 移動先: コード品質 > チェック タブ

  2. クリック カスタムコードルールを追加

  3. ルールが検出すべき内容を、わかりやすく説明してください：

例：

Dockerfile のベースイメージとして Alpine ベースイメージのみを許可する
2

対象言語を選択

このルールを適用するプログラミング言語を選択します

3

例を生成して改善する

  • クリック 例を生成 AI に初期コードサンプルを作成させるため

  • 生成された例を確認して修正します

  • 準拠例と非準拠例の両方を用意してください：

準拠例：

# ✅ ルールに従うコード
FROM alpine:3.18
RUN apk add --no-cache nodejs

非準拠例：

# ❌ ルールに違反するコード
FROM ubuntu:latest
RUN apt-get update && apt-get install nodejs
4

ルールを検証する

  1. クリック ルールを検証 例をテストするために

  2. システムは次を検証します：

    • 準拠例がルールに合格すること

    • 非準拠例が正しく検出されること

    • ルールのロジックが一貫していて明確であること

  3. 検証に失敗した場合は例を調整してください

5

ルールの詳細を設定

検証が完了したら、ルールに関する追加情報を入力してください：

  1. タイトル： ルールにわかりやすく説明的な名前を付けます

    Docker コンテナで Alpine ベースイメージを使用する

  2. 要約： 問題の簡潔な要約を記述します

    Alpine 以外のベースイメージは、コンテナサイズと攻撃対象領域を増大させます

  3. 修正方法： 開発者向けの実行可能なガイダンスを提供します

    ベースイメージを Alpine Linux 版に置き換えてください。たとえば、'FROM node:18' を 'FROM node:18-alpine' に変更します。パッケージのインストールコマンドを apt-get から apk に調整する必要がある場合があります。

  4. クリック ルールを保存 有効化するために

カスタムルールはチェックタブに表示され、有効化されたリポジトリで新しいプルリクエストのスキャンを開始します。

効果的なカスタムルールの書き方

具体的かつ明確にする

❌ 曖昧すぎる：

適切なエラーハンドリングを使用する

✅ 具体的で実行可能：

すべての API エンドポイントは、データベース呼び出しを try-catch ブロックで囲み、返却する必要があります 
ステータスコード付きの標準化されたエラーレスポンス

スタイルではなくパターンに焦点を当てる

カスタムルールは、書式よりも論理パターンの検出に最適です：

✅ カスタムルールに適した例：

  • API 認証要件

  • データベーストランザクションのパターン

  • セキュリティヘッダーの実装

  • ビジネスロジックの検証

❌ リンターで扱う方が適切：

  • インデントとスペース

  • 括弧の配置

  • 変数の命名スタイル

一般的なカスタムルールの例

セキュリティルール

アーキテクチャルール

API 標準

テスト要件

ドキュメント標準

最終更新

役に立ちましたか？