Skip to content

Commit 5e8ece6

Browse files
docs: consolidate linter configurations and remove deprecated files
1 parent b93e8c8 commit 5e8ece6

10 files changed

Lines changed: 14 additions & 634 deletions

File tree

.github/linters/.codespellrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[codespell]
22
skip = ./.github/linters
3-
ignore-words-list = afterall
3+
ignore-words-list = afterall,skelton,erformance

.github/linters/.markdown-lint.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@
88
###############
99
# Rules by id #
1010
###############
11-
MD004: false # Unordered list style
11+
MD004: false # Unordered list style
1212
MD007:
13-
indent: 2 # Unordered list indentation
13+
indent: 2 # Unordered list indentation
1414
MD013:
15-
line_length: 808 # Line length
15+
line_length: 3000 # Line length
16+
MD025: false # Allow front-matter title + visible H1 on docs pages
1617
MD026:
17-
punctuation: ".,;:!。,;:" # List of not allowed
18-
MD029: false # Ordered list item prefix
19-
MD033: false # Allow inline HTML
20-
MD036: false # Emphasis used instead of a heading
21-
MD060:
22-
style: "leading" # Table column style (leading avoids emoji width issues)
18+
punctuation: '.,;:!。,;:' # List of not allowed
19+
MD029: false # Ordered list item prefix
20+
MD033: false # Allow inline HTML
21+
MD036: false # Emphasis used instead of a heading
22+
MD041: false # First line in file should be a top level heading, PULL_REQUEST_TEMPLATE.md is an exception
23+
MD060: false # Documentation uses both compact and aligned table styles
2324

2425
#################
2526
# Rules by tags #
2627
#################
27-
blank_lines: false # Error on blank lines
28+
blank_lines: false # Error on blank lines

.github/linters/.powershell-psscriptanalyzer.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
}
5151
}
5252
ExcludeRules = @(
53-
'PSAvoidUsingWriteHost', # Write-Host is acceptable in GitHub Actions runners
53+
'PSAvoidUsingWriteHost', # Write-Host is acceptable in GitHub Actions runners and docs tooling scripts
5454
'PSMissingModuleManifestField', # This rule is not applicable until the module is built.
5555
'PSUseToExportFieldsInManifest'
5656
)

.github/workflows/Docs.yml

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

docs/.github/linters/.codespellrc

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/.github/linters/.markdown-lint.yml

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/.github/linters/.powershell-psscriptanalyzer.psd1

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)