Merge pull request #2553 from gewarren/rulesets

Add analyzer rule set topic

Author: TrishaMc

docs/code-quality/analyzer-rule-sets.md

@@ -0,0 +1,56 @@
+---
+title: Analyzer rule sets
+ms.date: 07/20/2018
+ms.prod: visual-studio-dev15
+ms.technology: vs-ide-code-analysis
+ms.topic: conceptual
+helpviewer_keywords:
+  - "analyzers, rule sets"
+  - "rule sets for analyzers"
+author: gewarren
+ms.author: gewarren
+manager: douge
+ms.workload:
+  - "multiple"
+---
+# Rule sets for Roslyn analyzers
+
+Predefined rule sets are included with some NuGet analyzer packages. For example, the rule sets that are included with the [Microsoft.CodeAnalysis.FxCopAnalyzers NuGet analyzer package](https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/) (starting in version 2.6.2) enable or disable rules based on their category, such as security, naming, or performance. Using rule sets makes it easy to quickly see only those rule violations that pertain to a particular category of rule.
+
+If you're migrating from legacy "FxCop" static code analysis to Roslyn analyzers, these rule sets enable you to continue using the same rule configurations you used previously.
+
+## Use analyzer rule sets
+
+After you [install a NuGet analyzer package](install-roslyn-analyzers.md), locate the predefined rule set in its *rulesets* directory, for example *%USERPROFILE%\\.nuget\packages\microsoft.codequality.analyzers\<version>\rulesets*. From there, you can drag and drop, or copy and paste, one or more of the rulesets to your Visual Studio project in **Solution Explorer**.
+
+To make a rule set the active rule set for analysis, right-click on the project in **Solution Explorer** and choose **Properties**. In the project property pages, select the **Code Analysis** tab. Under **Run this rule set**, select **Browse**, and then select the desired rule set that you copied to the project directory. Now you only see rule violations for those rules that are enabled in the selected rule set.
+
+You can also [customize a predefined rule set](how-to-create-a-custom-rule-set.md#create-a-custom-rule-set) to your preference. For example, you can change the severity of one or more rules so that violations appear as errors or warnings in the **Error List**.
+
+## Available rule sets
+
+The predefined analyzer rule sets include three rulesets that affect all the rules in the package&mdash;one that enables them all, one that disables them all, and one that honors each rule's default severity and enablement settings:
+
+- AllRulesEnabled.ruleset
+- AllRulesDisabled.ruleset
+- AllRulesDefault.ruleset
+
+Additionally, there are two rule sets for each category of rules in the package, such as performance or security. One rule set enables all rules for the category, and one rule set honors the default severity and enablement settings for each rule in the category.
+
+ The [Microsoft.CodeAnalysis.FxCopAnalyzers NuGet analyzer package](https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/) includes rule sets for the following categories, to match the rule sets available for legacy "FxCop" static code analysis:
+
+- design
+- documentation
+- maintainability
+- naming
+- performance
+- reliability
+- security
+- usage
+
+## See also
+
+- [Overview of .NET Compiler Platform analyzers](roslyn-analyzers-overview.md)
+- [Install .NET Compiler Platform analyzers](install-roslyn-analyzers.md)
+- [Configure and use Roslyn analyzer rules](use-roslyn-analyzers.md)
+- [Use rule sets to group code analysis rules](using-rule-sets-to-group-code-analysis-rules.md)

docs/code-quality/ca0063.md

@@ -14,25 +14,27 @@ ms.workload:
   - "multiple"
 ---
 # CA0063
+
 Failed to load rule set file or one of its dependent rule set files.
 
- Failed to load rule set file or one of its dependent rule set files.
+Failed to load rule set file or one of its dependent rule set files.
 
- The specified ruleset could not be found or one of the ruleset files included in your ruleset could not be found. Make sure that the all the rulesets included in your ruleset exist on disk and that the appropriate ruleset directories are being specified in your project through the **CodeAnalysisRuleSetDirectories** property of [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)].
+The specified rule set could not be found or one of the rule set files included in your rule set could not be found. Make sure that the all the rule sets included in your rule set exist on disk and that the appropriate rule set directories are being specified in your project through the **CodeAnalysisRuleSetDirectories** property of [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)].
 
- To debug the error, examine your ruleset file in a text editor. To find the path to the ruleset file, right-click the project in Solution Explorer, click **Properties**, and then click **Code Analysis**. Make sure the ruleset file is selected in **Run this rule set**. The Path to the rule set is listed in the description field.
+To debug the error, examine your rule set file in a text editor. To find the path to the rule set file, right-click the project in Solution Explorer, click **Properties**, and then click **Code Analysis**. Make sure the rule set file is selected in **Run this rule set**. The Path to the rule set is listed in the description field.
 
- Examine the **Path** attribute value all the **Include** elements. Include paths can use relative paths to the parent/current ruleset file, environment variables, and absolute paths. For example:
+Examine the **Path** attribute value all the **Include** elements. Include paths can use relative paths to the parent/current rule set file, environment variables, and absolute paths. For example:
 
-```
+```xml
 <Include Path="%PUBLIC%\Documents\RuleSets\alldesign.ruleset" Action="Default" />
 <Include Path="..\alldesign.ruleset" Action="Default" />
 <Include Path="C:\Rulesets\alldesign.ruleset" Action="Default" />
 ```
 
- Inspect each of these include paths and verify they are all valid.
+Inspect each of these include paths and verify they are all valid.
 
- In some cases, the location of a ruleset can be dependent on an [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] property. [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] properties cannot be referenced from a ruleset. To work around this issue, specify additional search paths in the **CodeAnalysisRuleSetDirectories** property of [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)]. In this scenario, specify only the name of the ruleset in the **Path** attribute of the **Include** element.
+In some cases, the location of a rule set can be dependent on an [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] property. [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] properties cannot be referenced from a rule set. To work around this issue, specify additional search paths in the **CodeAnalysisRuleSetDirectories** property of [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)]. In this scenario, specify only the name of the rule set in the **Path** attribute of the **Include** element.
 
 ## See Also
- [Code Analysis Application Errors](../code-quality/code-analysis-application-errors.md)
+
+- [Code Analysis Application Errors](../code-quality/code-analysis-application-errors.md)

docs/code-quality/ca0064.md

@@ -19,12 +19,12 @@ No analysis was performed because the specified rule set did not contain any FxC
 
 This warning can occur in one of the following situations:
 
-- If you encounter this warning in conjunction with CA0063 warnings, there was an a problem loading your ruleset file. For more information, see the [CA0063](ca0063.md) documentation.
+- If you encounter this warning in conjunction with CA0063 warnings, there was a problem loading your rule set file. For more information, see the [CA0063](ca0063.md) article.
 
-- If you encounter this error in conjunction with CA0062 warnings, it most likely that Code Analysis was unable to find the assembly or assemblies that contain the rules specified by the ruleset. For more information, see the [CA0062](ca0062.md) documentation.
+- If you encounter this error in conjunction with CA0062 warnings, it most likely that code analysis was unable to find the assembly or assemblies that contain the rules specified by the rule set. For more information, see the [CA0062](ca0062.md) article.
 
-- Otherwise, this warning usually occurs when your ruleset is empty or all of the rules enabled in a child rule set have been disabled. Use the Visual Studio [rule set editor](../code-quality/working-in-the-code-analysis-rule-set-editor.md) to enable some rules in your ruleset.
+- Otherwise, this warning usually occurs when your rule set is empty or all of the rules enabled in a child rule set are disabled. Use the Visual Studio [rule set editor](../code-quality/working-in-the-code-analysis-rule-set-editor.md) to enable some rules in your rule set.
 
 ## See also
 
-- [Code Analysis Application Errors](../code-quality/code-analysis-application-errors.md)
+- [Code analysis application errors](../code-quality/code-analysis-application-errors.md)

docs/code-quality/how-to-configure-code-analysis-for-a-managed-code-project.md

@@ -18,7 +18,7 @@ ms.workload:
 ---
 # How to: Configure Code Analysis for a Managed Code Project
 
-In Visual Studio, you can choose from a list of code analysis *rule sets* to apply to a managed code project. The default rule set is *Microsoft Minimum Recommended Rules*. You can apply another rule set to a project or to all projects in a solution.
+In Visual Studio, you can choose from a list of code analysis [rule sets](../code-quality/rule-set-reference.md)) to apply to a managed code project. By default, the **Microsoft Minimum Recommended Rules** rule set is selected, but you can apply a different rule set if desired. Rule sets can be applied to one or multiple projects in a solution.
 
 > [!TIP]
 > For information about how to configure a rule set for ASP.NET web applications, see [How to: Configure Code Analysis for an ASP.NET web Application](../code-quality/how-to-configure-code-analysis-for-an-aspnet-web-application.md).
@@ -70,4 +70,5 @@ By default, all the managed projects of a solution are assigned the *Microsoft M
 
 ## See also
 
+- [Code analysis rule set reference](../code-quality/rule-set-reference.md)
 - [How to: Configure Code Analysis for an ASP.NET web Application](../code-quality/how-to-configure-code-analysis-for-an-aspnet-web-application.md)

docs/code-quality/how-to-create-a-custom-rule-set.md

@@ -14,9 +14,9 @@ manager: douge
 ms.workload:
   - "multiple"
 ---
-# Custom rule sets
+# Customize a rule set
 
-You can create a custom *rule set* to meet specific project needs for code analysis.
+You can create a custom rule set to meet specific project needs for code analysis.
 
 ## Create a custom rule set
 

docs/code-quality/managed-minimun-rules-rule-set-for-managed-code.md renamed to docs/code-quality/managed-minimum-rules-rule-set-for-managed-code.md

@@ -12,7 +12,8 @@ ms.workload:
   - "dotnet"
 ---
 # Managed Minimum Rules rule set for managed code
-The Managed Minimum Rules focus on the most critical problems in your code, including potential security holes, application crashes, and other important logic and design errors. You should include this rule set in any custom rule set you create for your projects.
+
+The Managed Minimum rules focus on the most critical problems in your code, including potential security holes, application crashes, and other important logic and design errors. Include this rule set in any custom rule set you create for your projects.
 
 |Rule|Description|
 |----------|-----------------|

docs/code-quality/rule-set-reference.md

@@ -14,6 +14,23 @@ ms.workload:
 ---
 # Code analysis rule set reference
 
-When you configure code analysis for managed code projects in Visual Studio, you can choose from a list of built-in *rule sets*. You can either use one of these built-in rule sets, or you can [customize a rule set](../code-quality/how-to-create-a-custom-rule-set.md) to fit your project requirements.
+When you configure static code analysis for managed code projects in Visual Studio, you can choose from a list of built-in *rule sets*. You can either use one of these built-in rule sets, or you can [customize a rule set](../code-quality/how-to-create-a-custom-rule-set.md) to fit your project requirements.
 
-The topics in this section describe the built-in rule sets and the rules (or warnings) they contain.
+The topics in this section describe the built-in rule sets and the rules (or warnings) they contain.
+
+> [!NOTE]
+> The rule sets in this section pertain to static code analysis. For information about rule sets available for Roslyn analyzer packages, see [Use rule sets with Roslyn analyzers](analyzer-rule-sets.md).
+
+- [All Rules rule set](all-rules-rule-set.md)
+- [Basic Correctness Rules rule set for managed code](basic-correctness-rules-rule-set-for-managed-code.md)
+- [Basic Design Guideline Rules rule set for managed code](basic-design-guideline-rules-rule-set-for-managed-code.md)
+- [Extended Correctness Rules rule set for managed code](extended-correctness-rules-rule-set-for-managed-code.md)
+- [Extended Design Guidelines Rules rule set for managed code](extended-design-guidelines-rules-rule-set-for-managed-code.md)
+- [Globalization Rules rule set for managed code](globalization-rules-rule-set-for-managed-code.md)
+- [Managed Minimum Rules rule set for managed code](managed-minimum-rules-rule-set-for-managed-code.md)
+- [Managed Recommended Rules rule set for managed code](managed-recommended-rules-rule-set-for-managed-code.md)
+- [Mixed Minimum Rules rule set](mixed-minimum-rules-rule-set.md)
+- [Mixed Recommended Rules rule set](mixed-recommended-rules-rule-set.md)
+- [Native Minimum Rules rule set](native-minimum-rules-rule-set.md)
+- [Native Recommended Rules rule set](native-recommended-rules-rule-set.md)
+- [Security Rules rule set for managed code](security-rules-rule-set-for-managed-code.md)

docs/code-quality/toc.yml

@@ -1,6 +1,7 @@
 - name: Code analysis documentation
   href: index.md
 - name: Overview
+  expanded: true
   items:
   - name: Code analysis for managed code
     href: code-analysis-for-managed-code-overview.md
@@ -80,16 +81,18 @@
   - name: Rule sets
     href: using-rule-sets-to-group-code-analysis-rules.md
     items:
-    - name: Rule Sets for Managed Code
+    - name: Rule sets for analyzer packages
+      href: analyzer-rule-sets.md
+    - name: Rule sets for managed code
       href: how-to-configure-code-analysis-for-a-managed-code-project.md
       items:
-      - name: Configure Code Analysis for an ASP.NET Web Application
+      - name: Configure code analysis for an ASP.NET web app
         href: how-to-configure-code-analysis-for-an-aspnet-web-application.md
-    - name: Rule Sets for C++ Code
+    - name: Rule sets for C++ code
       href: using-rule-sets-to-specify-the-cpp-rules-to-run.md
-    - name: Create a Custom Rule Set
+    - name: Create a custom rule set
       href: how-to-create-a-custom-rule-set.md
-    - name: Use the Rule Set Editor
+    - name: Use the rule set editor
       href: working-in-the-code-analysis-rule-set-editor.md
   - name: Check-in policies
     href: how-to-create-or-update-standard-code-analysis-check-in-policies.md
@@ -125,8 +128,8 @@
       href: extended-design-guidelines-rules-rule-set-for-managed-code.md
     - name: Globalization Rules rule set for managed code
       href: globalization-rules-rule-set-for-managed-code.md
-    - name: Managed Minimun Rules rule set for managed code
-      href: managed-minimun-rules-rule-set-for-managed-code.md
+    - name: Managed Minimum Rules rule set for managed code
+      href: managed-minimum-rules-rule-set-for-managed-code.md
     - name: Managed Recommended Rules rule set for managed code
       href: managed-recommended-rules-rule-set-for-managed-code.md
     - name: Mixed Minimum Rules rule set

docs/code-quality/use-roslyn-analyzers.md

@@ -73,7 +73,7 @@ The following screenshot shows the same three violations as they appear in the *
 
 You can change the severity of a rule from **Solution Explorer**, or within the *\<projectname>.ruleset* file that is added to the solution after you change the severity of a rule in **Solution Explorer**.
 
-![Ruleset file in Solution Explorer](media/ruleset-in-solution-explorer.png)
+![Rule set file in Solution Explorer](media/ruleset-in-solution-explorer.png)
 
 ### To set rule severity from Solution Explorer
 
@@ -93,7 +93,7 @@ You can change the severity of a rule from **Solution Explorer**, or within the
 
 1. In the **Action** column, select the value to open a drop-down list, and select the desired severity from the list.
 
-   ![Ruleset file open in editor](media/ruleset-file-in-editor.png)
+   ![Rule set file open in editor](media/ruleset-file-in-editor.png)
 
 ## Suppress violations
 

docs/code-quality/using-rule-sets-to-group-code-analysis-rules.md

@@ -1,5 +1,5 @@
 ---
-title: Code analysis rule sets in Visual Studio
+title: Code analysis rule sets
 ms.date: 04/02/2018
 ms.prod: visual-studio-dev15
 ms.technology: vs-ide-code-analysis
@@ -20,11 +20,13 @@ When you configure code analysis in Visual Studio, you can choose from a list of
 
 You can customize a rule set by adding or deleting rules, or by changing rule severities to appear as either warnings or errors in the **Error List**. Customized rule sets can fulfill a need for your particular development environment. When you customize a rule set, the rule set editor provides search and filtering tools to help you in the process.
 
+Rule sets are available for [static analysis of managed code](how-to-configure-code-analysis-for-a-managed-code-project.md), [analysis of C++ code](using-rule-sets-to-specify-the-cpp-rules-to-run.md), and [Roslyn analyzers](analyzer-rule-sets.md).
+
 ## Rule set format
 
 A rule set is specified in XML format in a *.ruleset* file. Rules, which consist of an ID and an *action*, are grouped by analyzer ID and namespace in the file.
 
-The XML contents of a *.ruleset* file looks similar to this:
+The contents of a *.ruleset* file looks similar to this XML:
 
 ```xml
 <RuleSet Name="Rules for Hello World project" Description="These rules focus on critical issues for the Hello World app." ToolsVersion="10.0">
@@ -48,14 +50,14 @@ The XML contents of a *.ruleset* file looks similar to this:
 ```
 
 > [!TIP]
-> It is easier to [edit a rule set](../code-quality/working-in-the-code-analysis-rule-set-editor.md) in the graphical **Rule Set Editor** than by hand.
+> It's easier to [edit a rule set](../code-quality/working-in-the-code-analysis-rule-set-editor.md) in the graphical **Rule Set Editor** than by hand.
 
-The rule set for a project is specified by the `CodeAnalysisRuleSet` property in the Visual Studio project file. For example:
+The rule set for a project is specified by the **CodeAnalysisRuleSet** property in the Visual Studio project file. For example:
 
 ```xml
 <CodeAnalysisRuleSet>HelloWorld.ruleset</CodeAnalysisRuleSet>
 ```
 
 ## See also
 
-- [Code analysis rule set reference](../code-quality/rule-set-reference.md)
+- [Code analysis rule set reference](../code-quality/rule-set-reference.md)

docs/code-quality/working-in-the-code-analysis-rule-set-editor.md

@@ -15,7 +15,9 @@ ms.workload:
 ---
 # Use the code analysis rule set editor
 
-The code analysis rule set editor lets you specify the rules that are included in a custom rule set, and the severity of rule violations.
+The code analysis rule set editor lets you specify the rules that are included in a custom rule set and set the severity of rule violations.
+
+The following table shows the severity options:
 
 |Action (Severity)|Description|
 |-|-|