@storm-software/markdownlint 0.4.0 → 0.5.1

package/CHANGELOG.md

@@ -1,62 +1,75 @@
-## 0.4.0 (2024-06-05)
+## 0.5.1 (2024-06-05)
+
+
+### 🩹 Fixes
+
+- **markdownlint:** Resolve issue with bad rules export ([7e6e5375](https://github.com/storm-software/storm-ops/commit/7e6e5375))
 
+## 0.5.0 (2024-06-05)
 
 ### 🚀 Features
 
-- **eslint-plugin:** Added the `eslint` and `prittier` base packages ([b2d63d0f](https://github.com/storm-software/storm-ops/commit/b2d63d0f))
+- **eslint-plugin:** Added the `apply` helper function
+  ([ab919d5e](https://github.com/storm-software/storm-ops/commit/ab919d5e))
 
-- **workspace-tools:** Update `preset` generator with Storm `eslint-plugin` and `prettier` config ([24ae7683](https://github.com/storm-software/storm-ops/commit/24ae7683))
+## 0.4.0 (2024-06-05)
+
+### 🚀 Features
 
+- **eslint-plugin:** Added the `eslint` and `prittier` base packages
+  ([b2d63d0f](https://github.com/storm-software/storm-ops/commit/b2d63d0f))
+
+- **workspace-tools:** Update `preset` generator with Storm `eslint-plugin` and
+  `prettier` config
+  ([24ae7683](https://github.com/storm-software/storm-ops/commit/24ae7683))
 
 ### 🩹 Fixes
 
-- **eslint:** Resolve issue with missing dependencies ([b0f43454](https://github.com/storm-software/storm-ops/commit/b0f43454))
+- **eslint:** Resolve issue with missing dependencies
+  ([b0f43454](https://github.com/storm-software/storm-ops/commit/b0f43454))
 
 ## 0.3.0 (2024-06-03)
 
-
 ### 🚀 Features
 
-- **storm-ops:** Upgrade Nx packages and resolve linting issues ([685c2bb9](https://github.com/storm-software/storm-ops/commit/685c2bb9))
-
+- **storm-ops:** Upgrade Nx packages and resolve linting issues
+  ([685c2bb9](https://github.com/storm-software/storm-ops/commit/685c2bb9))
 
 ### 🩹 Fixes
 
-- **git-tools:** Resolved issue with import in markdown formatter ([5e3963de](https://github.com/storm-software/storm-ops/commit/5e3963de))
+- **git-tools:** Resolved issue with import in markdown formatter
+  ([5e3963de](https://github.com/storm-software/storm-ops/commit/5e3963de))
 
 ## 0.2.0 (2024-05-29)
 
-
 ### 🚀 Features
 
-- **cloudflare-tools:** Update worker generator to add hono depenendency ([946a9e59](https://github.com/storm-software/storm-ops/commit/946a9e59))
-
+- **cloudflare-tools:** Update worker generator to add hono depenendency
+  ([946a9e59](https://github.com/storm-software/storm-ops/commit/946a9e59))
 
-### ❤️  Thank You
+### ❤️ Thank You
 
 - Patrick Sullivan
 
 ## 0.1.2 (2024-05-27)
 
-
 ### 🩹 Fixes
 
-- **deps:** pin dependencies ([604f8bbb](https://github.com/storm-software/storm-ops/commit/604f8bbb))
+- **deps:** pin dependencies
+  ([604f8bbb](https://github.com/storm-software/storm-ops/commit/604f8bbb))
 
-
-### ❤️  Thank You
+### ❤️ Thank You
 
 - Patrick Sullivan
 
 ## 0.1.1 (2024-05-06)
 
-
 ### 🩹 Fixes
 
-- **markdownlint:** Resolved issue with bad config in lint file ([95b3aba7](https://github.com/storm-software/storm-ops/commit/95b3aba7))
+- **markdownlint:** Resolved issue with bad config in lint file
+  ([95b3aba7](https://github.com/storm-software/storm-ops/commit/95b3aba7))
 
-
-### ❤️  Thank You
+### ❤️ Thank You
 
 - Patrick Sullivan
 
@@ -64,7 +77,8 @@
 
 ### 🚀 Features
 
-- **markdownlint:** Added the `markdownlint` package for shared configurations ([abd6fa38](https://github.com/storm-software/storm-ops/commit/abd6fa38))
+- **markdownlint:** Added the `markdownlint` package for shared configurations
+  ([abd6fa38](https://github.com/storm-software/storm-ops/commit/abd6fa38))
 
 ### ❤️ Thank You
 

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.3.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-0.5.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 docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&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)
 
 > [!IMPORTANT]

package/index.js

@@ -5509,6 +5509,166 @@ var require_lodash = __commonJS({
   }
 });
 
+// packages/markdownlint/src/rules/no-default-alt-text.ts
+var require_no_default_alt_text = __commonJS({
+  "packages/markdownlint/src/rules/no-default-alt-text.ts"(exports2, module2) {
+    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");
+    module2.exports = {
+      names: ["SS001", "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: 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}`
+              });
+            }
+          }
+        }
+      }
+    };
+  }
+});
+
+// packages/markdownlint/src/rules/no-empty-alt-text.ts
+var require_no_empty_alt_text = __commonJS({
+  "packages/markdownlint/src/rules/no-empty-alt-text.ts"(exports2, module2) {
+    module2.exports = {
+      names: ["SS003", "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: 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]
+                });
+              }
+            }
+          }
+        }
+      }
+    };
+  }
+});
+
+// packages/markdownlint/src/rules/no-generic-link-text.ts
+var require_no_generic_link_text = __commonJS({
+  "packages/markdownlint/src/rules/no-generic-link-text.ts"(exports2, module2) {
+    function stripAndDowncaseText(text) {
+      return text.toLowerCase().replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "").replace(/\s+/g, " ").trim();
+    }
+    var bannedLinkText = [
+      "read more",
+      "learn more",
+      "more",
+      "here",
+      "click here",
+      "link"
+    ];
+    module2.exports = {
+      names: ["SS002", "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: 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;
+            }
+          }
+        }
+      }
+    };
+  }
+});
+
 // packages/markdownlint/src/index.ts
 var src_exports = {};
 __export(src_exports, {
@@ -5518,6 +5678,12 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 var import_lodash = __toESM(require_lodash());
 
+// packages/markdownlint/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];
+
 // packages/markdownlint/src/style/accessibility.json
 var accessibility_default = {
   "no-alt-text": true,
@@ -5548,161 +5714,10 @@ var base_default = {
   "first-line-heading": false
 };
 
-// packages/markdownlint/src/rules/no-default-alt-text.ts
-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");
-var no_default_alt_text_default = {
-  names: ["SS001", "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: 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}`
-          });
-        }
-      }
-    }
-  }
-};
-
-// packages/markdownlint/src/rules/no-generic-link-text.ts
-function stripAndDowncaseText(text) {
-  return text.toLowerCase().replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "").replace(/\s+/g, " ").trim();
-}
-var bannedLinkText = [
-  "read more",
-  "learn more",
-  "more",
-  "here",
-  "click here",
-  "link"
-];
-var no_generic_link_text_default = {
-  names: ["SS002", "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: 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;
-        }
-      }
-    }
-  }
-};
-
-// packages/markdownlint/src/rules/no-empty-alt-text.ts
-var no_empty_alt_text_default = {
-  names: ["SS003", "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: 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]
-            });
-          }
-        }
-      }
-    }
-  }
-};
-
-// packages/markdownlint/src/rules/index.ts
-var rules = [no_default_alt_text_default, no_generic_link_text_default, no_empty_alt_text_default];
-
 // packages/markdownlint/src/index.ts
-var offByDefault = ["no-empty-alt-text"];
+var offByDefault = [];
 for (const rule of rules) {
-  const ruleName = rule.names[1];
+  const ruleName = rule?.names[1];
   if (ruleName) {
     base_default[ruleName] = offByDefault.includes(ruleName) ? false : true;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/markdownlint",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "type": "commonjs",
   "description": "⚡An opinionated collection of markdownlint rules used by Storm Software.",
   "repository": {