Skip to content

Fix analyzer warnings #202

Open
Open
@JamieMagee

Description

@JamieMagee

This is an overarching issue to track analyzer warnings that are currently silenced. To fix a single warning:

  1. Remove the warning silence from .editorconfig
  2. Run a build locally
  3. Fix any warnings that are emitted
  4. Create a pull request
  5. Link it to this issue
  6. Once merged check the relevant box below
Table of Contents
  • StyleCop.Analyzers
  • Microsoft.VisualStudio.Threading.Analyzers
  • Roslyn
  • Introduced with .NET 6 migration
    • Language rules
    • Code quality rules
    • StyleCop.Analyzers

StyleCop.Analyzers

Microsoft.VisualStudio.Threading.Analyzers

  • VSTHRD002
    • Synchronously waiting on tasks or awaiters may cause deadlocks. Use await or JoinableTaskFactory.Run instead.
  • VSTHRD103
    • Result synchronously blocks. Use await instead.
  • VSTHRD101
    • Avoid using async lambda for a void returning delegate type, because any exceptions not handled by the delegate will crash the process
  • VSTHRD104
    • Expose an async version of this method that does not synchronously block. Then simplify this method to call that async method within a JoinableTaskFactory.Run delegate.
  • VSTHRD111
    • Add .ConfigureAwait(bool) to your await expressio
  • VSTHRD200

Roslyn

  • CS0618
    • '...' is obsolete
  • CS1591
    • Missing XML comment for publicly visible type or member '...'

Introduced with .NET 6 migration

Language rules

Code quality rules

StyleCop.Analyzers

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomersstatus:in-progressSomeone is working on implementationtype:refactorRefactoring or improving of existing code

    Type

    No type

    Projects

    Status

    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions