Configured Linter and fixed detected errors

FelixSelter · FelixSelter · commit 9dd4df097df8 · 2022-08-18T16:25:37.000+02:00
diff --git a/PSScriptAnalyzerSettings.psd1 b/PSScriptAnalyzerSettings.psd1
@@ -0,0 +1,36 @@
+@{
+    # Use Severity when you want to limit the generated diagnostic records to a
+    # subset of: Error, Warning and Information.
+    # Uncomment the following line if you only want Errors and Warnings but
+    # not Information diagnostic records.
+    Severity     = @('Error', 'Warning')
+ 
+    # Use IncludeRules when you want to run only a subset of the default rule set.
+    #IncludeRules = @('PSAvoidDefaultValueSwitchParameter',
+    #                 'PSMissingModuleManifestField',
+    #                 'PSReservedCmdletChar',
+    #                 'PSReservedParams',
+    #                 'PSShouldProcess',
+    #                 'PSUseApprovedVerbs',
+    #                 'PSUseDeclaredVarsMoreThanAssigments')
+ 
+    # Use ExcludeRules when you want to run most of the default set of rules except
+    # for a few rules you wish to "exclude".  Note: if a rule is in both IncludeRules
+    # and ExcludeRules, the rule will be excluded.
+    ExcludeRules = @(
+        'PSAvoidUsingWriteHost',
+        'PSMissingModuleManifestField'
+    )
+ 
+    # You can use the following entry to supply parameters to rules that take parameters.
+    # For instance, the PSAvoidUsingCmdletAliases rule takes a whitelist for aliases you
+    # want to allow.
+    #Rules = @{
+    #    Do not flag 'cd' alias.
+    #    PSAvoidUsingCmdletAliases = @{Whitelist = @('cd')}
+ 
+    #    Check if your script uses cmdlets that are compatible on PowerShell Core,
+    #    version 6.0.0-alpha, on Linux.
+    #    PSUseCompatibleCmdlets = @{Compatibility = @("core-6.0.0-alpha-linux")}
+    #}
+}
diff --git a/src/jenv-add.psm1 b/src/jenv-add.psm1
@@ -8,7 +8,7 @@ function Invoke-Add {
 
     if ($help) {
         Write-Host '"jenv add" <name> <path>'
-        Write-Host With this command you can tell JEnv which java versions you have installed
+        Write-Host "With this command you can tell JEnv which java versions you have installed"
         Write-Host '<name> is an alias you have to give the java version for easier referencing. It cannot be remove'
         Write-Host '<path> is the path to the parent of your bin folder. For example: "C:\Program Files\Java\jdk-17"'
         Write-Host 'You have to register your JEnvs first before you can use "jenv change", "jenv use" or "jenv local"'
@@ -30,7 +30,6 @@ function Invoke-Add {
                 return
             }
         }
-    
         # Check if the path is a valid java home
         if (!(Test-Path -Path $path/bin/java.exe -PathType Leaf)) {
             Write-Output ($path + "/bin/java.exe not found. Your Path is not a valid JAVA_HOME")
diff --git a/src/jenv-change.psm1 b/src/jenv-change.psm1
@@ -8,26 +8,26 @@ function Invoke-Change {
 
     if ($help) {
         Write-Host '"jenv change <name>"'
-        Write-Host 'With this command you set your JAVA_HOME and the version of java to be used globally. This is overwriten by both "jenv local" and "jenv use"' 
-        Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'    
+        Write-Host 'With this command you set your JAVA_HOME and the version of java to be used globally. This is overwriten by both "jenv local" and "jenv use"'
+        Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'
     }
     else {
 
         # Check if specified JEnv is avaible
         $jenv = $config.jenvs | Where-Object { $_.name -eq $name }
         if ($null -eq $jenv) {
-            Write-Host Theres no JEnv with name $name Consider using "jenv list"
+            Write-Host 'Theres no JEnv with name {0} Consider using "jenv list"' -f $name
             return
         }
         else {
-            Write-Host Setting JAVA_HOME globally. This could take some time
+            Write-Host "Setting JAVA_HOME globally. This could take some time"
             $config.global = $jenv.path
             $Env:JAVA_HOME = $jenv.path # Set for powershell users
             if ($output) {
                 Set-Content -path "jenv.home.tmp" -value $jenv.path # Create temp file so no restart of the active shell is required
             }
             [System.Environment]::SetEnvironmentVariable("JAVA_HOME", $jenv.path, [System.EnvironmentVariableTarget]::User) # Set globally}
-            Write-Host JEnv changed globally
+            Write-Host "JEnv changed globally"
         }
     }
 }
diff --git a/src/jenv-getjava.psm1 b/src/jenv-getjava.psm1
@@ -3,7 +3,7 @@ function Get-Java {
     param (
         [object]$config
     )
-    
+
     $global = $config.global
     $localname = ($config.locals | Where-Object { $_.path -eq (Get-Location) }).name
     $local = ($config.jenvs | Where-Object { $_.name -eq $localname }).path
diff --git a/src/jenv-link.psm1 b/src/jenv-link.psm1
@@ -1,13 +1,12 @@
 function Invoke-Link {
     param (
-        [Parameter(Mandatory = $true)][object]$config,
         [Parameter(Mandatory = $true)][boolean]$help,
         [Parameter(Mandatory = $true)][string]$executable
     )
 
     if ($help) {
         Write-Host '"jenv link" <executable>'
-        Write-Host With this command you can create shortcuts for executables inside JAVA_HOME
+        Write-Host "With this command you can create shortcuts for executables inside JAVA_HOME"
         Write-Host '<executable> is the name of the binary file for example "javac" or "javaw"'
         Write-Host 'For example enable javac with: "jenv link javac"'
         Write-Host 'List all registered java versions with "jenv list"'
@@ -17,7 +16,7 @@ function Invoke-Link {
         $payload = @'
         @echo off
         for /f "delims=" %%i in ('jenv getjava') do set "var=%%i"
-        
+
         if exist "%var%/bin/{0}.exe" (
             "%var%/bin/{0}.exe" %*
         ) else (
@@ -26,7 +25,7 @@ function Invoke-Link {
         )
 '@ -f $executable
 
-        Set-Content ((get-item $PSScriptRoot).parent.fullname + "/$executable.bat") $payload 
+        Set-Content ((get-item $PSScriptRoot).parent.fullname + "/$executable.bat") $payload
 
     }
 }
diff --git a/src/jenv-list.psm1 b/src/jenv-list.psm1
@@ -6,17 +6,17 @@ function Invoke-List {
 
     if ($help) {
         Write-Host '"jenv list"'
-        Write-Host This command will display every added java version as well as its name
+        Write-Host "This command will display every added java version as well as its name"
         Write-Host 'You have to add java versions with "jenv add"'
         Write-Host 'Then you can set them with various commands like "jenv use" or "jenv change"'
-        Write-Host This command will also tell you every local JEnv that you specified
+        Write-Host "This command will also tell you every local JEnv that you specified"
         Write-Host 'You can tell JEnv that it should always use jdk8 on the desktop with "jenv local"'
     }
     else {
 
-        Write-Host All avaible versions of java
+        Write-Host "All avaible versions of java"
         Write-Host ($config.jenvs | Format-Table | Out-String)
-        Write-Host All locally specified versions
+        Write-Host "All locally specified versions"
         Write-Host ($config.locals | Format-Table | Out-String)
     }
 
diff --git a/src/jenv-local.psm1 b/src/jenv-local.psm1
@@ -2,7 +2,6 @@ function Invoke-Local {
     param(
         [Parameter(Mandatory = $true)][object]$config,
         [Parameter(Mandatory = $true)][boolean]$help,
-        [Parameter(Mandatory = $true)][boolean]$output,
         [Parameter(Mandatory = $true)][string]$name
     )
 
@@ -11,7 +10,7 @@ function Invoke-Local {
         Write-Host 'This command allows you to specify a java version that will always be used in this folder and all subfolders'
         Write-Host 'This is overwriten by "jenv use"'
         Write-Host '<name> is the alias of the JEnv you want to specify'
-        Write-Host Attention! You might have to call jenv first before it changes your JAVA_HOME to the local environment. The java command will work out of the box
+        Write-Host "Attention! You might have to call jenv first before it changes your JAVA_HOME to the local environment. The java command will work out of the box"
     }
     else {
 
@@ -34,7 +33,7 @@ function Invoke-Local {
             if ($jenv.path -eq (Get-Location)) {
                 # if path is used replace with new version
                 $jenv.name = $name
-                Write-Output "Your replaced your java version for" (Get-Location) with $name
+                Write-Output "Your replaced your java version for {0} {1}" -f (Get-Location), $name
                 return
             }
         }
@@ -45,6 +44,6 @@ function Invoke-Local {
             name = $name
         }
 
-        Write-Output $name "is now your local java version for" (Get-Location)
+        Write-Output "{0} is now your local java version for {1}" -f (Get-Location), $name
     }
 }
diff --git a/src/jenv-remove.psm1 b/src/jenv-remove.psm1
@@ -7,11 +7,11 @@ function Invoke-Remove {
 
     if ($help) {
         Write-Host '"jenv remove" <name>'
-        Write-Host 'With this command you can remove any java version you registered with "jenv add"' 
-        Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'     
+        Write-Host 'With this command you can remove any java version you registered with "jenv add"'
+        Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'
     }
     else {
-        # Remove the JEnv        
+        # Remove the JEnv
         $config.jenvs = @($config.jenvs | Where-Object { $_.name -ne $name })
         # Remove any jenv local with that name
         $config.locals = @($config.locals | Where-Object { $_.name -ne $name })
diff --git a/src/jenv-use.psm1 b/src/jenv-use.psm1
@@ -8,9 +8,9 @@ function Invoke-Use {
 
     if ($help) {
         Write-Host '"jenv use <name>"'
-        Write-Host 'With this command you set your JAVA_HOME and the version of java to be used by your current shell session.' 
-        Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'    
-        Write-Host Careful this overwrites "jenv local"
+        Write-Host 'With this command you set your JAVA_HOME and the version of java to be used by your current shell session.'
+        Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'
+        Write-Host 'Careful this overwrites "jenv local"'
     }
     else {
 
@@ -20,15 +20,15 @@ function Invoke-Use {
             if ($output) {
                 Set-Content -path "jenv.use.tmp" -value "remove" # Create temp file so no restart of the active shell is required
             }
-            Write-Host Your session JEnv was unset
+            Write-Host "Your session JEnv was unset"
             return
         }
 
 
         # Check if specified JEnv is avaible
         $jenv = $config.jenvs | Where-Object { $_.name -eq $name }
         if ($null -eq $jenv) {
-            Write-Host Theres no JEnv with name $name Consider using "jenv list"
+            Write-Host 'Theres no JEnv with name {0} Consider using "jenv list"' -f  $name
             return
         }
         else {
@@ -38,7 +38,7 @@ function Invoke-Use {
                 Set-Content -path "jenv.home.tmp" -value $jenv.path # Create temp file so no restart of the active shell is required
                 Set-Content -path "jenv.use.tmp" -value $jenv.path # Create temp file so no restart of the active shell is required
             }
-            Write-Host JEnv changed for the current shell session. Careful this overwrites "jenv local"
+            Write-Host 'JEnv changed for the current shell session. Careful this overwrites "jenv local"'
         }
     }
 }
diff --git a/src/jenv.ps1 b/src/jenv.ps1
@@ -19,7 +19,7 @@ param (
     "jenv local <name>"         Will use the given Java-Version whenever in this folder. Will set the Java-version for all subfolders as well
     #>
     [Parameter(Position = 0)][validateset("list", "add", "change", "use", "remove", "local", "getjava", "link")] [string]$action,
-    
+
     # Displays this helpful message
     [Alias("h")]
     [Switch]$help,
@@ -63,7 +63,7 @@ if ($javaPaths.Length -gt 0) {
         [System.Environment]::SetEnvironmentVariable("PATH", $systemPath, [System.EnvironmentVariableTarget]::Machine) # Set globally
     }
     catch [System.Management.Automation.MethodInvocationException] {
-        Write-Host JEnv wants to change your system environment vars. Therefore you need to restart it with administration rights. This should only once be required. If you dont want to, you have to call JEnv on every terminal opening to change your session vars
+        Write-Host "JEnv wants to change your system environment vars. Therefore you need to restart it with administration rights. This should only once be required. If you dont want to, you have to call JEnv on every terminal opening to change your session vars"
     }
     $path = $userPath + ";" + $systemPath
 
@@ -109,7 +109,7 @@ if (!($config | Get-Member global)) {
 $localname = ($config.locals | Where-Object { $_.path -eq (Get-Location) }).name
 $javahome = ($config.jenvs | Where-Object { $_.name -eq $localname }).path
 if ($null -eq $local) {
-    $javahome = $config.global 
+    $javahome = $config.global
 }
 $Env:JAVA_HOME = $javahome # Set for powershell users
 if ($output) {
@@ -137,9 +137,9 @@ else {
         remove { Invoke-Remove $config $help @arguments }
         use { Invoke-Use $config $help $output @arguments }
         change { Invoke-Change $config $help $output @arguments }
-        local { Invoke-Local $config $help $output @arguments } 
-        getjava { Get-Java $config } 
-        link { Invoke-Link $config $help @arguments } 
+        local { Invoke-Local $config $help @arguments }
+        getjava { Get-Java $config }
+        link { Invoke-Link $help @arguments }
     }
 
     #region Save the config

Original file line number	Diff line number	Diff line change
`@@ -8,26 +8,26 @@ function Invoke-Change {`
`8`	`8`
`9`	`9`	`if ($help) {`
`10`	`10`	`Write-Host '"jenv change <name>"'`
`11`		`- Write-Host 'With this command you set your JAVA_HOME and the version of java to be used globally. This is overwriten by both "jenv local" and "jenv use"'`
`12`		`- Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'`
	`11`	`+ Write-Host 'With this command you set your JAVA_HOME and the version of java to be used globally. This is overwriten by both "jenv local" and "jenv use"'`
	`12`	`+ Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'`
`13`	`13`	`}`
`14`	`14`	`else {`
`15`	`15`
`16`	`16`	`# Check if specified JEnv is avaible`
`17`	`17`	`$jenv = $config.jenvs \| Where-Object { $_.name -eq $name }`
`18`	`18`	`if ($null -eq $jenv) {`
`19`		`- Write-Host Theres no JEnv with name $name Consider using "jenv list"`
	`19`	`+ Write-Host 'Theres no JEnv with name {0} Consider using "jenv list"' -f $name`
`20`	`20`	`return`
`21`	`21`	`}`
`22`	`22`	`else {`
`23`		`- Write-Host Setting JAVA_HOME globally. This could take some time`
	`23`	`+ Write-Host "Setting JAVA_HOME globally. This could take some time"`
`24`	`24`	`$config.global = $jenv.path`
`25`	`25`	`$Env:JAVA_HOME = $jenv.path # Set for powershell users`
`26`	`26`	`if ($output) {`
`27`	`27`	`Set-Content -path "jenv.home.tmp" -value $jenv.path # Create temp file so no restart of the active shell is required`
`28`	`28`	`}`
`29`	`29`	`[System.Environment]::SetEnvironmentVariable("JAVA_HOME", $jenv.path, [System.EnvironmentVariableTarget]::User) # Set globally}`
`30`		`- Write-Host JEnv changed globally`
	`30`	`+ Write-Host "JEnv changed globally"`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ function Get-Java {`
`3`	`3`	`param (`
`4`	`4`	`[object]$config`
`5`	`5`	`)`
`6`		`-`
	`6`	`+`
`7`	`7`	`$global = $config.global`
`8`	`8`	`$localname = ($config.locals \| Where-Object { $_.path -eq (Get-Location) }).name`
`9`	`9`	`$local = ($config.jenvs \| Where-Object { $_.name -eq $localname }).path`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@ function Invoke-Local {`
`2`	`2`	`param(`
`3`	`3`	`[Parameter(Mandatory = $true)][object]$config,`
`4`	`4`	`[Parameter(Mandatory = $true)][boolean]$help,`
`5`		`- [Parameter(Mandatory = $true)][boolean]$output,`
`6`	`5`	`[Parameter(Mandatory = $true)][string]$name`
`7`	`6`	`)`
`8`	`7`
`@@ -11,7 +10,7 @@ function Invoke-Local {`
`11`	`10`	`Write-Host 'This command allows you to specify a java version that will always be used in this folder and all subfolders'`
`12`	`11`	`Write-Host 'This is overwriten by "jenv use"'`
`13`	`12`	`Write-Host '<name> is the alias of the JEnv you want to specify'`
`14`		`- Write-Host Attention! You might have to call jenv first before it changes your JAVA_HOME to the local environment. The java command will work out of the box`
	`13`	`+ Write-Host "Attention! You might have to call jenv first before it changes your JAVA_HOME to the local environment. The java command will work out of the box"`
`15`	`14`	`}`
`16`	`15`	`else {`
`17`	`16`
`@@ -34,7 +33,7 @@ function Invoke-Local {`
`34`	`33`	`if ($jenv.path -eq (Get-Location)) {`
`35`	`34`	`# if path is used replace with new version`
`36`	`35`	`$jenv.name = $name`
`37`		`- Write-Output "Your replaced your java version for" (Get-Location) with $name`
	`36`	`+ Write-Output "Your replaced your java version for {0} {1}" -f (Get-Location), $name`
`38`	`37`	`return`
`39`	`38`	`}`
`40`	`39`	`}`
`@@ -45,6 +44,6 @@ function Invoke-Local {`
`45`	`44`	`name = $name`
`46`	`45`	`}`
`47`	`46`
`48`		`- Write-Output $name "is now your local java version for" (Get-Location)`
	`47`	`+ Write-Output "{0} is now your local java version for {1}" -f (Get-Location), $name`
`49`	`48`	`}`
`50`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@ function Invoke-Use {`
`8`	`8`
`9`	`9`	`if ($help) {`
`10`	`10`	`Write-Host '"jenv use <name>"'`
`11`		`- Write-Host 'With this command you set your JAVA_HOME and the version of java to be used by your current shell session.'`
`12`		`- Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'`
`13`		`- Write-Host Careful this overwrites "jenv local"`
	`11`	`+ Write-Host 'With this command you set your JAVA_HOME and the version of java to be used by your current shell session.'`
	`12`	`+ Write-Host '<name> is the alias you asigned to the path with "jenv add <name> <path>"'`
	`13`	`+ Write-Host 'Careful this overwrites "jenv local"'`
`14`	`14`	`}`
`15`	`15`	`else {`
`16`	`16`
`@@ -20,15 +20,15 @@ function Invoke-Use {`
`20`	`20`	`if ($output) {`
`21`	`21`	`Set-Content -path "jenv.use.tmp" -value "remove" # Create temp file so no restart of the active shell is required`
`22`	`22`	`}`
`23`		`- Write-Host Your session JEnv was unset`
	`23`	`+ Write-Host "Your session JEnv was unset"`
`24`	`24`	`return`
`25`	`25`	`}`
`26`	`26`
`27`	`27`
`28`	`28`	`# Check if specified JEnv is avaible`
`29`	`29`	`$jenv = $config.jenvs \| Where-Object { $_.name -eq $name }`
`30`	`30`	`if ($null -eq $jenv) {`
`31`		`- Write-Host Theres no JEnv with name $name Consider using "jenv list"`
	`31`	`+ Write-Host 'Theres no JEnv with name {0} Consider using "jenv list"' -f $name`
`32`	`32`	`return`
`33`	`33`	`}`
`34`	`34`	`else {`
`@@ -38,7 +38,7 @@ function Invoke-Use {`
`38`	`38`	`Set-Content -path "jenv.home.tmp" -value $jenv.path # Create temp file so no restart of the active shell is required`
`39`	`39`	`Set-Content -path "jenv.use.tmp" -value $jenv.path # Create temp file so no restart of the active shell is required`
`40`	`40`	`}`
`41`		`- Write-Host JEnv changed for the current shell session. Careful this overwrites "jenv local"`
	`41`	`+ Write-Host 'JEnv changed for the current shell session. Careful this overwrites "jenv local"'`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`	`}`