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.

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

[Feature Request]: Expand BuildCheck editorconfig allowable syntax #10232

Closed
Tracked by #9628
baronfel opened this issue Jun 13, 2024 · 7 comments · Fixed by #10361
Closed
Tracked by #9628

[Feature Request]: Expand BuildCheck editorconfig allowable syntax #10232

baronfel opened this issue Jun 13, 2024 · 7 comments · Fixed by #10361

Comments

@baronfel
Copy link
Member

baronfel commented Jun 13, 2024

Summary

EditorConfig settings for BuildChecks have rigid rules:

  • casing matters for properties
  • not all Roslyn severities are available, but the docs declare it to be so

Background and Motivation

Ease of use/things I banged my head against today

Proposed Feature

I'd like to see:

  • the IsEnabled property should support enabled as well
  • casing should be case-insensitive
  • a severity of None (also, none) should be allowed to disable a rule (this is in line with the desire for case-insensitivity)

Alternative Designs

No response

@f-alizada
Copy link
Contributor

Thank you!
I'm going to update the usage, however would like clarify: which values were case sensitive?
Trying to reproduce:

[*.csproj]
build_check.BC0101.IsEnabled=TRUE
build_check.BC0101.SEVERITY=ERROR

And the configuration applied correctly, am I missing something?

@f-alizada f-alizada self-assigned this Jun 14, 2024
@baronfel
Copy link
Member Author

For case sensitivity I agree that the values are fine, it was the case sensitivity of the property keys that was frustrating - convention elsewhere seems to be lowercase property keys (meaning don't let .NET's Pascal case obsession leak to the editor config file).

@AR-May AR-May added the triaged label Jun 18, 2024
@JanKrivanek
Copy link
Member

JanKrivanek commented Jul 1, 2024

Possibly related: #10315

@JanKrivanek
Copy link
Member

Btw. - the:

  • the IsEnabled property should support enabled as well
  • a severity of None (also, none) should be allowed to disable a rule (this is in line with the desire for case-insensitivity)

Are tracked as #10097

Let's handle in either of those tickets, let's just prevent any possible duplication of efforts

@f-alizada
Copy link
Contributor

Comment from @baronfel

Do we need IsEnabled overall in editorconfig if we are going to have support of severity=none which is equal to the IsEnabled=false

With this I do agree, and since we are in development mode I would remove the key from the infrastructure recognized keys :)

@f-alizada
Copy link
Contributor

  • the IsEnabled property should support enabled as well
  • a severity of None (also, none) should be allowed to disable a rule (this is in line with the desire for case-insensitivity)

This goal was done as part of the ticket: #10097

casing should be case-insensitive

Goal here is to remove the supportability of CamelCase in configuration module for infrastructure related keys and this is tracked here: #10315

@f-alizada
Copy link
Contributor

Conclusion

This issue is closed since all related work to the reported feature request is completed:
1 - #10315 solving the CamelCase configurations
2 - Severity model improved: #10097

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants