Skip to content

Commit f619b44

Browse files
committed
Add missing comment-based help keywords
Additionally, add tests for all the comment-based help keywords.
1 parent 93565f4 commit f619b44

File tree

2 files changed

+49
-2
lines changed

2 files changed

+49
-2
lines changed

PowerShell.sublime-syntax

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,8 @@ contexts:
357357
(?xi:
358358
^\s*(\.)
359359
(
360-
Component | Description | Example | ForwardHelpTargetName
361-
| Functionality | Inputs | Notes | Outputs | RemoteHelpRunSpace
360+
Component | Description | Example | ExternalHelp | ForwardHelpCategory | ForwardHelpTargetName
361+
| Functionality | Inputs | Link | Notes | Outputs | Parameter | RemoteHelpRunSpace
362362
| Role | Synopsis
363363
)
364364
)

Tests/syntax_test_PowerShell.ps1

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1534,3 +1534,50 @@ get-thing | Out-WithYou > $null # destroy
15341534
# ^^^^^^^^^^^^^^^^^ variable.language - punctuation
15351535
# ^ variable.language punctuation
15361536
# ^^^^^^^^^^^^^^^^ variable.language - punctuation
1537+
<#
1538+
.SYNOPSIS
1539+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1540+
#^^^^^^^^ keyword.other.documentation
1541+
.DESCRIPTION
1542+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1543+
#^^^^^^^^^^^ keyword.other.documentation
1544+
.PARAMETER
1545+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1546+
#^^^^^^^^ keyword.other.documentation
1547+
.EXAMPLE
1548+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1549+
#^^^^^^^ keyword.other.documentation
1550+
.INPUTS
1551+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1552+
#^^^^^^ keyword.other.documentation
1553+
.OUTPUTS
1554+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1555+
#^^^^^^^ keyword.other.documentation
1556+
.NOTES
1557+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1558+
#^^^^^ keyword.other.documentation
1559+
.LINK
1560+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1561+
#^^^^ keyword.other.documentation
1562+
.COMPONENT
1563+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1564+
#^^^^^^^^^ keyword.other.documentation
1565+
.ROLE
1566+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1567+
#^^^^ keyword.other.documentation
1568+
.FUNCTIONALITY
1569+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1570+
#^^^^^^^^^^^^^ keyword.other.documentation
1571+
.FORWARDHELPTARGETNAME
1572+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1573+
#^^^^^^^^^^^^^^^^^^^^^ keyword.other.documentation
1574+
.FORWARDHELPCATEGORY
1575+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1576+
#^^^^^^^^^^^^^^^^^^^ keyword.other.documentation
1577+
.REMOTEHELPRUNSPACE
1578+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1579+
#^^^^^^^^^^^^^^^^^^ keyword.other.documentation
1580+
.EXTERNALHELP
1581+
#<- comment.block.powershell comment.documentation.embedded.powershell punctuation.definition.keyword.documentation.powershell
1582+
#^^^^^^^^^^^^ keyword.other.documentation
1583+
#>

0 commit comments

Comments
 (0)