忽略文件

archlint 提供了几种从分析中排除文件或目录的方法。

全局忽略

.archlint.yaml 根目录下的 ignore 部分指定了所有检测器都应完全跳过的文件。

ignore:
  - '**/node_modules/**'
  - '**/dist/**'
  - '**/coverage/**'
  - '**/tmp/**'
  - '**/*.d.ts'

.gitignore 支持

默认情况下，archlint 会自动遵循您的 .gitignore 文件。您不需要在 .archlint.yaml 中重复这些模式。如果您想禁用此行为，请设置 git: { enabled: false }。

按规则忽略

您可以使用 rules 部分内的 exclude 字段从特定检测器中排除文件。如果您希望一个文件被大多数检测器分析但被某个特定检测器跳过，这很有用。

rules:
  cycles:
    exclude:
      - '**/generated/**'
      - '**/*.entity.ts'

路径覆盖 (Overrides)

对于更复杂的逻辑（例如，更改设置或为特定目录禁用多个规则），请使用 overrides 部分：

overrides:
  - files: ['**/tests/**', '**/mocks/**']
    rules:
      complexity: off
      god_module: off
      large_file: medium

内联忽略 (Inline Ignore)

您可以使用特殊的注释直接在源代码中忽略特定的架构问题。这对于在例外情况下抑制警告非常有用。

用法：

所有模式均支持单行注释（// archlint-...）和块注释（/* archlint-... */）语法。

1. 整个文件：在文件顶部添加 // archlint-disable。
2. 当前行：在行尾或上一行添加 // archlint-disable-line。
3. 下一行：在有问题的行之前使用 // archlint-disable-next-line。
4. 代码块：使用 // archlint-disable 和 // archlint-enable 来包裹一段代码。

示例：

// archlint-disable * - 整个文件使用遗留模式
// 忽略整个文件的所有规则

// prettier-ignore
// archlint-disable-next-line long-params - 此遗留函数需要许多参数
function processTransaction(id: string, amount: number, currency: string, date: Date, recipient: string, note: string) {
  // 长参数检测将仅针对此行被忽略
}

import { internal } from './private'; // archlint-disable-line layer_violation - 迁移的临时排除

/* archlint-disable complexity */
function legacyCode() {
  // 此代码块将被忽略
}
/* archlint-enable complexity */

您可以指定多个以逗号分隔的规则，或使用 * 忽略所有规则。