Finishing up fix PowerShell#122

Use empty string now to get the default (built-in) settings for script analysis. Tweaked the build script to fix some problems and to exclude the script analysis settings file. Also changed encoding the SampleModule.psd1 file to UTF8.

Author: rkeithhill

.vscode/tasks.json

@@ -31,7 +31,7 @@
  // we run the custom script "compile" as defined in package.json
  "args": ["run", "compile"],
 
- // use the standard tsc problem matcher to find compile problems in the output.
+  // use the standard tsc problem matcher to find compile problems in the output.
  "problemMatcher": "$tsc"
  },
  {
@@ -47,7 +47,7 @@
  // The tsc compiler is started in watching mode
  "isWatching": true,
 
- // use the standard tsc in watch mode problem matcher to find compile problems in the output.
+  // use the standard tsc in watch mode problem matcher to find compile problems in the output.
  "problemMatcher": "$tsc-watch"
  }
  ]

examples/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+ // Use a custom PowerShell Script Analyzer settings file for this workspace.
+ // Relative paths for this setting are always relative to the workspace root dir.
+ "powershell.scriptAnalysis.settingsPath": "./PSScriptAnalyzerSettings.psd1"
+}

examples/Build.ps1

@@ -65,27 +65,30 @@
 ###############################################################################
 Properties {
  # The name of your module should match the basename of the PSD1 file.
- $ModuleName = (Get-Item $PSScriptRoot\*.psd1)[0].BaseName
+ $ModuleName = (Get-Item $PSScriptRoot\*.psd1 |
+ Foreach-Object {$null = Test-ModuleManifest -Path $_ -ErrorAction SilentlyContinue; if ($?) {$_}})[0].BaseName
 
  # Path to the release notes file. Set to $null if the release notes reside in the manifest file.
  $ReleaseNotesPath = "$PSScriptRoot\ReleaseNotes.md"
 
  # The directory used to publish the module from. If you are using Git, the
- # $PublishDir should be ignored if it is under the workspace directory.
- $PublishDir = "$PSScriptRoot\Release\$ModuleName"
+ # $PublishRootDir should be ignored if it is under the workspace directory.
+ $PublishRootDir = "$PSScriptRoot\Release"
+ $PublishDir = "$PublishRootDir\$ModuleName"
 
  # The following items will not be copied to the $PublishDir.
  # Add items that should not be published with the module.
  $Exclude = @(
+ (Split-Path $PSCommandPath -Leaf),
  'Release',
  'Tests',
  '.git*',
  '.vscode',
- # The next three files are unique to this examples dir.
+ # These files are unique to this examples dir.
  'DebugTest.ps1',
- 'Stop*.ps1',
+ 'PSScriptAnalyzerSettings.psd1',
  'Readme.md',
- (Split-Path $PSCommandPath -Leaf)
+ 'Stop*.ps1'
  )
 
  # Name of the repository you wish to publish to. Default repo is the PSGallery.
@@ -170,8 +173,8 @@ Task Clean -depends Init -requiredVariables PublishDir {
  # Sanity check the dir we are about to "clean". If $PublishDir were to
  # inadvertently get set to $null, the Remove-Item commmand removes the
  # contents of \*. That's a bad day. Ask me how I know? :-(
- if ($PublishDir.Contains($PSScriptRoot)) {
- Remove-Item $PublishDir\* -Recurse -Force
+ if ($PublishRootDir.Contains($PSScriptRoot)) {
+ Remove-Item $PublishRootDir\* -Recurse -Force
  }
 }
 

PSScriptAnalyzerSettings.psd1 renamed to examples/PSScriptAnalyzerSettings.psd1

@@ -247,8 +247,8 @@
  },
  "powershell.scriptAnalysis.settingsPath": {
  "type": "string",
- "default": "./PSScriptAnalyzerSettings.psd1",
- "description": "Specifies the path to the PowerShell Script Analyzer settings file. The settings file can be used to customize which rules to include or exclude as well as what severity levels to report."
+ "default": "",
+ "description": "Specifies the path to a PowerShell Script Analyzer settings file. Use either an absolute path (to override the default settings for all projects) or use a path relative to your workspace."
  },
  "powershell.developer.editorServicesHostPath": {
  "type": "string",

examples/SampleModule.psd1

@@ -86,8 +86,6 @@ export function activate(context: vscode.ExtensionContext): void {
 
  try
  {
- settings.scriptAnalysis.settingsPath = resolveScriptAnalysisSettingsPath(settings);
-
  let serverPath = resolveLanguageServerPath(settings);
  let serverOptions = {
  run: {
@@ -180,35 +178,6 @@ function resolveLanguageServerPath(settings: settingsManager.ISettings): string
  return editorServicesHostPath;
 }
 
-function resolveScriptAnalysisSettingsPath(settings: settingsManager.ISettings): string {
- var scriptAnalysisSettingsPath = settings.scriptAnalysis.settingsPath;
-
- if (scriptAnalysisSettingsPath) {
- console.log("Found scriptAnalysis.settingsPath from config: " + scriptAnalysisSettingsPath);
-
- // Make the path absolute if it's not
- scriptAnalysisSettingsPath =
- path.resolve(
- __dirname,
- '..',
- scriptAnalysisSettingsPath);
-
- console.log(" Resolved path to: " + scriptAnalysisSettingsPath);
- }
- else {
- // Use the default path in the extension's 'root' folder
- scriptAnalysisSettingsPath =
- path.join(
- __dirname,
- '..',
- 'PSScriptAnalyzerSettings.psd1');
-
- console.log("Using default scriptAnalysis.settingsPath: " + scriptAnalysisSettingsPath);
- }
-
- return scriptAnalysisSettingsPath;
-}
-
 function getHostExeName(useX86Host: boolean): string {
  // The useX86Host setting is only relevant on 64-bit OS
  var is64BitOS = process.env.hasOwnProperty('PROCESSOR_ARCHITEW6432');