Skip to content

Commit 65234db

Browse files
🪲 [Fix]: Fix linter settings and docs (#6)
This pull request introduces several configuration updates to the repository's linting and formatting workflows. The main focus is on customizing markdown linting rules and disabling certain linter validations in the CI environment. Linter configuration updates: * [`.github/PSModule.yml`](diffhunk://#diff-928165ed381f1982eb8f9746a59a2829db4abc8a28eddb8c109e12bb033ff96aR22-R31): Added a `Linter` section to the CI configuration, explicitly disabling various linter checks (e.g., Biome format and lint, GitHub Actions Zizmor, JSCPD, and Prettier validations for JSON, Markdown, and YAML) by setting their environment variables to `false`. Markdown linting rule adjustments: * [`.github/linters/.markdown-lint.yml`](diffhunk://#diff-2fd3619d2b7372123257bc21645edb90c24293e66babbc6053033a89e21bab34R16-R18): Disabled the `MD024` rule to allow duplicate headings (useful for repeated "INPUTS" and "OUTPUTS" sections), and made a minor formatting adjustment to the `MD026` punctuation list.
1 parent 38af018 commit 65234db

2 files changed

Lines changed: 19 additions & 8 deletions

File tree

.github/PSModule.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,13 @@ Test:
1919
# Build:
2020
# Docs:
2121
# Skip: true
22+
23+
Linter:
24+
env:
25+
VALIDATE_BIOME_FORMAT: false
26+
VALIDATE_BIOME_LINT: false
27+
VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
28+
VALIDATE_JSCPD: false
29+
VALIDATE_JSON_PRETTIER: false
30+
VALIDATE_MARKDOWN_PRETTIER: false
31+
VALIDATE_YAML_PRETTIER: false

.github/linters/.markdown-lint.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,19 @@
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: 808 # Line length
16+
MD024: false # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item
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
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
2122

2223
#################
2324
# Rules by tags #
2425
#################
25-
blank_lines: false # Error on blank lines
26+
blank_lines: false # Error on blank lines

0 commit comments

Comments
 (0)