Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix analyzer warnings #202

Open
JamieMagee opened this issue Aug 16, 2022 · 0 comments
Open

Fix analyzer warnings #202

JamieMagee opened this issue Aug 16, 2022 · 0 comments
Labels
good first issue Good for newcomers status:in-progress Someone is working on implementation type:refactor Refactoring or improving of existing code

Comments

@JamieMagee
Copy link
Member

JamieMagee commented Aug 16, 2022 •
edited
Loading

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
@JamieMagee JamieMagee added good first issue Good for newcomers status:ready Ready to start implementation type:refactor Refactoring or improving of existing code labels Aug 16, 2022
@JamieMagee JamieMagee mentioned this issue Aug 16, 2022
Merged
JamieMagee added a commit that referenced this issue Aug 16, 2022
@JamieMagee
refactor: fix SA1001
37c380a 
Related to #202

Commas should not be preceded by whitespace
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1001.md
@JamieMagee JamieMagee mentioned this issue Aug 16, 2022
Merged
JamieMagee added a commit that referenced this issue Aug 16, 2022
@JamieMagee
refactor: fix SA1005
f3c2459 
Related to #202

Single line comment should begin with a space
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1005.md
@JamieMagee JamieMagee mentioned this issue Aug 16, 2022
Merged
JamieMagee added a commit that referenced this issue Aug 16, 2022
@JamieMagee
refactor: fix SA1105
c1e861c 
Related to #202

Single line comment should begin with a space
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1105.md
@JamieMagee JamieMagee mentioned this issue Aug 16, 2022
Merged
@JamieMagee JamieMagee self-assigned this Aug 16, 2022
@JamieMagee JamieMagee added status:in-progress Someone is working on implementation and removed status:ready Ready to start implementation labels Aug 16, 2022
JamieMagee added a commit that referenced this issue Aug 16, 2022
@JamieMagee
refactor: fix SA1648
36d937c 
Related to #202

inheritdoc should be used with inheriting class
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1648.md
@JamieMagee JamieMagee mentioned this issue Aug 16, 2022
Merged
JamieMagee added a commit that referenced this issue Aug 17, 2022
@JamieMagee
refactor: fix SA1518
3b30029 
Related to #202

File is required to end with a single newline character
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1518.md
@JamieMagee JamieMagee mentioned this issue Aug 17, 2022
Merged
JamieMagee added a commit that referenced this issue Aug 19, 2022
@JamieMagee
refactor: fix SA1137
939a817 
Related to #202
@JamieMagee JamieMagee mentioned this issue Aug 19, 2022
Merged
This was referenced Aug 19, 2022
Merged
Merged
Merged
Merged
Merged
JamieMagee added a commit that referenced this issue Aug 20, 2022
@JamieMagee
refactor: fix SA1208
d55102d 
Related to #202

Using directive for '...' should appear before directive for '...'
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1208.md
JamieMagee added a commit that referenced this issue Aug 20, 2022
@JamieMagee
refactor: fix SA 1202
4ef4d42 
Related to #202

Constant fields should appear before non-constant fields
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1202.md
@JamieMagee JamieMagee mentioned this issue Aug 23, 2022
Merged
@amitla1 amitla1 mentioned this issue Aug 24, 2022
Merged
@AdamPlaskitt AdamPlaskitt mentioned this issue Aug 28, 2022
Merged
AdamPlaskitt added a commit to AdamPlaskitt/component-detection that referenced this issue Aug 28, 2022
@AdamPlaskitt
Remove fix occurances warning SA1114
0ac6a1d 
Parameter list should follow declaration.
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1114.md

Related to microsoft#202
@AdamPlaskitt AdamPlaskitt mentioned this issue Aug 28, 2022
Merged
amitla1 pushed a commit that referenced this issue Aug 30, 2022
@AdamPlaskitt
Remove fix occurances warning SA1114 (#238)
00bca26 
Parameter list should follow declaration.
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1114.md

Related to #202
This was referenced Aug 31, 2022
Merged
Merged
Merged
Merged
amitla1 added a commit that referenced this issue Sep 1, 2022
@AdamPlaskitt @amitla1
Refactor: Fix warning SA1108 (#237)
799c30a 
* Related to #202

Block statements should not contain embedded comments
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1108.md

* Remove trailing whitespace warning

Co-authored-by: amitla1 <[email protected]>
AdamPlaskitt added a commit to AdamPlaskitt/component-detection that referenced this issue Sep 3, 2022
@AdamPlaskitt
Fix SA1101 warnings
023f40b 
Prefix local calls with this.
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1101.md

Related to microsoft#202
@Omotola Omotola mentioned this issue Sep 8, 2022
Merged
This was referenced Sep 9, 2022
Closed
Closed
@JamieMagee JamieMagee mentioned this issue Oct 17, 2022
Merged
@JamieMagee JamieMagee pinned this issue Oct 20, 2022
@JamieMagee JamieMagee mentioned this issue Oct 20, 2022
Merged
JamieMagee added a commit that referenced this issue Oct 21, 2022
@JamieMagee
refactor: fix IDE0032
6d2bd19 
Related to #202
@JamieMagee JamieMagee mentioned this issue Oct 24, 2022
Merged
This was referenced Oct 25, 2022
Merged
Merged
@RushabhBhansali RushabhBhansali mentioned this issue Oct 28, 2022
Merged
This was referenced Oct 28, 2022
Merged
Merged
Merged
@melotic melotic mentioned this issue Jan 30, 2023
Merged
25 tasks
@cobya cobya unpinned this issue May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers status:in-progress Someone is working on implementation type:refactor Refactoring or improving of existing code
Projects
Component Detection - Library Improvements
Status: In progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JamieMagee