@storm-software/markdownlint 0.21.2 → 0.22.0

package/README.md

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.21.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.21.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/config/base.markdownlint-cli2.jsonc

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.17.2/schema/markdownlint-cli2-config-schema.json",
+  "config": {
+    "extends": "base.markdownlint.jsonc"
+  },
+  //   "customRules": ["@storm-software/markdownlint/rules"],
+  "fix": true,
+  "ignores": [
+    "node_modules/**/*",
+    "**/node_modules/**/*",
+    "dist/**/*",
+    "**/dist/**/*",
+    "tmp/**/*",
+    "**/tmp/**/*",
+    "out/**/*",
+    "**/out/**/*",
+    "coverage/**/*",
+    "**/coverage/**/*",
+    "generated/**/*",
+    "**/generated/**/*",
+    "__generated__/**/*",
+    "**/__generated__/**/*",
+    "__tests__/**/*",
+    "**/__tests__/**/*",
+    "__mocks__/**/*",
+    "**/__mocks__/**/*",
+    ".cache/**/*",
+    "**/.cache/**/*",
+    ".next/**/*",
+    "**/.next/**/*",
+    ".nuxt/**/*",
+    "**/.nuxt/**/*",
+    ".idea/**/*",
+    "**/.idea/**/*",
+    ".nx/**/*",
+    ".vscode/**/*",
+    ".github/**/*",
+    ".git/**/*",
+    ".husky/**/*",
+    ".yarn/**/*",
+    ".pnp/**/*"
+  ]
+}

package/config/base.markdownlint.jsonc

@@ -0,0 +1,225 @@
+{
+  //Be explicit by listing every available rule. https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md
+  // Note that there will be numeric gaps, not every MD number is implemented in markdownlint.
+  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.37.4/schema/markdownlint-config-schema.json",
+
+  // MD001: Header levels should only increment by one level at a time.
+  "header-increment": true,
+
+  // MD002: First header should be a top level header.
+  "first-header-h1": false,
+
+  // MD003: Header style: start with hashes.
+  "heading-style": {
+    "style": "atx"
+  },
+
+  // MD004: Unordered list style
+  "ul-style": {
+    "style": "dash"
+  },
+
+  // MD005: Consistent indentation for list items at the same level.
+  "list-indent": true,
+
+  // MD006: Consider starting bulleted lists at the beginning of the line.
+  "ul-start-left": false,
+
+  // MD007: Unordered list indentation: 2 spaces.
+  "ul-indent": {
+    "indent": 2,
+    "start_indented": false
+  },
+
+  // MD009: Disallow trailing spaces!
+  "no-trailing-spaces": {
+    "br_spaces": 0,
+    // Empty lines inside list items should not be indented.",
+    "list_item_empty_lines": false
+  },
+
+  // MD010: No hard tabs, not even in code blocks.
+  "no-hard-tabs": {
+    "code_blocks": true
+  },
+
+  // MD011: Prevent reversed link syntax
+  "no-reversed-links": true,
+
+  // MD012: Disallow multiple consecutive blank lines.
+  "no-multiple-blanks": {
+    "maximum": 1
+  },
+
+  // MD013: Line length
+  "line-length": {
+    "tables": false,
+    "code_blocks": false,
+    "headings": false,
+    "line_length": 250
+  },
+
+  // MD014: Disallow use of dollar signs($) before commands without showing output.
+  "commands-show-output": true,
+
+  // MD018: No space after hash on atx style heading
+  "no-missing-space-atx": true,
+
+  // MD019: No multiple spaces after hash on atx style heading
+  "no-multiple-space-atx": true,
+
+  // MD020: No space inside hashes on closed atx style heading
+  "no-missing-space-closed-atx": true,
+
+  // MD021: No multiple spaces inside hashes on closed atx style heading
+  "no-multiple-space-closed-atx": true,
+
+  // MD022: Headers should be surrounded by blank lines.
+  // Some headers have preceding HTML anchors. Unfortunate that we have to disable this, as it otherwise catches a real problem that trips up some Markdown renderers
+  "blanks-around-headers": false,
+
+  // MD023: Headers must start at the beginning of the line.
+  "header-start-left": true,
+
+  // MD024: Multiple headers with the same content
+  "no-duplicate-heading": false,
+
+  // MD025: Disallow multiple top level headers in the same document.
+  // Gotta have a matching closing brace at the end.
+  "single-h1": false,
+
+  // MD026: Disallow trailing punctuation in header.
+  // You must have a semicolon after the ending closing brace.
+  "no-trailing-punctuation": {
+    "punctuation": ".,:!?"
+  },
+
+  // MD027: Multiple spaces after blockquote symbol
+  "no-multiple-space-blockquote": true,
+
+  // MD028: Blank line inside blockquote
+  // Some 'Why?' and 'Why not?' blocks are separated by a blank line
+  "no-blanks-blockquote": false,
+
+  // MD029: Ordered list item prefix
+  "ol-prefix": {
+    "style": "one_or_ordered"
+  },
+
+  // MD030: Spaces after list markers
+  "list-marker-space": {
+    "ul_single": 1,
+    "ol_single": 1,
+    "ul_multi": 1,
+    "ol_multi": 1
+  },
+
+  // MD031: Fenced code blocks should be surrounded by blank lines
+  "no-empty-code-blocks": true,
+
+  // MD032: Lists should be surrounded by blank lines
+  "no-empty-lists": true,
+
+  // MD033: Inline HTML
+  "no-inline-html": false,
+
+  // MD034: Bare URL used
+  "no-bare-urls": true,
+
+  // MD035: Horizontal rule style
+  "hr-style": {
+    "style": "---"
+  },
+
+  // MD036: Do not use emphasis instead of a header.
+  "no-emphasis-as-header": false,
+
+  // MD037: Disallow spaces inside emphasis markers.
+  "no-space-in-emphasis": true,
+
+  // MD038: Disallow spaces inside code span elements.
+  "no-space-in-code": true,
+
+  // MD039: Disallow spaces inside link text.
+  "no-space-in-links": false,
+
+  // MD040: Fenced code blocks should have a language specified.
+  "fenced-code-language": true,
+
+  // MD041: First line in file should be a top level header.
+  "first-line-h1": false,
+
+  // MD042: No empty links
+  "no-empty-links": true,
+
+  // MD043: Required header structure.
+  "required-headers": false,
+
+  // MD044: Proper names should have the correct capitalization.
+  "proper-names": false,
+
+  // MD045 - Images should have alternate text (alt text)
+  "no-alt-text": false,
+
+  // MD046 - Code block style
+  "code-block-style": {
+    "style": "fenced"
+  },
+
+  // MD047 - Files should end with a single newline character
+  "single-trailing-newline": true,
+
+  // MD048 - Code fence style
+  "code-fence-style": {
+    "style": "backtick"
+  },
+
+  // MD049 - Emphasis style
+  "emphasis-style": {
+    "style": "consistent"
+  },
+
+  // MD050 - Strong style
+  "strong-style": {
+    "style": "asterisk"
+  },
+
+  // MD051 - Link fragments should be valid
+  "link-fragments": true,
+
+  // MD052 - Reference links and images should use a label that is defined
+  "reference-links-images": {
+    "shortcut_syntax": false
+  },
+
+  // MD053 - Link and image reference definitions should be needed
+  "link-image-reference-definitions": {
+    "ignored_definitions": ["//"]
+  },
+
+  // MD054 - Link and image style
+  "link-image-style": {
+    "autolink": true,
+    "collapsed": true,
+    "full": true,
+    "inline": true,
+    "shortcut": true,
+    "url_inline": true
+  },
+
+  // MD055 - Table pipe style
+  "table-pipe-style": {
+    "style": "consistent"
+  },
+
+  // MD056 - Table column count
+  "table-column-count": true,
+
+  // MD058 - Tables should be surrounded by blank lines
+  "blanks-around-tables": true,
+
+  // MD059 - Spaces inside link text
+  "spaces-around-links": {
+    "both": true
+  }
+}

package/config/link-check.json

@@ -0,0 +1,10 @@
+{
+  "httpHeaders": [
+    {
+      "urls": ["https://docs.github.com/", "https://help.github.com/"],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/markdownlint",
-  "version": "0.21.2",
+  "version": "0.22.0",
   "description": "An opinionated collection of markdownlint rules used by Storm Software.",
   "repository": {
     "type": "github",
@@ -39,41 +39,27 @@
   },
   "license": "Apache-2.0",
   "private": false,
-  "engines": {
-    "node": ">=22.4.0",
-    "pnpm": ">=10.3.0"
-  },
+  "packageManager": "pnpm@10.3.0",
+  "engines": { "node": ">=22.4.0", "pnpm": ">=10.3.0" },
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
       "require": {
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./index": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
       "require": {
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./rules/*": {
       "import": {
@@ -98,10 +84,7 @@
     "./config/*": "./config/*"
   },
   "types": "./dist/index.d.ts",
-  "files": [
-    "config/**/*",
-    "dist/**/*"
-  ],
+  "files": ["config/**/*", "dist/**/*"],
   "keywords": [
     "markdownlint",
     "markdownlint-cli",
@@ -114,15 +97,7 @@
     "stormstack",
     "sullivanpj"
   ],
-  "dependencies": {
-    "defu": "6.1.4",
-    "markdownlint-cli2": "^0.17.2"
-  },
-  "devDependencies": {
-    "@types/node": "^22.10.2",
-    "tsup": "8.4.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}
+  "dependencies": { "defu": "6.1.4", "markdownlint-cli2": "^0.17.2" },
+  "devDependencies": { "@types/node": "^22.10.2", "tsup": "8.4.0" },
+  "publishConfig": { "access": "public" }
+}