#Requires syntax highlighting bug

Open
#210 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
powershell
Domain
tooling

Research direction

Reproduce the issue in a .ps1 file with #Requires Microsoft365DSC, then inspect the EditorSyntax grammar entry that handles #Requires and module names. Done means the full module name remains syntax-highlighted rather than treating characters after 365 as a comment.

Written by the indexing model from the issue text.

Description

Prerequisites
  • I have written a descriptive issue title.
  • I have searched all 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.
Summary

There is the #Requires syntax highlighting bug. If there is some module with letters and numbers in module name, add-in highlights part with first block of letters and numbers and the rest chars highlight as a comment.
You can reproduce the issue if add the code below to ps1 file

#Requires Microsoft365DSC

Will be highlighted only the part of the module name. All characters follow after 365 will be highlighted as comment.
The funny thing, is that the module name highlighted in the same manner on github as well 😁

PowerShell Version
Name                           Value
----                           -----
PSVersion                      7.1.3
PSEdition                      Core
GitCommitId                    7.1.3
OS                             Microsoft Windows 10.0.19042
Platform                       Win32NT
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.63.2
899d46d82c4c95423fb7e10e68eba52050e30ba3
x64
Extension Version
ms-vscode.powershell@2021.12.0
Steps to Reproduce

You can reproduce the issue if add the code below to ps1 file

#Requires Microsoft365DSC
Visuals

No response

Logs

No response

Dominant language
PowerShell
Stars
151
Forks
55
No merged PRs in 30d

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.

More from PowerShell/EditorSyntax

All issues in PowerShell/EditorSyntax

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.