Skip to content

Commit 6b75b23

Browse files
🪲 [Fix]: Fix linter settings and docs (#13)
This pull request introduces minor configuration and documentation updates to improve code linting controls and script clarity. The changes focus on adjusting linter settings, updating markdown lint rules, and enhancing script documentation. Linter configuration updates: * [`.github/PSModule.yml`](diffhunk://#diff-928165ed381f1982eb8f9746a59a2829db4abc8a28eddb8c109e12bb033ff96aR22-R31): Added a `Linter` section to explicitly disable several validation checks (such as Biome, JSCPD, various Prettier checks, and GitHub Actions Zizmor) by setting their environment variables to `false`. Markdown linting rule adjustments: * [`.github/linters/.markdown-lint.yml`](diffhunk://#diff-2fd3619d2b7372123257bc21645edb90c24293e66babbc6053033a89e21bab34R16-R18): Disabled the `MD024` rule (no duplicate headings) to allow repeated headings like INPUTS and OUTPUTS, and made a minor punctuation formatting change for the `MD026` rule. Documentation improvement: * [`src/functions/public/Test-PSModuleTemplate.ps1`](diffhunk://#diff-5900b9f47599d281b3ed9668242d5b52d0767a84e7a988ba48fdd77faa027007R6-R8): Added a `.DESCRIPTION` section to the comment-based help, clarifying the purpose of the function.
1 parent 0642dd5 commit 6b75b23

3 files changed

Lines changed: 22 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

‎src/functions/public/Test-PSModuleTemplate.ps1‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
.SYNOPSIS
44
Performs tests on a module.
55
6+
.DESCRIPTION
7+
Performs tests on a module.
8+
69
.EXAMPLE
710
Test-PSModuleTemplate -Name 'World'
811

0 commit comments

Comments
 (0)