Skip to content

Commit eb69f2a

Browse files
ci: isolate Docs lint rules
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent bf3eb91 commit eb69f2a

5 files changed

Lines changed: 574 additions & 1 deletion

File tree

.github/workflows/Docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ jobs:
4949
ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: true
5050
ENABLE_GITHUB_PULL_REQUEST_SUMMARY_COMMENT: true
5151
FILTER_REGEX_INCLUDE: '.*(docs/.*|\.github/actions/update-index/.*|\.github/workflows/Docs\.yml)$'
52-
MARKDOWN_CONFIG_FILE: docs/.markdown-lint.yml
52+
LINTER_RULES_PATH: docs/.github/linters
5353
SAVE_SUPER_LINTER_SUMMARY: true
5454
VALIDATE_BIOME_LINT: false
5555
VALIDATE_BIOME_FORMAT: false

docs/.github/linters/.codespellrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[codespell]
2+
skip = ./docs/.github/linters
3+
ignore-words-list = afterall,skelton,erformance
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
@{
2+
Rules = @{
3+
PSAlignAssignmentStatement = @{
4+
Enable = $true
5+
CheckHashtable = $true
6+
}
7+
PSAvoidLongLines = @{
8+
Enable = $true
9+
MaximumLineLength = 150
10+
}
11+
PSAvoidSemicolonsAsLineTerminators = @{
12+
Enable = $true
13+
}
14+
PSPlaceCloseBrace = @{
15+
Enable = $true
16+
NewLineAfter = $false
17+
IgnoreOneLineBlock = $true
18+
NoEmptyLineBefore = $false
19+
}
20+
PSPlaceOpenBrace = @{
21+
Enable = $true
22+
OnSameLine = $true
23+
NewLineAfter = $true
24+
IgnoreOneLineBlock = $true
25+
}
26+
PSProvideCommentHelp = @{
27+
Enable = $true
28+
ExportedOnly = $false
29+
BlockComment = $true
30+
VSCodeSnippetCorrection = $false
31+
Placement = 'begin'
32+
}
33+
PSUseConsistentIndentation = @{
34+
Enable = $true
35+
IndentationSize = 4
36+
PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
37+
Kind = 'space'
38+
}
39+
PSUseConsistentWhitespace = @{
40+
Enable = $true
41+
CheckInnerBrace = $true
42+
CheckOpenBrace = $true
43+
CheckOpenParen = $true
44+
CheckOperator = $true
45+
CheckPipe = $true
46+
CheckPipeForRedundantWhitespace = $true
47+
CheckSeparator = $true
48+
CheckParameter = $true
49+
IgnoreAssignmentOperatorInsideHashTable = $true
50+
}
51+
}
52+
ExcludeRules = @(
53+
'PSAvoidUsingWriteHost', # Write-Host is acceptable in scripts used for docs tooling and guidance.
54+
'PSMissingModuleManifestField', # This rule is not applicable until the module is built.
55+
'PSUseToExportFieldsInManifest'
56+
)
57+
}

0 commit comments

Comments
 (0)