@storm-software/markdownlint 0.12.8 → 0.13.0

package/dist/chunk-5BKT4CS5.js

@@ -0,0 +1,32 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+
+
+
+
+exports.__name = __name; exports.__commonJS = __commonJS; exports.__toESM = __toESM;

package/dist/chunk-A3UDIEI3.mjs

@@ -0,0 +1,32 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+export {
+  __name,
+  __commonJS,
+  __toESM
+};

package/dist/chunk-BLA57FQS.mjs

@@ -0,0 +1,68 @@
+import {
+  __commonJS,
+  __name
+} from "./chunk-A3UDIEI3.mjs";
+
+// src/rules/no-generic-link-text.ts
+var require_no_generic_link_text = __commonJS({
+  "src/rules/no-generic-link-text.ts"(exports, module) {
+    function stripAndDowncaseText(text) {
+      return text.toLowerCase().replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "").replace(/\s+/g, " ").trim();
+    }
+    __name(stripAndDowncaseText, "stripAndDowncaseText");
+    var bannedLinkText = [
+      "read more",
+      "learn more",
+      "more",
+      "here",
+      "click here",
+      "link"
+    ];
+    module.exports = {
+      names: [
+        "SSW02",
+        "no-generic-link-text"
+      ],
+      description: "Avoid using generic link text like `Learn more` or `Click here`",
+      information: new URL("https://github.com/github/markdownlint-github/blob/main/docs/rules/GH002-no-generic-link-text.md"),
+      tags: [
+        "accessibility",
+        "links"
+      ],
+      function: /* @__PURE__ */ __name(function SS002(params, onError) {
+        let bannedLinkTexts = bannedLinkText.concat(params.config.additional_banned_texts || []);
+        const exceptions = params.config.exceptions || [];
+        if (exceptions.length > 0) {
+          bannedLinkTexts = bannedLinkTexts.filter((text) => !exceptions.includes(text));
+        }
+        const inlineTokens = params.tokens.filter((t) => t.type === "inline");
+        for (const token of inlineTokens) {
+          const { children } = token;
+          let inLink = false;
+          let linkText = "";
+          for (const child of children) {
+            const { content, type } = child;
+            if (type === "link_open") {
+              inLink = true;
+              linkText = "";
+            } else if (type === "link_close") {
+              inLink = false;
+              if (bannedLinkTexts.includes(stripAndDowncaseText(linkText))) {
+                onError({
+                  lineNumber: child.lineNumber,
+                  detail: `For link: ${linkText}`
+                });
+              }
+            } else if (inLink) {
+              linkText += content;
+            }
+          }
+        }
+      }, "SS002")
+    };
+  }
+});
+
+export {
+  require_no_generic_link_text
+};

package/dist/chunk-CSEVGJXW.js

@@ -0,0 +1,68 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunk5BKT4CS5js = require('./chunk-5BKT4CS5.js');
+
+// src/rules/no-generic-link-text.ts
+var require_no_generic_link_text = _chunk5BKT4CS5js.__commonJS.call(void 0, {
+  "src/rules/no-generic-link-text.ts"(exports, module) {
+    function stripAndDowncaseText(text) {
+      return text.toLowerCase().replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "").replace(/\s+/g, " ").trim();
+    }
+    _chunk5BKT4CS5js.__name.call(void 0, stripAndDowncaseText, "stripAndDowncaseText");
+    var bannedLinkText = [
+      "read more",
+      "learn more",
+      "more",
+      "here",
+      "click here",
+      "link"
+    ];
+    module.exports = {
+      names: [
+        "SSW02",
+        "no-generic-link-text"
+      ],
+      description: "Avoid using generic link text like `Learn more` or `Click here`",
+      information: new URL("https://github.com/github/markdownlint-github/blob/main/docs/rules/GH002-no-generic-link-text.md"),
+      tags: [
+        "accessibility",
+        "links"
+      ],
+      function: /* @__PURE__ */ _chunk5BKT4CS5js.__name.call(void 0, function SS002(params, onError) {
+        let bannedLinkTexts = bannedLinkText.concat(params.config.additional_banned_texts || []);
+        const exceptions = params.config.exceptions || [];
+        if (exceptions.length > 0) {
+          bannedLinkTexts = bannedLinkTexts.filter((text) => !exceptions.includes(text));
+        }
+        const inlineTokens = params.tokens.filter((t) => t.type === "inline");
+        for (const token of inlineTokens) {
+          const { children } = token;
+          let inLink = false;
+          let linkText = "";
+          for (const child of children) {
+            const { content, type } = child;
+            if (type === "link_open") {
+              inLink = true;
+              linkText = "";
+            } else if (type === "link_close") {
+              inLink = false;
+              if (bannedLinkTexts.includes(stripAndDowncaseText(linkText))) {
+                onError({
+                  lineNumber: child.lineNumber,
+                  detail: `For link: ${linkText}`
+                });
+              }
+            } else if (inLink) {
+              linkText += content;
+            }
+          }
+        }
+      }, "SS002")
+    };
+  }
+});
+
+
+
+exports.require_no_generic_link_text = require_no_generic_link_text;

package/dist/chunk-KF4NZASG.mjs

@@ -0,0 +1,26 @@
+import {
+  require_no_default_alt_text
+} from "./chunk-T5XN24SU.mjs";
+import {
+  require_no_empty_alt_text
+} from "./chunk-UP2FAX2A.mjs";
+import {
+  require_no_generic_link_text
+} from "./chunk-BLA57FQS.mjs";
+import {
+  __toESM
+} from "./chunk-A3UDIEI3.mjs";
+
+// src/rules/index.ts
+var SS01 = __toESM(require_no_default_alt_text());
+var SS03 = __toESM(require_no_empty_alt_text());
+var SS02 = __toESM(require_no_generic_link_text());
+var rules = [
+  SS01,
+  SS02,
+  SS03
+];
+
+export {
+  rules
+};

package/dist/chunk-T2GN3E2Q.js

@@ -0,0 +1,73 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunk5BKT4CS5js = require('./chunk-5BKT4CS5.js');
+
+// src/rules/no-default-alt-text.ts
+var require_no_default_alt_text = _chunk5BKT4CS5js.__commonJS.call(void 0, {
+  "src/rules/no-default-alt-text.ts"(exports, module) {
+    var defaultScreenshotRegex = `(?:screen|clean) ?(?:shot|cast) \\d{4}-\\d{2}-\\d{2}[^'"\\]]*`;
+    var imageRegex = "image";
+    var combinedRegex = `(${[
+      defaultScreenshotRegex,
+      imageRegex
+    ].join("|")})`;
+    var markdownAltRegex = new RegExp(`!\\[${combinedRegex}\\]\\(.*\\)`, "gid");
+    var htmlAltRegex = new RegExp(`alt=["']${combinedRegex}["']`, "gid");
+    module.exports = {
+      names: [
+        "SSW01",
+        "no-default-alt-text"
+      ],
+      description: "Images should have meaningful alternative text (alt text)",
+      information: new URL("https://github.com/github/markdownlint-github/blob/main/docs/rules/GH001-no-default-alt-text.md"),
+      tags: [
+        "accessibility",
+        "images"
+      ],
+      function: /* @__PURE__ */ _chunk5BKT4CS5js.__name.call(void 0, function SS001(params, onError) {
+        const htmlTagsWithImages = params.parsers.markdownit.tokens.filter((token) => {
+          return token.type === "html_block" && token.content.includes("<img") || token.type === "inline" && token.content.includes("<img") && token.children.some((child) => child.type === "html_inline");
+        });
+        const inlineImages = params.parsers.markdownit.tokens.filter((token) => token.type === "inline" && token.children.some((child) => child.type === "image"));
+        for (const token of [
+          ...htmlTagsWithImages,
+          ...inlineImages
+        ]) {
+          const lineRange = token.map;
+          const lineNumber = token.lineNumber;
+          const lines = params.lines.slice(lineRange[0], lineRange[1]);
+          for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
+            let matches;
+            if (token.type === "inline") {
+              if (token.children.some((child) => child.type === "html_inline")) {
+                matches = line.matchAll(htmlAltRegex);
+              } else {
+                matches = line.matchAll(markdownAltRegex);
+              }
+            } else {
+              matches = line.matchAll(htmlAltRegex);
+            }
+            for (const match of matches) {
+              const altText = match[1];
+              const [startIndex] = match.indices[1];
+              onError({
+                lineNumber: lineNumber + i,
+                range: [
+                  startIndex + 1,
+                  altText.length
+                ],
+                detail: `Flagged alt: ${altText}`
+              });
+            }
+          }
+        }
+      }, "SS001")
+    };
+  }
+});
+
+
+
+exports.require_no_default_alt_text = require_no_default_alt_text;

package/dist/chunk-T5XN24SU.mjs

@@ -0,0 +1,73 @@
+import {
+  __commonJS,
+  __name
+} from "./chunk-A3UDIEI3.mjs";
+
+// src/rules/no-default-alt-text.ts
+var require_no_default_alt_text = __commonJS({
+  "src/rules/no-default-alt-text.ts"(exports, module) {
+    var defaultScreenshotRegex = `(?:screen|clean) ?(?:shot|cast) \\d{4}-\\d{2}-\\d{2}[^'"\\]]*`;
+    var imageRegex = "image";
+    var combinedRegex = `(${[
+      defaultScreenshotRegex,
+      imageRegex
+    ].join("|")})`;
+    var markdownAltRegex = new RegExp(`!\\[${combinedRegex}\\]\\(.*\\)`, "gid");
+    var htmlAltRegex = new RegExp(`alt=["']${combinedRegex}["']`, "gid");
+    module.exports = {
+      names: [
+        "SSW01",
+        "no-default-alt-text"
+      ],
+      description: "Images should have meaningful alternative text (alt text)",
+      information: new URL("https://github.com/github/markdownlint-github/blob/main/docs/rules/GH001-no-default-alt-text.md"),
+      tags: [
+        "accessibility",
+        "images"
+      ],
+      function: /* @__PURE__ */ __name(function SS001(params, onError) {
+        const htmlTagsWithImages = params.parsers.markdownit.tokens.filter((token) => {
+          return token.type === "html_block" && token.content.includes("<img") || token.type === "inline" && token.content.includes("<img") && token.children.some((child) => child.type === "html_inline");
+        });
+        const inlineImages = params.parsers.markdownit.tokens.filter((token) => token.type === "inline" && token.children.some((child) => child.type === "image"));
+        for (const token of [
+          ...htmlTagsWithImages,
+          ...inlineImages
+        ]) {
+          const lineRange = token.map;
+          const lineNumber = token.lineNumber;
+          const lines = params.lines.slice(lineRange[0], lineRange[1]);
+          for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
+            let matches;
+            if (token.type === "inline") {
+              if (token.children.some((child) => child.type === "html_inline")) {
+                matches = line.matchAll(htmlAltRegex);
+              } else {
+                matches = line.matchAll(markdownAltRegex);
+              }
+            } else {
+              matches = line.matchAll(htmlAltRegex);
+            }
+            for (const match of matches) {
+              const altText = match[1];
+              const [startIndex] = match.indices[1];
+              onError({
+                lineNumber: lineNumber + i,
+                range: [
+                  startIndex + 1,
+                  altText.length
+                ],
+                detail: `Flagged alt: ${altText}`
+              });
+            }
+          }
+        }
+      }, "SS001")
+    };
+  }
+});
+
+export {
+  require_no_default_alt_text
+};

package/dist/chunk-UP2FAX2A.mjs

@@ -0,0 +1,58 @@
+import {
+  __commonJS,
+  __name
+} from "./chunk-A3UDIEI3.mjs";
+
+// src/rules/no-empty-alt-text.ts
+var require_no_empty_alt_text = __commonJS({
+  "src/rules/no-empty-alt-text.ts"(exports, module) {
+    module.exports = {
+      names: [
+        "SSW03",
+        "no-empty-alt-text"
+      ],
+      description: "Please provide an alternative text for the image.",
+      information: new URL("https://github.com/github/markdownlint-github/blob/main/docs/rules/GH003-no-empty-alt-text.md"),
+      tags: [
+        "accessibility",
+        "images"
+      ],
+      function: /* @__PURE__ */ __name(function SS003(params, onError) {
+        const htmlTagsWithImages = params.parsers.markdownit.tokens.filter((token) => {
+          return token.type === "html_block" && token.content.includes("<img") || token.type === "inline" && token.content.includes("<img") && token.children.some((child) => child.type === "html_inline");
+        });
+        const ImageRegex = new RegExp(/<img(.*?)>/, "gid");
+        const htmlEmptyAltRegex = new RegExp(/alt=['"]['"]/, "gid");
+        for (const token of htmlTagsWithImages) {
+          const lineRange = token.map;
+          const lineNumber = token.lineNumber;
+          const lines = params.lines.slice(lineRange[0], lineRange[1]);
+          for (const [i, line] of lines.entries()) {
+            const imageTags = line.matchAll(ImageRegex);
+            for (const imageTag of imageTags) {
+              const imageTagIndex = imageTag.indices[0][0];
+              const emptyAltMatches = [
+                ...imageTag[0].matchAll(htmlEmptyAltRegex)
+              ][0];
+              if (emptyAltMatches) {
+                const matchingContent = emptyAltMatches[0];
+                const startIndex = emptyAltMatches.indices[0][0];
+                onError({
+                  lineNumber: lineNumber + i,
+                  range: [
+                    imageTagIndex + startIndex + 1,
+                    matchingContent.length
+                  ]
+                });
+              }
+            }
+          }
+        }
+      }, "SS003")
+    };
+  }
+});
+
+export {
+  require_no_empty_alt_text
+};

package/dist/chunk-ZD5PYAVS.js

@@ -0,0 +1,58 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunk5BKT4CS5js = require('./chunk-5BKT4CS5.js');
+
+// src/rules/no-empty-alt-text.ts
+var require_no_empty_alt_text = _chunk5BKT4CS5js.__commonJS.call(void 0, {
+  "src/rules/no-empty-alt-text.ts"(exports, module) {
+    module.exports = {
+      names: [
+        "SSW03",
+        "no-empty-alt-text"
+      ],
+      description: "Please provide an alternative text for the image.",
+      information: new URL("https://github.com/github/markdownlint-github/blob/main/docs/rules/GH003-no-empty-alt-text.md"),
+      tags: [
+        "accessibility",
+        "images"
+      ],
+      function: /* @__PURE__ */ _chunk5BKT4CS5js.__name.call(void 0, function SS003(params, onError) {
+        const htmlTagsWithImages = params.parsers.markdownit.tokens.filter((token) => {
+          return token.type === "html_block" && token.content.includes("<img") || token.type === "inline" && token.content.includes("<img") && token.children.some((child) => child.type === "html_inline");
+        });
+        const ImageRegex = new RegExp(/<img(.*?)>/, "gid");
+        const htmlEmptyAltRegex = new RegExp(/alt=['"]['"]/, "gid");
+        for (const token of htmlTagsWithImages) {
+          const lineRange = token.map;
+          const lineNumber = token.lineNumber;
+          const lines = params.lines.slice(lineRange[0], lineRange[1]);
+          for (const [i, line] of lines.entries()) {
+            const imageTags = line.matchAll(ImageRegex);
+            for (const imageTag of imageTags) {
+              const imageTagIndex = imageTag.indices[0][0];
+              const emptyAltMatches = [
+                ...imageTag[0].matchAll(htmlEmptyAltRegex)
+              ][0];
+              if (emptyAltMatches) {
+                const matchingContent = emptyAltMatches[0];
+                const startIndex = emptyAltMatches.indices[0][0];
+                onError({
+                  lineNumber: lineNumber + i,
+                  range: [
+                    imageTagIndex + startIndex + 1,
+                    matchingContent.length
+                  ]
+                });
+              }
+            }
+          }
+        }
+      }, "SS003")
+    };
+  }
+});
+
+
+
+exports.require_no_empty_alt_text = require_no_empty_alt_text;

package/dist/chunk-ZPSREAWV.js

@@ -0,0 +1,26 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkT2GN3E2Qjs = require('./chunk-T2GN3E2Q.js');
+
+
+var _chunkZD5PYAVSjs = require('./chunk-ZD5PYAVS.js');
+
+
+var _chunkCSEVGJXWjs = require('./chunk-CSEVGJXW.js');
+
+
+var _chunk5BKT4CS5js = require('./chunk-5BKT4CS5.js');
+
+// src/rules/index.ts
+var SS01 = _chunk5BKT4CS5js.__toESM.call(void 0, _chunkT2GN3E2Qjs.require_no_default_alt_text.call(void 0, ));
+var SS03 = _chunk5BKT4CS5js.__toESM.call(void 0, _chunkZD5PYAVSjs.require_no_empty_alt_text.call(void 0, ));
+var SS02 = _chunk5BKT4CS5js.__toESM.call(void 0, _chunkCSEVGJXWjs.require_no_generic_link_text.call(void 0, ));
+var rules = [
+  SS01,
+  SS02,
+  SS03
+];
+
+
+
+exports.rules = rules;

package/dist/index.d.mts

@@ -0,0 +1,126 @@
+import { S as SS01 } from './rules/no-default-alt-text.mjs';
+
+/**
+ * The markdownlint library used by Storm Software for building TypeScript applications.
+ *
+ * @remarks
+ * An opinionated collection of markdownlint rules used by Storm Software.
+ *
+ * @packageDocumentation
+ */
+declare const init: (defaultConfig: any) => any;
+declare const rules: typeof SS01[];
+declare const config: {
+    $schema: string;
+    "header-increment": boolean;
+    "first-header-h1": boolean;
+    "heading-style": {
+        style: string;
+    };
+    "ul-style": {
+        style: string;
+    };
+    "list-indent": boolean;
+    "ul-start-left": boolean;
+    "ul-indent": {
+        indent: number;
+        start_indented: boolean;
+    };
+    "no-trailing-spaces": {
+        br_spaces: number;
+        list_item_empty_lines: boolean;
+    };
+    "no-hard-tabs": {
+        code_blocks: boolean;
+    };
+    "no-reversed-links": boolean;
+    "no-multiple-blanks": {
+        maximum: number;
+    };
+    "line-length": {
+        tables: boolean;
+        code_blocks: boolean;
+        headings: boolean;
+        line_length: number;
+        heading_line_length: number;
+        code_block_line_length: number;
+    };
+    "commands-show-output": boolean;
+    "no-missing-space-atx": boolean;
+    "no-multiple-space-atx": boolean;
+    "no-missing-space-closed-atx": boolean;
+    "no-multiple-space-closed-atx": boolean;
+    "blanks-around-headers": boolean;
+    "header-start-left": boolean;
+    "no-duplicate-heading": boolean;
+    "single-h1": boolean;
+    "no-trailing-punctuation": {
+        punctuation: string;
+    };
+    "no-multiple-space-blockquote": boolean;
+    "no-blanks-blockquote": boolean;
+    "ol-prefix": {
+        style: string;
+    };
+    "list-marker-space": {
+        ul_single: number;
+        ol_single: number;
+        ul_multi: number;
+        ol_multi: number;
+    };
+    "no-empty-code-blocks": boolean;
+    "no-empty-lists": boolean;
+    "no-inline-html": boolean;
+    "no-bare-urls": boolean;
+    "hr-style": {
+        style: string;
+    };
+    "no-emphasis-as-header": boolean;
+    "no-space-in-emphasis": boolean;
+    "no-space-in-code": boolean;
+    "no-space-in-links": boolean;
+    "fenced-code-language": boolean;
+    "first-line-h1": boolean;
+    "no-empty-links": boolean;
+    "required-headers": boolean;
+    "proper-names": boolean;
+    "no-alt-text": boolean;
+    "code-block-style": {
+        style: string;
+    };
+    "single-trailing-newline": boolean;
+    "code-fence-style": {
+        style: string;
+    };
+    "emphasis-style": {
+        style: string;
+    };
+    "strong-style": {
+        style: string;
+    };
+    "link-fragments": boolean;
+    "reference-links-images": {
+        shortcut_syntax: boolean;
+    };
+    "link-image-reference-definitions": {
+        ignored_definitions: string[];
+    };
+    "link-image-style": {
+        autolink: boolean;
+        collapsed: boolean;
+        full: boolean;
+        inline: boolean;
+        shortcut: boolean;
+        url_inline: boolean;
+    };
+    "table-pipe-style": {
+        style: string;
+    };
+    "table-column-count": boolean;
+    "blanks-around-tables": boolean;
+    "spaces-around-links": {
+        both: boolean;
+    };
+};
+
+export { config, config as default, init, rules };