Generate and package ruleset files for each analyzer package #1718
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We now generate the following set of ruleset files for each analyzer package: 1. AllRulesEnabled.ruleset 2. AllRulesDefault.ruleset 3. AllRulesDisabled.ruleset For every unique rule category within the pacakge, say security, performance, design, etc., we generate 2 ruleset files per category. For example, for Security, we generate: 1. SecurityRulesEnabled.ruleset (all security rules enabled, including the ones with IsEnabledByDefault = false. All rules from other categories are disabled) 2. SecurityRulesDefault.ruleset (all security rules have default severity and IsEnabledByDefault is honored. All rules from other categories are disabled) For the core FxCopAnalyzers package, we also package all the legacy FxCop rulesets, which have been edited to include AllRulesDisabled.ruleset upfront to match legacy FxCop configuration. Fixes dotnet#943
|
/cc @jinujoseph @kuhlenh This has been an extremely common ask from legacy FxCop customers, who want to migrate to FxCop analyzers but want to retain the existing rule configurations. |
|
Hopefully, the following screenshots clarify the new packaging structure for our analyzer packages:
All rules and per-category rulesets
For example, Legacy rulesets for FxCop analyzers package:
|
jinujoseph
approved these changes
Jun 12, 2018
This was referenced Jun 12, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We now generate the following set of ruleset files for each analyzer package during CI build:
AllRulesEnabled.rulesetAllRulesDefault.rulesetAllRulesDisabled.rulesetFor every unique rule category within the pacakge, say security, performance, design, etc., we generate 2 ruleset files per category. For example, for Security, we generate:
SecurityRulesEnabled.ruleset(all security rules enabled, including the ones with IsEnabledByDefault = false. All rules from other categories are disabled)SecurityRulesDefault.ruleset(all security rules have default severity and IsEnabledByDefault is honored. All rules from other categories are disabled)For the core FxCopAnalyzers package, we also package all the legacy FxCop rulesets, which have been edited to include
AllRulesDisabled.rulesetupfront to match legacy FxCop configuration.Fixes #943