OSOE-150: Add PowerShell static code analysis

.gitignore

@@ -10,4 +10,4 @@ node_modules/
 .pnpm-debug.log
 .ps1-analyzer-stamp
 /TestSolutions/Lombiq.Analyzers.PowerShell.*/Violate-Analyzers.ps1
-/TestSolutions/*/.editorconfig
+.editorconfig

Lombiq.Analyzers.PowerShell.sln

@@ -5,6 +5,13 @@ VisualStudioVersion = 16.0.30114.105
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Lombiq.Analyzers.PowerShell", "Lombiq.Analyzers.PowerShell\Lombiq.Analyzers.PowerShell.csproj", "{8802AF0F-D4CA-4ABA-8408-F4433013FF7B}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "GitHub Workflows", "GitHub Workflows", "{A44B4000-AF9F-47DD-A785-4778B6179090}"
+	ProjectSection(SolutionItems) = preProject
+		E:\aux_c\repositories\orchard-core\Open-Source-Orchard-Core-Extensions3\tools\Lombiq.Analyzers.PowerShell\.github\workflows\publish-nuget.yml = E:\aux_c\repositories\orchard-core\Open-Source-Orchard-Core-Extensions3\tools\Lombiq.Analyzers.PowerShell\.github\workflows\publish-nuget.yml
+		E:\aux_c\repositories\orchard-core\Open-Source-Orchard-Core-Extensions3\tools\Lombiq.Analyzers.PowerShell\.github\workflows\test-analysis-failure.yml = E:\aux_c\repositories\orchard-core\Open-Source-Orchard-Core-Extensions3\tools\Lombiq.Analyzers.PowerShell\.github\workflows\test-analysis-failure.yml
+		E:\aux_c\repositories\orchard-core\Open-Source-Orchard-Core-Extensions3\tools\Lombiq.Analyzers.PowerShell\.github\workflows\verify-submodule-pull-request.yml = E:\aux_c\repositories\orchard-core\Open-Source-Orchard-Core-Extensions3\tools\Lombiq.Analyzers.PowerShell\.github\workflows\verify-submodule-pull-request.yml
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

Lombiq.Analyzers.PowerShell/Invoke-Analyzer.ps1

@@ -75,7 +75,7 @@ if ((Get-InstalledModule PSScriptAnalyzer -ErrorAction SilentlyContinue).Version
 {
     try
     {
-        # Attempt to install it automatically. This will fail on Windows Powershell becuase you have to be admin.
+        # Attempt to install it automatically. This will fail on Windows PowerShell because you have to be admin.
         Install-Module -Name PSScriptAnalyzer -Force -RequiredVersion $installVersion
     }
     catch

Lombiq.Analyzers.PowerShell/Lombiq.Analyzers.PowerShell.csproj

@@ -1,5 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
+  <!-- This csproj file is only needed for NuGet package creation and to make the files visible in IDE. It doesn't
+       contain anything that needs to be built. -->
+
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <DefaultItemExcludes>$(DefaultItemExcludes);.git*</DefaultItemExcludes>

Readme.md

@@ -5,7 +5,7 @@
 
 ## About
 
-PowerShell static code analysis via [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer)  and [Lombiq's recommended configuration for it](Lombiq.Analyzers.PowerShell/PSScriptAnalyzerSettings.psd1).
+PowerShell static code analysis via [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) and [Lombiq's recommended configuration for it](Lombiq.Analyzers.PowerShell/PSScriptAnalyzerSettings.psd1).
 
 Do you want to quickly try out this project and see it in action? Check it out in our [Open-Source Orchard Core Extensions](https://github.com/Lombiq/Open-Source-Orchard-Core-Extensions) full Orchard Core solution and also see our other useful Orchard Core-related open-source projects!
 
@@ -55,6 +55,8 @@ If this project is included via a submodule, edit the _csproj_ file of your prim
 <Import Project="path\to\Lombiq.Analyzers.PowerShell\Lombiq.Analyzers.PowerShell.targets" />
 ```
 
+You don't need to `<ProjectReference>` _Lombiq.Analyzers.PowerShell.csproj_.
+
 If you include the project as a NuGet package, it will work as-is.
 
 Additionally, you can set these properties in the importing project's `<PropertyGroup>`:
@@ -68,6 +70,10 @@ Live analysis is outside of the scope of this project, however you can use the V
 2. Go to Settings and paste `powershell.scriptAnalysis.settingsPath` into the search bar.
 3. Set it to the path of the _PSScriptAnalyzerSettings.psd1_ file to use our settings.
 
+### Suppressing PSScriptAnalyzer rules
+
+Occasionally there is good reason to ignore an analyzer warning. In this case add the `[Diagnostics.CodeAnalysis.SuppressMessage('Rule Code', Justification = 'Explain reason.')]` attribute to the cmdlet's `param()`. For more information, see the module's [documentation](https://docs.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer?view=ps-modules#suppressing-rules).
+
 ## Contributing and support
 
 Bug reports, feature requests, comments, questions, code contributions, and love letters are warmly welcome, please do so via GitHub issues and pull requests. Please adhere to our [open-source guidelines](https://lombiq.com/open-source-guidelines) while doing so.