remove the remainders of the ressource generation script calls and do…

…cument it

.build.ps1

@@ -9,7 +9,6 @@ param(
 # todo remove aliases
 # todo make each project have its own build script
 
-$resourceScript = Join-Path $BuildRoot "New-StronglyTypedCsFileForResx.ps1"
 $outPath = "$BuildRoot/out"
 $modulePath = "$outPath/PSScriptAnalyzer"
 
@@ -109,20 +108,6 @@ function Get-TestTaskParam($project) {
     }
 }
 
-function Get-ResourceTaskParam($project) {
-    @{
-        Inputs  = "$project/Strings.resx"
-        Outputs = "$project/Strings.cs"
-        Data = $project
-        Jobs    = {
-            Push-Location $BuildRoot
-            & $resourceScript $Task.Data
-            Pop-Location
-        }
-        Before  = "$project/build"
-    }
-}
-
 function Add-ProjectTask([string]$project, [string]$taskName, [hashtable]$taskParams, [string]$pathPrefix = $buildRoot) {
     $jobs = [scriptblock]::Create(@"
 pushd $pathPrefix/$project
@@ -136,14 +121,12 @@ popd
 
 $projects = @("engine", "rules")
 $projects | ForEach-Object {
-    #Add-ProjectTask $_ buildResource (Get-ResourceTaskParam $_)
     Add-ProjectTask $_ build (Get-BuildTaskParams $_)
     Add-ProjectTask $_ restore (Get-RestoreTaskParams $_)
     Add-ProjectTask $_ clean (Get-CleanTaskParams $_)
     Add-ProjectTask $_ test (Get-TestTaskParam $_) "$BuildRoot/tests"
 }
 
-#task buildResource -Before build "engine/buildResource", "rules/buildResource"
 task build "engine/build", "rules/build"
 task restore "engine/restore", "rules/restore"
 task clean "engine/clean", "rules/clean"

New-StronglyTypedCsFileForResx.ps1

@@ -1,4 +1,8 @@
-param(
+<#
+# This script can be used to update the *.Designer file if a *.resx ressource file has been updated.
+# However, it is recommended to use Visual Studio instead for editing ressources instead since it takes of that automatically and prodcues cleaner diffs.
+#>
+param(
     [ValidateSet("Engine","Rules")]
     [string] $project
 )
@@ -132,7 +136,7 @@ if (-not (Test-Path "$projectRoot/global.json"))
     throw "Not in solution root: $projectRoot"
 }
 $inputFilePath = Join-Path $projectRoot "$project/Strings.resx"
-$outputFilePath = Join-Path $projectRoot "$project/Strings.cs"
+$outputFilePath = Join-Path $projectRoot "$project/Strings.Designer.cs"
 $className = "Microsoft.Windows.PowerShell.ScriptAnalyzer"
 if ($project -eq "Rules")
 {

README.md

@@ -83,10 +83,11 @@ Exit
 #### Requirements
 * [.NET Core 1.1.5 SDK](https://github.com/dotnet/core/blob/master/release-notes/download-archives/1.1.5.md)
 * [PlatyPS 0.5.0 or greater](https://github.com/PowerShell/platyPS)
+* Optionally but recommended for development: [Visual Studio 2017](https://www.visualstudio.com/downloads/)
 
 #### Steps
 * Obtain the source
-    - Download the latest source code from the release page (https://github.com/PowerShell/PSScriptAnalyzer/releases) OR
+    - Download the latest source code from the [release page](https://github.com/PowerShell/PSScriptAnalyzer/releases) OR
     - Clone the repository (needs git)
     ```powershell
     git clone https://github.com/PowerShell/PSScriptAnalyzer
@@ -96,7 +97,8 @@ Exit
     cd path/to/PSScriptAnalyzer
     ```
 * Building
-    You can use either build using the `Visual Studio` solution `PSScriptAnalyzer.sln` or build for your platform as follows:
+
+    You can either build using the `Visual Studio` solution `PSScriptAnalyzer.sln` or build using `PowerShell` specifically for your platform as follows:
     * Windows PowerShell version 5.0 and greater
     ```powershell
     .\buildCoreClr.ps1 -Framework net451 -Configuration Release -Build
@@ -120,6 +122,10 @@ Import-Module .\out\PSScriptAnalyzer\PSScriptAnalyzer.psd1
 
 To confirm installation: run `Get-ScriptAnalyzerRule` in the PowerShell console to obtain the built-in rules
 
+* Adding/Removing resource strings
+
+For adding/removing resource strings in the `*.resx` files, it is recommended to use `Visual Studio` since it automatically updates the strongly typed `*.Designer.cs` files. The `Visual Studio 2017 Community Edition` is free to use but should you not have/want to use `Visual Studio` then you can either manually adapt the `*.Designer.cs` files or use the `New-StronglyTypedCsFileForResx.ps1` script although the latter is discouraged since it leads to a bad diff of the `*.Designer.cs` files.
+
 #### Tests
 Pester-based ScriptAnalyzer Tests are located in `path/to/PSScriptAnalyzer/Tests` folder.