@theholocron/markdownlint-config 8.6.0 → 8.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.ts +10 -6
  2. package/dist/index.js +26 -7
  3. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -2,6 +2,7 @@ import { Configuration } from "markdownlint";
2
2
  //#region index.d.ts
3
3
  /**
4
4
  * @see https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
5
+ * @see theholocron/holocron · docs/wiki/standards/markdownlint-rule-severity.md (full per-rule rationale)
5
6
  *
6
7
  * Org-specific additions on top of the upstream Prettier-compatibility
7
8
  * preset, none of which that preset already covers:
@@ -16,12 +17,15 @@ import { Configuration } from "markdownlint";
16
17
  * disable — still catches a genuine duplicate at the same nesting level,
17
18
  * but allows the same heading text at different levels (a common
18
19
  * TOC/section-per-subsystem pattern in this org's longer docs).
19
- * - `fenced-code-language` (MD040): explicit `true` — already markdownlint's
20
- * own core default (not part of `prettierStyle`, which doesn't mention it
21
- * at all), but declared here so it's guaranteed enforced org-wide rather
22
- * than an implicit default that could silently disappear if the upstream
23
- * preset ever changes. An unlabeled fence loses syntax highlighting and
24
- * can't be told apart from a real code sample at a glance.
20
+ *
21
+ * Severity curation (holocron#769/#860 drew the line this needed:
22
+ * error-severity now posts an inline PR review comment and blocks merge
23
+ * via Sentinel's markdownlint check; warning-severity stays an advisory
24
+ * check-run annotation). Every rule below was reviewed individually —
25
+ * full per-rule reasoning lives at the spec link above. Everything not
26
+ * listed here keeps markdownlint's own default (`error`).
27
+ *
28
+ * Warning — cosmetic, subjective, or otherwise non-breaking:
25
29
  */
26
30
  declare const config: Configuration;
27
31
  //#endregion
package/dist/index.js CHANGED
@@ -2,6 +2,7 @@ import prettierStyle from "markdownlint/style/prettier" with { type: "json" };
2
2
  //#region index.ts
3
3
  /**
4
4
  * @see https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
5
+ * @see theholocron/holocron · docs/wiki/standards/markdownlint-rule-severity.md (full per-rule rationale)
5
6
  *
6
7
  * Org-specific additions on top of the upstream Prettier-compatibility
7
8
  * preset, none of which that preset already covers:
@@ -16,19 +17,37 @@ import prettierStyle from "markdownlint/style/prettier" with { type: "json" };
16
17
  * disable — still catches a genuine duplicate at the same nesting level,
17
18
  * but allows the same heading text at different levels (a common
18
19
  * TOC/section-per-subsystem pattern in this org's longer docs).
19
- * - `fenced-code-language` (MD040): explicit `true` — already markdownlint's
20
- * own core default (not part of `prettierStyle`, which doesn't mention it
21
- * at all), but declared here so it's guaranteed enforced org-wide rather
22
- * than an implicit default that could silently disappear if the upstream
23
- * preset ever changes. An unlabeled fence loses syntax highlighting and
24
- * can't be told apart from a real code sample at a glance.
20
+ *
21
+ * Severity curation (holocron#769/#860 drew the line this needed:
22
+ * error-severity now posts an inline PR review comment and blocks merge
23
+ * via Sentinel's markdownlint check; warning-severity stays an advisory
24
+ * check-run annotation). Every rule below was reviewed individually —
25
+ * full per-rule reasoning lives at the spec link above. Everything not
26
+ * listed here keeps markdownlint's own default (`error`).
27
+ *
28
+ * Warning — cosmetic, subjective, or otherwise non-breaking:
25
29
  */
26
30
  const config = {
27
31
  ...prettierStyle,
28
32
  "no-inline-html": false,
29
33
  "first-line-heading": false,
30
34
  "duplicate-heading": { siblings_only: true },
31
- "fenced-code-language": true
35
+ "fenced-code-language": { severity: "warning" },
36
+ "ul-style": { severity: "warning" },
37
+ "commands-show-output": { severity: "warning" },
38
+ "no-trailing-punctuation": { severity: "warning" },
39
+ "no-bare-urls": { severity: "warning" },
40
+ "no-emphasis-as-heading": { severity: "warning" },
41
+ "no-space-in-code": { severity: "warning" },
42
+ "no-space-in-links": { severity: "warning" },
43
+ "code-block-style": { severity: "warning" },
44
+ "link-image-reference-definitions": { severity: "warning" },
45
+ "descriptive-link-text": { severity: "warning" },
46
+ "single-trailing-newline": false,
47
+ "link-image-style": false,
48
+ "table-pipe-style": false,
49
+ "blanks-around-tables": false,
50
+ "table-column-style": false
32
51
  };
33
52
  //#endregion
34
53
  export { config as default };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theholocron/markdownlint-config",
3
- "version": "8.6.0",
3
+ "version": "8.7.0",
4
4
  "description": "A markdownlint configuration for documentation in the Galaxy.",
5
5
  "keywords": [
6
6
  "markdownlint",
@@ -36,8 +36,8 @@
36
36
  "tsdown": "^0.22.14",
37
37
  "typescript": "^5.9.3",
38
38
  "vitest": "^4.1.10",
39
- "@theholocron/tsconfig": "8.6.0",
40
- "@theholocron/vitest-config": "8.6.0"
39
+ "@theholocron/tsconfig": "8.7.0",
40
+ "@theholocron/vitest-config": "8.7.0"
41
41
  },
42
42
  "peerDependencies": {
43
43
  "markdownlint": "^0.41"