.NET Core and xUnit cleanup for v0.9 (#332)

* Usings cleanup

* Fix xunit warnings and cleanup

* Expose internals to xunit tests

* Remove nuget solution folder

Author: BernieWhite

CONTRIBUTING.md

@@ -1,3 +1,5 @@
+# Contributing to platyPS
+
 ## Get the code
 
 ```
@@ -6,7 +8,7 @@ git clone https://github.com/PowerShell/platyPS
 
 ## Understand code layout
 
-There are two parts: 
+There are two parts:
 
 - `Markdown.MAML.dll`, a .NET library written in C#.
   It does the heavy lifting, like parsing Markdown, transforming it into XML, and so on.
@@ -19,7 +21,7 @@ There are two parts:
 To build the whole project, use the `build.ps1` helper script.
 It depends on the [dotnet cli](https://docs.microsoft.com/en-us/dotnet/core/tools/) build tool.
 
-```
+```powershell
 .\build.ps1
 ```
 As part of the build, platyPS generates help for itself.
@@ -48,9 +50,9 @@ If you have ideas or concerns about the Markdown schema, feel free to open a Git
 
 ## Repo structure
 
- -  **src\platyPS** - sources to create the final PowerShell module.
- -  **src\Markdown.MAML, Markdown.MAML.sln** - source code for C# Markdown to MAML converter.
- -  **[platyPS.schema.md](platyPS.schema.md)** - description of Markdown that platyPS expects.
+- **src\platyPS** - sources to create the final PowerShell module.
+- **src\Markdown.MAML, Markdown.MAML.sln** - source code for C# Markdown to MAML converter.
+- **[platyPS.schema.md](platyPS.schema.md)** - description of Markdown that platyPS expects.
 
 ## Data transformations
 
@@ -92,11 +94,11 @@ This chart describes these simple transformations:
 +----------------------+            +---------------------------+
 ```
 
-##### Example `New-MarkdownHelp`
+### Example `New-MarkdownHelp`
 
-A user creates a platyPS Markdown for the first time with `New-MarkdownHelp`: 
+A user creates a platyPS Markdown for the first time with `New-MarkdownHelp`:
 
-```
+```powershell
 New-MarkdownHelp -Command New-MyCommandHelp
 ```
 

Markdown.MAML.sln

@@ -11,13 +11,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Markdown.MAML", "src\Markdo
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Markdown.MAML.Test", "test\Markdown.MAML.Test\Markdown.MAML.Test.csproj", "{317CCB63-9AFA-4647-8838-DD8E20C8716F}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{E30960A6-764E-4E50-A337-F79F992C6F96}"
-	ProjectSection(SolutionItems) = preProject
-		.nuget\NuGet.Config = .nuget\NuGet.Config
-		.nuget\NuGet.exe = .nuget\NuGet.exe
-		.nuget\NuGet.targets = .nuget\NuGet.targets
-	EndProjectSection
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

README.md

@@ -5,13 +5,13 @@
 
 # PlatyPS
 
-PlatyPS provides a way to 
+PlatyPS provides a way to:
 
 * Write PowerShell External Help in Markdown
 * Generate markdown help ([example](docs/Update-MarkdownHelp.md)) for your existing modules
 * Keep markdown help up-to-date with your code
 
-Markdown help docs can be generated from old external help files (also known as MAML-xml help), the command objects (reflection), or both.  
+Markdown help docs can be generated from old external help files (also known as MAML-xml help), the command objects (reflection), or both.
 
 PlatyPS can also generate cab files for [`Update-Help`](https://technet.microsoft.com/en-us/library/hh849720.aspx).
 
@@ -25,7 +25,6 @@ An additional challange PlatyPS tackles, is to handle PowerShell documentation f
 Markdown is designed to be human-readable, without rendering. This makes writing and editing easy and efficient. 
 Many editors support it ([Visual Studio Code](https://code.visualstudio.com/), [Sublime Text](http://www.sublimetext.com/), etc), and many tools and collaboration platforms (GitHub, Visual Studio Online) render the Markdown nicely.
 
-
 ## Quick start
 
 * Install platyPS module from the [PowerShell Gallery](https://powershellgallery.com):
@@ -100,4 +99,4 @@ Supported scenarios:
 
 ## Build
 
-For information about building from sources and contributing see [contributing guidelines](CONTRIBUTING.md).
+For information about building from sources and contributing see [contributing guidelines](CONTRIBUTING.md).

src/Markdown.MAML/Markdown.MAML.csproj

@@ -1,8 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
   <PropertyGroup>
     <TargetFrameworks>netstandard1.6;net451</TargetFrameworks>
   </PropertyGroup>
+  <PropertyGroup>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors />
+  </PropertyGroup>
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.6' ">
     <PackageReference Include="System.Collections.NonGeneric" Version="4.3.0" />
   </ItemGroup>

src/Markdown.MAML/Model/MAML/MamlCodeBlock.cs

@@ -1,10 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-
-namespace Markdown.MAML.Model.MAML
+namespace Markdown.MAML.Model.MAML
 {
     /// <summary>
     /// A section of code such as PowerShell commands or command output.

src/Markdown.MAML/Model/MAML/MamlExample.cs

@@ -1,9 +1,4 @@
 using Markdown.MAML.Model.Markdown;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Markdown.MAML.Model.MAML
 {

src/Markdown.MAML/Model/MAML/MamlInputOutput.cs

@@ -1,9 +1,5 @@
 using Markdown.MAML.Model.Markdown;
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Markdown.MAML.Model.MAML
 {

src/Markdown.MAML/Model/MAML/MamlSyntax.cs

@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using System.Collections.Generic;
 
 namespace Markdown.MAML.Model.MAML
 {

src/Markdown.MAML/Model/Markdown/HyperlinkSpan.cs

@@ -1,5 +1,4 @@
 using Markdown.MAML.Parser;
-using System;
 
 namespace Markdown.MAML.Model.Markdown
 {

src/Markdown.MAML/Model/Markdown/MarkdownNodeType.cs

@@ -1,5 +1,4 @@
-
-namespace Markdown.MAML.Model.Markdown
+namespace Markdown.MAML.Model.Markdown
 {
     public enum MarkdownNodeType
     {

src/Markdown.MAML/Model/Markdown/ParagraphSpan.cs

@@ -1,6 +1,4 @@
-
-using Markdown.MAML.Parser;
-using System.Text.RegularExpressions;
+using Markdown.MAML.Parser;
 
 namespace Markdown.MAML.Model.Markdown
 {

src/Markdown.MAML/Model/Markdown/SectionBody.cs

@@ -1,10 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-
-namespace Markdown.MAML.Model.Markdown
+namespace Markdown.MAML.Model.Markdown
 {
     /// <summary>
     /// A section of text with formatting options.

src/Markdown.MAML/Model/Markdown/SectionFormatOption.cs

@@ -1,8 +1,4 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Markdown.MAML.Model.Markdown
 {

src/Markdown.MAML/Model/Markdown/SourceExtent.cs

@@ -1,5 +1,5 @@
-
-using System.Diagnostics;
+using System.Diagnostics;
+
 namespace Markdown.MAML.Model.Markdown
 {
     public class SourceRange

src/Markdown.MAML/Model/YAML/YamlCommand.cs

@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using System.Collections.Generic;
 
 namespace Markdown.MAML.Model.YAML
 {

src/Markdown.MAML/Parser/MarkdownParser.cs

@@ -58,6 +58,7 @@ public MarkdownParser(Action<int, int> progressCallback) : this(progressCallback
         public MarkdownParser(Action<int, int> progressCallback, int reportByteCount)
         {
             _progressCallback = progressCallback;
+            _reportByteCount = reportByteCount;
         }
 
         public DocumentNode ParseString(string[] markdownStrings)

src/Markdown.MAML/Parser/MarkdownPattern.cs

@@ -1,10 +1,6 @@
 using Markdown.MAML.Model.Markdown;
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using System.Text.RegularExpressions;
-using System.Threading.Tasks;
 
 namespace Markdown.MAML.Parser
 {

src/Markdown.MAML/Properties/AssemblyInfo.cs

@@ -0,0 +1,3 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleToAttribute("Markdown.MAML.Test")]

src/Markdown.MAML/Renderer/RenderCleaner.cs

@@ -1,13 +1,8 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using System.Text.RegularExpressions;
+using System.Text.RegularExpressions;
 
 namespace Markdown.MAML.Renderer
 {
-    static public class RenderCleaner
+    internal static class RenderCleaner
     {
         /// <summary>
         /// This method runs all of the normalization tools in the cleaner. This allows full normalization without needing to call

src/Markdown.MAML/Renderer/YamlRenderer.cs

@@ -1,11 +1,7 @@
-using System;
-using System.Collections.Generic;
+using Markdown.MAML.Model.MAML;
+using Markdown.MAML.Model.YAML;
 using System.IO;
 using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using Markdown.MAML.Model.MAML;
-using Markdown.MAML.Model.YAML;
 using YamlDotNet.Serialization;
 using YamlDotNet.Serialization.NamingConventions;
 

src/Markdown.MAML/Transformer/MamlComparer.cs

@@ -1,6 +1,5 @@
-using System;
+using Markdown.MAML.Model.MAML;
 using System.Collections.Generic;
-using Markdown.MAML.Model.MAML;
 
 namespace Markdown.MAML.Transformer
 {

src/Markdown.MAML/Transformer/MamlModelMerger.cs

@@ -1,11 +1,7 @@
 using Markdown.MAML.Model.MAML;
-using Markdown.MAML.Model.Markdown;
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using System.Text.RegularExpressions;
-using System.Threading.Tasks;
 
 namespace Markdown.MAML.Transformer
 {

src/Markdown.MAML/Transformer/MamlMultiModelMerger.cs

@@ -1,11 +1,9 @@
 using Markdown.MAML.Model.MAML;
 using Markdown.MAML.Model.Markdown;
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
-using System.Text.RegularExpressions;
 
 namespace Markdown.MAML.Transformer
 {

src/Markdown.MAML/Transformer/ModelTransformerBase.cs

@@ -1,11 +1,10 @@
-using System;
-using System.Linq;
-using System.Collections.Generic;
-using System.Text;
+using Markdown.MAML.Model.MAML;
 using Markdown.MAML.Model.Markdown;
-using Markdown.MAML.Model.MAML;
 using Markdown.MAML.Parser;
-using System.Text.RegularExpressions;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
 
 namespace Markdown.MAML.Transformer
 {

src/Markdown.MAML/Transformer/ModelTransformerVersion2.cs

@@ -292,7 +292,7 @@ private Dictionary<string, string> ParseYamlKeyValuePairs(CodeBlockNode yamlSnip
             {
                 result = MarkdownParser.ParseYamlKeyValuePairs(yamlSnippet.Text);
             }
-            catch (ArgumentException e)
+            catch (ArgumentException)
             {
                 throw new HelpSchemaException(yamlSnippet.SourceExtent, "Invalid yaml: expected simple key-value pairs");
             }

src/Markdown.MAML/packages.config

@@ -36,11 +36,11 @@ This is an example description.
 This is example 2 remark.
 ");
             string[] name = GetXmlContent(maml, "/msh:helpItems/command:command/command:details/command:name");
-            Assert.Equal(1, name.Length);
+            Assert.Single(name);
             Assert.Equal("Get-Foo", name[0]);
 
             string[] synopsis = GetXmlContent(maml, "/msh:helpItems/command:command/command:details/maml:description/maml:para");
-            Assert.Equal(1, synopsis.Length);
+            Assert.Single(synopsis);
             Assert.Equal("This is Synopsis", synopsis[0]);
 
             // Check that example title is reproduced with dash (-) padding
@@ -204,11 +204,11 @@ This is Synopsis #hashtagNotAHeader.
 ");
 
             string[] description = GetXmlContent(maml, "/msh:helpItems/command:command/maml:description/maml:para");
-            Assert.Equal(1, description.Length);
+            Assert.Single(description);
             Assert.Equal("I'm description", description[0]);
 
             string[] synopsis = GetXmlContent(maml, "/msh:helpItems/command:command/command:details/maml:description/maml:para");
-            Assert.Equal(1, synopsis.Length);
+            Assert.Single(synopsis);
             Assert.Equal("This is Synopsis #hashtagNotAHeader.", synopsis[0]);
         }
 

test/Markdown.MAML.Test/App.config

@@ -3,6 +3,10 @@
     <TargetFramework>netcoreapp2.0</TargetFramework>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
+  <PropertyGroup>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors />
+  </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="System.Xml.XPath" Version="4.3.0" />
     <PackageReference Include="System.Xml.XmlDocument" Version="4.3.0" />
@@ -13,7 +17,6 @@
     <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />
     <DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
   </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\..\src\Markdown.MAML\Markdown.MAML.csproj" />
   </ItemGroup>