dotnet-skills
Tool .NET Quality v1.0.0

StyleCop Analyzers

Use the open-source free `StyleCop.Analyzers` package for naming, layout, documentation, and style rules in .NET projects. Use when a repo wants stricter style conventions than the SDK analyzers alone provide. USE FOR: the repo wants StyleCop.Analyzers; naming, layout, or documentation style needs stronger enforcement; the team needs stylecop.json guidance. DO NOT USE FOR: repos that intentionally rely only on SDK analyzers; repos where StyleCop overlaps too heavily with an existing style package and no. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.

Trigger On

  • the repo wants StyleCop.Analyzers
  • naming, layout, or documentation style needs stronger enforcement
  • the team needs stylecop.json guidance

Workflow

  1. Add StyleCop.Analyzers only if the repo wants its opinionated style rules.
  2. Keep severity in the root .editorconfig.
  3. Use stylecop.json only for StyleCop-specific behavioral options.
  4. Prefer one checked-in stylecop.json per repo unless a project genuinely needs its own behavior.
  5. Avoid rule duplication with SDK analyzers or other analyzer packs when possible.

Deliver

  • explicit StyleCop package setup
  • repo-owned StyleCop rule configuration
  • clear split between root .editorconfig and stylecop.json

Validate

  • StyleCop severity is versioned in repo config
  • stylecop.json is used only where it adds value

Load References

Related skills