analyzers
Configures, audits and fixes how Roslyn analyzers reach .NET projects (MSBuild-SDK injection, PackageReference, analysis modes, editorconfig and globalconfig severities, NoWarn, pragmas, SuppressMessage) and packages analyzer rules correctly, including ANcpLua.Analyzers (AL1000-AL1899, AlAnalysisMode). Use when a diagnostic should fire but doesn't, a suppression looks stale or too broad, rule IDs were renumbered, severities differ between IDE and CI, or analyzer behavior depends on MSBuild properties.
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-10
- Stars
- ★ 1
- Forks
- 0
01 前言 Front Matter
- name
- analyzers
- license
- Apache-2.0
- description
- Configures, audits and fixes how Roslyn analyzers reach .NET projects (MSBuild-SDK injection, PackageReference, analysis modes, editorconfig and globalconfig severities, NoWarn, pragmas, SuppressMessage) and packages analyzer rules correctly, including ANcpLua.Analyzers (AL1000-AL1899, AlAnalysisMode). Use when a diagnostic should fire but doesn't, a suppression looks stale or too broad, rule IDs were renumbered, severities differ between IDE and CI, or analyzer behavior depends on MSBuild properties.
02 资源文件 2
- 参考文档references/examples.md4.3 KB
- 参考文档references/id-migration.md6.1 KB
03 SKILL.md 正文
Roslyn analyzer adoption and suppression hygiene
Keep analyzer loading, packaging and severity configuration here. For an MSTest
diagnostic's test-code correction, invoke the installed mstest-extensions:mstest
skill for that part; preserve the requested scope. If unavailable, report the
missing companion rather than claiming its guidance was applied.
1. How an analyzer reaches a project
Find the path first. Each path has its own way to opt out and to pin the version:
| Path | Signal | Version from | Opt-out |
|---|---|---|---|
| MSBuild SDK injection | <Project Sdk="ANcpLua.NET.Sdk">; the SDK adds a GlobalPackageReference (under CPM) or an implicit PackageReference |
SDK Version.props ($(ANcpLuaAnalyzersVersion)) |
DisableANcpLuaAnalyzers=true |
Central GlobalPackageReference |
Directory.Packages.props |
that item | remove the item |
Direct PackageReference |
csproj or Directory.Build.props (often conditioned) |
PackageVersion |
condition on the item |
| .NET SDK built-in | EnableNETAnalyzers, AnalysisLevel, AnalysisMode |
the .NET SDK | EnableNETAnalyzers=false |
Inspect the evaluated analyzer items rather than inferring them from project text:
dotnet msbuild <proj> -getItem:Analyzer
These are the analyzer DLLs passed to compilation.
obj/<proj>.nuget.g.props shows which package props files were imported.
2. Severity: who wins
From lowest to highest precedence:
- The descriptor's default severity.
- Global configs (
is_global = true) in order ofglobal_level. ANcpLua.NET.Sdk's bundled AL config uses level 13, and theAlAnalysisModeprofiles use 50. .editorconfigsections matching the source file ([*.cs],[tests/**/*.cs]).#pragma warning disableand[SuppressMessage]at the code location.
NoWarn removes a diagnostic; WarningsAsErrors and TreatWarningsAsErrors escalate what's
left.
Facts that make configurations silently inert:
- A regular (sectioned)
.editorconfigapplies only to files under its own directory. One that ships inside a NuGet package and is added throughEditorConfigFilesmatches nothing in the consumer. Package-shipped configs must be global configs without sections. - A diagnostic reported on a non-C# file (an
AdditionalFilesitem such asDirectory.Packages.propsorVersion.props) has no syntax tree, so[*.cs]sections never reach it. Configure it in a global config, or withNoWarnandWarningsAsErrors. - Under
TreatWarningsAsErrors=true, setting a rule towarningrelaxes nothing. To relax for tests, usesuggestionornonewith a reason, or exclude the IDs withWarningsNotAsErrors. dotnet_analyzer_diagnostic.severity = errorescalates only rules that are enabled by default, and it's ignored entirely whenAnalysisMode/AnalysisLevelenables all rules. ID-specific entries from any config still win.
3. Suppression rules
- Every suppression names its reason on the same or the previous line. A suppression without a reason gets deleted or justified.
- Prefer the narrowest scope: a pragma around one statement,
[SuppressMessage(Justification = ...)]on one member, a section for one generated file, a projectNoWarn, and only then a repositoryNoWarn. - A suppression for an ID that no package in the project defines is dead. After a renumbering,
rewrite or delete every
NoWarn, pragma,SuppressMessageand editorconfig entry. For ANcpLua.Analyzers 2.0 (AL0xxxbecameAL1xxx), the complete old-to-new map ships with this skill inreferences/id-migration.md; for example, AL0017 became AL1600 and AL0018 became AL1601. - A pragma or
NoWarnthat works around a false positive is temporary: fix the analyzer, add a regression test, then delete the suppression. - Two settings that cancel each other (a project
NoWarnplus an editorconfig "warning" for the same ID) are both noise. Keep the one that states the intent. - Generated code is excluded by name (
*.g.cs,*.generated.cs,obj/) and byGeneratedCodeAnalysisFlags.None. A blanketdotnet_analyzer_diagnostic.severity = nonein a generated-file section is legitimate; the same line in a[*.cs]section isn't.
4. MSBuild properties inside analyzers
An analyzer reads build_property.<Name> from AnalyzerConfigOptions, which works only if a
<CompilerVisibleProperty Include="Name" /> item reaches the compilation.
- Ship consumer configuration in
buildTransitive/<PackageId>.propswhen it must flow transitively. Abuild/copy alone does not establish that flow; verify the consumer's generated imports rather than assuming which folder won. - Every key the analyzer source reads must have a matching item. Guard this with a test that scans
the analyzer source for
"build_property.keys and checks the props file. - Prove it from a consumer: build a throwaway project against the local package and look for the
key in
obj/**/<proj>.GeneratedMSBuildEditorConfig.editorconfig. - Tests that inject
build_property.*through editorconfig prove the rule logic, not the wiring.
5. ANcpLua.Analyzers specifics
- IDs
AL1000-AL1899in nine domain bands;AL0xxxbelongs to sibling packages (AotReflection, ExtensibleEnumMirror, DiscriminatedUnion). <AlAnalysisMode>:Default(descriptor severities),AllAsErrors, orDisabled. Unset means no profile, so the SDK's bundled per-rule config applies in SDK projects and descriptor severities apply elsewhere.- Projects outside ANcpLua.NET.Sdk that reference the package directly get descriptor severities.
Together with
TreatWarningsAsErrors, every Warning-default rule breaks the build there. That's intended, but a version bump can surface new hits; budget for fixing them. - AL1406/AL1407 (dynamic,
Expression.Compile) apply only to AOT-targeting projects (PublishAot/IsAotCompatible). - AL1600-AL1602 report on props files (see section 2).
6. Worked examples (found in real repositories)
Read references/examples.md for before and after cases: stale renumbered IDs in NoWarn, a
package build/ props that never reached consumers, editorconfig lines for props-file rules,
WarningsAsErrors without self-reference wiping the SDK's NuGetAudit escalation, a pragma hiding
a false positive, and test "relax" blocks that relax nothing.
7. Audit output
For each project: how the analyzer arrives (with evidence), which mode and severity sources apply, and
every suppression as file:line | ID | scope | reason present? | still defined? | verdict. Then
"certain" fixes (dead, duplicate or inert settings) and "judgment" items (raising or lowering a
severity, removing a suppression that hides live diagnostics) with a recommendation.
04 同仓库更多 Skills
csharp-union-types
Design, review and implement C# 15 unions and closed hierarchies in .NET 11 code. Use for union declarations, custom [Union] types, exhaustive matching, default/null handling and union serialization. Do not upgrade earlier frameworks or replace working inheritance merely because unions exist.
release
Releases .NET NuGet packages through a layered chain (library, MSBuild SDK, analyzers, consumers) without breaking restore. Use when publishing a package, bumping a lower-layer dependency in its consumers, moving a .NET SDK pin across repositories, choosing tag-driven versus push-driven publishing, setting up NuGet trusted publishing, or waiting for nuget.org to index a version before consumers restore it.
performance
Investigate .NET runtime performance using logs, metrics, traces, spans and profiles; collect crash/hang diagnostics. Use for CPU, GC, allocation or latency problems, hot-path reviews and BenchmarkDotNet comparisons. MSBuild timing belongs to msbuild; MSTest execution belongs to mstest-extensions.
nuget-versions
Manage .NET package and SDK versions, CPM migrations, Version.props ownership, global.json pins, isolated SDK installations and Renovate updates. Use for package bumps, conflicting or missing versions, NuGet restore errors and SDK selection. MSTest runner/profile semantics belong to mstest-extensions.
msbuild
Writes and reviews MSBuild evaluation, properties, items, imports, custom targets and build/buildTransitive package assets for SDK-style .NET repositories. Use for ignored or empty properties/items, generated files, analyzer/build-asset packaging, build-file reviews, binlog diagnosis and incremental-build problems. Focused MSTest project setup, runner configuration and test commands belong to mstest-extensions.
csharp-refactoring
Refactor C# and reconcile stale constants, dead checks and abandoned code, including indirect production uses. Use for renames, moves, deduplication, exhaustive cleanup, generated declarations and runtime/API contracts. MSTest test design and review belong to mstest-extensions.