コンテンツにスキップ

CLI 構成

生成されたパスを無視し、モジュールを無効にし、検出された問題を変換し、カスタム チェックを読み込みます。


プロジェクト構成を使用する

VICE は、プロジェクト ルートから Vice.config.js または Vice.config.mjs を読み取ります。ポリシーをすべての開発者と CI の実行に一貫して適用する必要がある場合は、バージョン管理内に保持します。

意図を持って無効化または変換する

変換は、修正された検出された問題を返すか、それを削除するために null を返す場合があります。広範な抑制よりも文書化された狭いルールを優先し、変換が失敗した場合でも元の検出された問題を保持します。

Vice.config.js
1export default {
2 disabledModules: ['git-history'],
3 transformFinding(finding) {
4 return finding
5 },
6}

ソース以外のパスを無視する

生成されたファイル、ベンダー コード、大規模なフィクスチャ、または監査に属さないその他のパスには .viceignore を使用します。パスを追加する前に、検出された予期せぬ問題を確認してください。

.viceignore
1**/locales/**
2src/generated/**
3test/fixtures/large/**

カスタムモジュールをロードする

module 配列を介してモジュール ファイル パスを追加します。各 ES モジュールは、名前、値、および提供されたコンテキストを通じて検出された問題を報告する非同期 fn 実装を公開する必要があります。

プロジェクトモジュールをロードする
1export default {
2 modules: ['./security/custom-check.js'],
3}

ポリシーの変更を確認する

モジュール、変換、または無視ルールを無効にすると、カバレッジが変更されます。アプリケーション コードなどの変更を確認し、リリースしきい値に影響を与える場合は結果とともに記録します。


VICE を続行する

オープンソース エンジン、モジュール、スコープ コントロールを確認します。

VICE エンジンを詳しく見る