Commit 6b75b23
authored
🪲 [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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
| 16 | + | |
16 | 17 | | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
24 | 25 | | |
25 | | - | |
| 26 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
6 | 9 | | |
7 | 10 | | |
8 | 11 | | |
| |||
0 commit comments