@storm-software/markdownlint 0.3.0 → 0.5.0

package/package.json

@@ -1,8 +1,25 @@
 {
   "name": "@storm-software/markdownlint",
-  "version": "0.3.0",
-  "private": false,
+  "version": "0.5.0",
+  "type": "commonjs",
   "description": "⚡An opinionated collection of markdownlint rules used by Storm Software.",
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/storm-ops.git",
+    "directory": "packages/markdownlint"
+  },
+  "homepage": "https://stormsoftware.com",
+  "bugs": {
+    "url": "https://github.com/storm-software/storm-ops/issues",
+    "email": "support@stormsoftware.com"
+  },
+  "author": {
+    "name": "Storm Software",
+    "email": "contact@stormsoftware.com",
+    "url": "https://stormsoftware.com"
+  },
+  "license": "Apache-2.0",
+  "private": false,
   "keywords": [
     "storm",
     "storm-ops",
@@ -15,23 +32,6 @@
     "markdownlint-cli",
     "markdownlint-cli2"
   ],
-  "homepage": "https://stormsoftware.com",
-  "bugs": {
-    "url": "https://github.com/storm-software/storm-ops/issues",
-    "email": "support@stormsoftware.com"
-  },
-  "repository": {
-    "type": "github",
-    "url": "https://github.com/storm-software/storm-ops.git",
-    "directory": "packages/markdownlint"
-  },
-  "license": "Apache-2.0",
-  "author": {
-    "name": "Storm Software",
-    "email": "contact@stormsoftware.com",
-    "url": "https://stormsoftware.com"
-  },
-  "type": "module",
   "dependencies": {
     "lodash": "4.17.21"
   },

package/.eslintrc.json

@@ -1,37 +0,0 @@
-{
-  "extends": ["../../.eslintrc.base.json"],
-  "ignorePatterns": ["!**/*", "node_modules/*"],
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.ts", "*.tsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.js", "*.jsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.json"],
-      "parser": "jsonc-eslint-parser",
-      "rules": {
-        "@nx/dependency-checks": [
-          "error",
-          {
-            "buildTargets": ["build"],
-            "ignoredFiles": [
-              "{projectRoot}/esbuild.config.{js,ts,mjs,mts}",
-              "{projectRoot}/jest.config.ts"
-            ],
-            "checkMissingDependencies": true,
-            "checkObsoleteDependencies": true,
-            "checkVersionMismatches": false
-          }
-        ]
-      }
-    }
-  ]
-}

package/jest.config.ts

@@ -1,3 +0,0 @@
-import { getJestConfig } from "@storm-software/testing-tools";
-
-export default getJestConfig("packages/markdownlint", true, "markdownlint");

package/project.json

@@ -1,57 +0,0 @@
-{
-  "name": "markdownlint",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "projectType": "library",
-  "sourceRoot": "packages/markdownlint/src",
-  "targets": {
-    "build": {
-      "executor": "@nx/esbuild:esbuild",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/packages/markdownlint",
-        "tsConfig": "packages/markdownlint/tsconfig.json",
-        "project": "packages/markdownlint/package.json",
-        "main": "packages/markdownlint/src/index.ts",
-        "defaultConfiguration": "production",
-        "deleteOutputPath": true,
-        "sourcemap": false,
-        "minify": false,
-        "skipTypeCheck": true,
-        "platform": "node",
-        "format": ["cjs"],
-        "esbuildOptions": {
-          "outExtension": {
-            ".js": ".js"
-          }
-        },
-        "assets": [
-          {
-            "input": "packages/markdownlint",
-            "glob": "README.md",
-            "output": "."
-          },
-          {
-            "input": "packages/markdownlint",
-            "glob": "CHANGELOG.md",
-            "output": "."
-          },
-          {
-            "input": "",
-            "glob": "LICENSE",
-            "output": "."
-          }
-        ]
-      },
-      "configurations": {
-        "production": {
-          "debug": false,
-          "verbose": false
-        },
-        "development": {
-          "debug": true,
-          "verbose": true
-        }
-      }
-    }
-  }
-}

package/src/index.ts

@@ -1,28 +0,0 @@
-/**
- * The markdownlint library used by Storm Software for building TypeScript applications.
- *
- * @remarks
- * An opinionated collection of markdownlint rules used by Storm Software.
- *
- * @packageDocumentation
- */
-
-import _ from "lodash";
-import accessibilityRules from "./style/accessibility.json";
-import base from "./style/base.json";
-import { rules } from "./rules";
-
-const offByDefault = ["no-empty-alt-text"];
-
-for (const rule of rules) {
-  const ruleName = rule.names[1];
-  if (ruleName) {
-    base[ruleName] = offByDefault.includes(ruleName) ? false : true;
-  }
-}
-
-export const init = function init(defaultConfig) {
-  return _.defaultsDeep(defaultConfig, accessibilityRules, base);
-};
-
-export default [...rules];

package/src/rules/index.ts

@@ -1,5 +0,0 @@
-import SS01 from "./no-default-alt-text";
-import SS02 from "./no-generic-link-text";
-import SS03 from "./no-empty-alt-text";
-
-export const rules = [SS01, SS02, SS03];

package/src/rules/no-default-alt-text.ts

@@ -1,69 +0,0 @@
-/**
- * Examples:
- * * "Screen Shot 2020-10-20 at 2 52 27 PM"
- * * "Screenshot 2020-10-20 at 2 52 27 PM"
- * * "Clean Shot 2020-10-20 @45x"
- * * "Screencast from 23 02 2024 19 15 19]"
- */
-const defaultScreenshotRegex =
-  "(?:screen|clean) ?(?:shot|cast) \\d{4}-\\d{2}-\\d{2}[^'\"\\]]*";
-
-const imageRegex = "image";
-const combinedRegex = `(${[defaultScreenshotRegex, imageRegex].join("|")})`;
-
-const markdownAltRegex = new RegExp(`!\\[${combinedRegex}\\]\\(.*\\)`, "gid");
-const htmlAltRegex = new RegExp(`alt=["']${combinedRegex}["']`, "gid");
-
-export 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}`
-          });
-        }
-      }
-    }
-  }
-};

package/src/rules/no-empty-alt-text.ts

@@ -1,48 +0,0 @@
-export 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]
-            });
-          }
-        }
-      }
-    }
-  }
-};

package/src/rules/no-generic-link-text.ts

@@ -1,62 +0,0 @@
-function stripAndDowncaseText(text) {
-  return text
-    .toLowerCase()
-    .replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "")
-    .replace(/\s+/g, " ")
-    .trim();
-}
-
-const bannedLinkText = [
-  "read more",
-  "learn more",
-  "more",
-  "here",
-  "click here",
-  "link"
-];
-
-export 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) {
-    // markdown syntax
-    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;
-        }
-      }
-    }
-  }
-};

package/src/style/accessibility.json

@@ -1,14 +0,0 @@
-{
-  "no-alt-text": true,
-  "no-default-alt-text": true,
-  "no-duplicate-header": true,
-  "no-emphasis-as-header": true,
-  "no-generic-link-text": true,
-  "heading-increment": true,
-  "no-space-in-links": false,
-  "ol-prefix": "ordered",
-  "single-h1": true,
-  "ul-style": {
-    "style": "asterisk"
-  }
-}

package/src/style/base.json

@@ -1,12 +0,0 @@
-{
-  "default": true,
-  "no-inline-html": false,
-  "no-bare-urls": false,
-  "no-alt-text": true,
-  "no-blanks-blockquote": false,
-  "fenced-code-language": true,
-  "heading-increment": true,
-  "single-h1": true,
-  "no-emphasis-as-header": true,
-  "first-line-heading": false
-}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "resolveJsonModule": true,
-    "noEmit": true
-  },
-  "files": [],
-  "include": ["src/**/*.ts", "src/**/*.js", "bin/**/*"],
-  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.spec.json

@@ -1,13 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "types": ["jest", "node"]
-  },
-  "include": [
-    "jest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.d.ts"
-  ]
-}