Setting version to 1.8.0. Updating documentation.

Author: realvizu

CHANGELOG.md

@@ -1,7 +1,7 @@
 # NsDepCop Change Log
 
 ## v1.8.0
-(06/2018)
+(07/2018)
 
 - [x] Enhancements in launching the out-of-process service host (configurable retry intervals, allow access for any user).
 - [x] MaxIssueCountSeverity - enables breaking the build when a threshold number of dependency violations has been reached.

README.md

@@ -11,7 +11,6 @@ What is this [**dependency control**](doc/DependencyControl.md) anyway?
 ## Getting Started
 
 1. Add the **NsDepCop NuGet package** to your C# projects: [![NuGet Package](https://img.shields.io/nuget/v/NsDepCop.svg)](https://nuget.org/packages/NsDepCop)
-   * If you have v1.7.0 then you should update to v1.7.1 because that's much faster.
 1. A file called **config.nsdepcop** is automatically added to your project. Edit it and describe [**dependency rules**](doc/Help.md#dependency-rules).
    * If your project doesn't use the packages.config package manager format then you'll have to [add config.nsdepcop manually](doc/Troubleshooting.md#item4).
 1. When you **build** the project, dependency violations will be reported in the build output just like compiler errors/warnings.

appveyor.yml

@@ -2,7 +2,7 @@ image: Visual Studio 2017
 
 environment:
   shortversion: '1.8.0'
-  informationalversion: '1.8.0-beta2'
+  informationalversion: '1.8.0'
 
 version: '$(shortversion).{build}'
 

doc/Help.md

@@ -3,6 +3,7 @@
 * [Supported project types](#supported-project-types)
 * [Dependency rules](#dependency-rules)
 * [Config inheritance](#config-inheritance)
+* [Dealing with a high number of dependency issues](#dealing-with-a-high-number-of-dependency-issues)
 * [Controlling verbosity](#controlling-verbosity)
 * [Config XML schema](#config-xml-schema)
 * [Config XML schema support in Visual Studio](#config-xml-schema-support-in-visual-studio)
@@ -44,7 +45,9 @@ Attribute | Values | Description
 **CodeIssueKind** | Info, **Warning**, Error | Dependency violations are reported at this severity level.
 **ChildCanDependOnParentImplicitly** | true, **false** | If set to true then all child namespaces can depend on any of their parents without an explicit allowing rule. The recommended value is **true**. (False is default for backward compatibility.)
 **InfoImportance** | Low, **Normal**, High | Info messages are reported to MSBuild at this level. This setting and the MSBuild verbosity (/v) swicth together determine whether a message appears on the output or not. See [Controlling verbosity](#controlling-verbosity) for details.
-**MaxIssueCount** | int (>0), default: **100** | Analysis stops when reaching this number of issues.
+**MaxIssueCount** | int (>0), default: **100** | Analysis stops when reaching this number of dependency issues.
+**MaxIssueCountSeverity** | Info, **Warning**, Error | This is the severity of the issue of reaching MaxIssueCount.
+**AutoLowerMaxIssueCount** | true, **false** | If set to true then each successful build yielding fewer issues than MaxIssueCount sets MaxIssueCount to the current number of issues.
 **InheritanceDepth** | int (>=0), default: **0** | Sets the number of parent folder levels to inherit config from. 0 means no inheritance.
 
 ### Whitelisting
@@ -164,6 +167,23 @@ Even if all the settings come from a higher-level config, you have to put **at l
 E.g.: `<NsDepCopConfig InheritanceDepth="3"/>`
 * You can turn on diagnostic messages ([Controlling verbosity](#controlling-verbosity)) to see which config files were found and loaded by the tool and what effective config resulted from combining them.
 
+## Dealing with a high number of dependency issues
+If there are so many dependency issues that you cannot fix them all at once but you still want to control them somehow then try the following.
+
+* Prevent the introduction of more dependency issues. Set the current number of issues as the maximum and make it an error to create more.
+
+```xml
+<NsDepCopConfig IssueKind="Warning" MaxIssueCount="<the current number of issues>" MaxIssueCountSeverity="Error">
+```
+
+* Encourage developers to gradually fix the dependency issues by automatically lowering the max issue count whenever possible. Turn on AutoLowerMaxIssueCount.
+
+```xml
+<NsDepCopConfig IssueKind="Warning" MaxIssueCount="100" MaxIssueCountSeverity="Error" AutoLowerMaxIssueCount="true">
+```
+
+> Please note that when NsDepCop modifies the nsdepcop.config files their formatting will be reset (because of the XML deserialization/serialization roundtrip).
+
 ## Controlling verbosity
 * Besides emitting dependency violation issues, the tool can emit diagnostic and info messages too.
   * **Info messages** tell you when was the tool started and finished.

doc/Troubleshooting.md

@@ -1,10 +1,25 @@
 # NsDepCop Troubleshooting
 
+* [Exception: Unable to communicate with NsDepCop service](#item5)
 * [NsDepCop NuGet package is not adding config.nsdepcop file to the project](#item4)
 * [Anonymous types raise false alarms](#item3)
 * [Setup is unable to add NsDepCop target to the C# build workflow](#item2)
 * [Setup is unable to remove NsDepCop target from the C# build workflow](#item1)
 
+<a name="item5"></a>
+## Exception: Unable to communicate with NsDepCop service
+> Applies to version v1.7.1 or later.
+
+This problem is likely caused by the analyzer client not waiting enough time for the analyzer server started in a separate process to spin up.
+To fix it:
+* Update to v1.8.0 or later. 
+* Try to set longer and/or more wait intervals in your config.nsdepcop file(s) by adding the AnalyzerServiceCallRetryTimeSpans attribute to the root element and fiddling with its value. The value should be a comma separated list of wait times between retries (in milliseconds).
+  * E.g. this config waits 100ms, then 1sec, then 10sec:
+
+```xml
+<NsDepCopConfig AnalyzerServiceCallRetryTimeSpans="100,1000,10000">
+```
+
 <a name="item4"></a>
 ## NsDepCop NuGet package is not adding config.nsdepcop file to the project
 If the project uses the **PackageReference** package manager format then content files are not added to the project.