moq-analyzers-config-and-flags

moq.analyzers configuration and flags catalog

Every knob in this repo, what it defaults to, who may change it, and what catches a bad change. This repo ships a Roslyn analyzer (a plugin that runs inside consumers' compilers and IDEs), so several "configuration" entries are actually load-bearing safety pins — changing them can crash customer builds.

All file paths are repo-root relative. All quotes verified against the working tree on 2026-07-02 (commit 05135b2).

Change control baseline: CODEOWNERS is * @rjmurillo — every file below is owner-reviewed. Nothing here documents a way around that; see moq-analyzers-change-control before touching any axis marked LOAD-BEARING.

Axis map (read this first)

Axis 1 — MSBuild properties

MSBuild properties are name/value pairs evaluated during dotnet build. This repo centralizes them in build/targets/<area>/{*.props,*.targets} pairs, imported by root Directory.Build.props (props) and Directory.Build.targets (targets), which MSBuild auto-imports into every project.

PedanticMode — the single most important flag

Exact text of build/targets/codeanalysis/CodeAnalysis.targets (entire file, 2026-07-02):

<Project>
  <PropertyGroup Label="Computed properties">
    <PedanticMode Condition=" '$(PedanticMode)' == '' ">$([MSBuild]::ValueOrDefault('$(ContinuousIntegrationBuild)', 'false'))</PedanticMode>
    <TreatWarningsAsErrors>$(PedanticMode)</TreatWarningsAsErrors>
    <MSBuildTreatWarningsAsErrors>$(PedanticMode)</MSBuildTreatWarningsAsErrors>
  </PropertyGroup>
</Project>

Semantics:

• PedanticMode defaults to whatever ContinuousIntegrationBuild is (false when unset). It drives BOTH TreatWarningsAsErrors (C# compiler warnings become errors) and MSBuildTreatWarningsAsErrors (MSBuild-level warnings become errors).
• CI always builds with /p:ContinuousIntegrationBuild=true (see .github/actions/setup-restore-build/action.yml, Build step), so CI is always pedantic. A plain local dotnet build is NOT.
• Consequence: any warning passes locally and fails CI. Always run the CI-parity build before pushing:

dotnet build Moq.Analyzers.sln --configuration Release /p:PedanticMode=true /p:Deterministic=true /p:ContinuousIntegrationBuild=true /p:UseSharedCompilation=false /p:BuildInParallel=false /nodeReuse:false

(That is verbatim the flag set from build/scripts/hooks/Invoke-PrePushBuild.ps1, which the pre-push git hook runs for you.)

Full property table

• Who may change: repo owner via PR. Property changes are infrastructure changes — cite the affected build/targets/ file in the PR.
• Guard: CI-parity build (pre-push hook + main.yml build job). There is no guard that detects loosening (e.g., lowering WarningLevel) other than code review — treat any diff under build/targets/ as high-scrutiny.

The one property trap with an incident behind it (2026-07-02)

Never configure S1135 ("track TODO tags") above suggestion. Under PedanticMode, S1135 = warning turns every TODO comment into a CI error and locks CI against itself (commit 3d4f7ff did this and was reverted the next day by b1439ab; the tripping build error was an issue-linked TODO(#1012) comment — #1012 itself tracks an unrelated enhancement, not this incident; see moq-analyzers-failure-archaeology §4). The current, correct setting is .editorconfig:420 → dotnet_diagnostic.S1135.severity = suggestion. TODO discipline is enforced by a different mechanism entirely (build/scripts/todo-scanner/Scan-TodoComments.ps1, pre-push).

Axis 2 — Analyzer severity configuration (the precedence story)

"Severity" is how loudly a diagnostic (e.g. CA1016, SA1101, Moq1200) reports: error > warning > suggestion > silent > none. Multiple files can set it; precedence, strongest first:

On top of whichever severity wins, PedanticMode=true escalates every surviving warning to error (Axis 1). There are no <NoWarn> properties and no .ruleset files anywhere in this repo (verified 2026-07-02) — do not introduce them; the layers above are the sanctioned mechanisms.

What each file is for

• Root .editorconfig — the main severity ledger plus formatting rules. Notable pinned entries (2026-07-02): SA1633 = silent (no file headers), SA1101 = silent (no this. prefix), SA1600 = silent, CA1016 = none (line 407 — Codacy false positive, suppressed deliberately per incident 58924f7/2a7ee34; do not "fix" it), MA0040 = error, CA2016 = error (CancellationToken forwarding — load-bearing for analyzer responsiveness), S1135 = suggestion (NEVER raise; see Axis 1 trap), MA0026 = none. It also carries the ADR-010 section forcing end_of_line = lf for *.ps1/psm1/psd1 (a CRLF PowerShell file once broke the pre-push hook, issue #1081) and a section protecting Verify snapshot files (*.{received,verified}.*) from newline/whitespac

Content truncated.