PowerShell / PowerShell/vscode-powershell

Missing Problems entries for PSUseToExportFieldsInManifest in .psd1 manifests

Open
#5,112 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Bug Needs: Maintainer Attention
Dominant language
TypeScript
Stars
1.9k
Forks
547
PR merge metrics
No merged PRs in 30d

Description

Prerequisites
  • I have written a descriptive issue title.
  • I have searched all open and closed issues to ensure it has not already been reported.
  • I have read the troubleshooting guide.
  • I am sure this issue is with the extension itself and does not reproduce in a standalone PowerShell instance.
  • I have verified that I am using the latest version of Visual Studio Code and the PowerShell extension.
  • If this is a security issue, I have read the security issue reporting guidance.
Summary

When using VS Code and the PS extension for modifying manifests (.psd1 files), it seems that the extension doesn't surface PSScriptAnalyzer warnings for the PSUseToExportFieldsInManifest type.

https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/rules/usetoexportfieldsinmanifest?view=ps-modules

While somewhat related to the opposite intent of https://github.com/PowerShell/PSScriptAnalyzer/issues/506 , where the user can take steps to override the warnings, I think in the case where these export rules contain wildcard (the default when using native tools to generate a manifest), this warning is relevant and should be surfaced.

PowerShell Version
Name                           Value
----                           -----
PSVersion                      7.4.6
PSEdition                      Core
GitCommitId                    7.4.6
OS                             Darwin 24.1.0 Darwin Kernel Version 24.1.0: Thu Oct 10 21:03:11 PDT 2024; root:xnu-11215.41.3~2/RELEASE_ARM…
Platform                       Unix
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0
Visual Studio Code Version
1.95.3
f1a4fb101478ce6ec82fe9627c43efbf9e98c813
arm64
Extension Version
ms-vscode.powershell@2024.4.0
Steps to Reproduce

When running PSScriptAnalyzer with default settings like
Invoke-ScriptAnalyzer -Path ./ -Recurse, I do get the warnings.
image

But when opening the .psd1 manifest in VS Code, nothing is surfaced in the Problems pane.
image

Visuals

No response

Logs

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with a .psd1 manifest and compare Invoke-ScriptAnalyzer output with the VS Code Problems pane. Trace how the extension surfaces analyzer diagnostics for manifest files. Done means PSUseToExportFieldsInManifest warnings appear in Problems for the reported manifest case.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.