@mui/internal-code-infra 0.0.3-canary.1 → 0.0.3-canary.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-code-infra",
-  "version": "0.0.3-canary.1",
+  "version": "0.0.3-canary.3",
   "description": "Infra scripts and configs to be used across MUI repos.",
   "type": "module",
   "license": "MIT",
@@ -14,7 +14,8 @@
     "./package.json": "./package.json",
     "./prettier": "./src/prettier.mjs",
     "./eslint": "./src/eslint/index.mjs",
-    "./babel-config": "./src/babel-config.mjs"
+    "./babel-config": "./src/babel-config.mjs",
+    "./markdownlint": "./src/markdownlint/index.mjs"
   },
   "bin": {
     "code-infra": "./bin/code-infra.mjs"
@@ -58,8 +59,8 @@
     "semver": "^7.7.2",
     "typescript-eslint": "^8.40.0",
     "yargs": "^18.0.0",
-    "@mui/internal-babel-plugin-minify-errors": "2.0.8-canary.7",
     "@mui/internal-babel-plugin-display-name": "1.0.4-canary.6",
+    "@mui/internal-babel-plugin-minify-errors": "2.0.8-canary.8",
     "@mui/internal-babel-plugin-resolve-imports": "2.0.7-canary.19"
   },
   "peerDependencies": {
@@ -91,7 +92,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitSha": "2159d7ef17d0ea7ff2ba98c5df9f6519fcaccfbe",
+  "gitSha": "6a3e097acfa56e9838d2edb7f05755bda41f365d",
   "scripts": {
     "typescript": "tsc -p tsconfig.json",
     "test": "pnpm -w test --project @mui/internal-code-infra",

package/src/markdownlint/duplicate-h1.mjs

@@ -0,0 +1,69 @@
+/**
+ * @typedef {[string, string]} Attr
+ */
+
+/**
+ * @typedef {Object} Token
+ * @property {string} type
+ * @property {string} info
+ * @property {string} tag
+ * @property {string} content
+ * @property {number} lineNumber
+ * @property {Attr[]} attrs
+ */
+
+/**
+ * @typedef {Object} OnErrorObj
+ * @property {number} lineNumber
+ * @property {string} [detail]
+ */
+
+/**
+ * @typedef {(err: OnErrorObj) => void} OnError
+ */
+
+/**
+ * @typedef {Object} MdParams
+ * @property {string} name
+ * @property {string[]} lines
+ * @property {Token[]} tokens
+ */
+
+// This rule is an extension of MD025/no-multiple-top-level-headings.
+// The rule is buggy https://github.com/DavidAnson/markdownlint/pull/1109
+// but also blog headers don't tell you that h1 is already injected.
+export default {
+  names: ['duplicateH1'],
+  description: 'Multiple top-level headings in the same document.',
+  tags: ['headings'],
+  /**
+   * @param {import('./duplicate-h1.mjs').MdParams} params
+   * @param {import('./duplicate-h1.mjs').OnError} onError
+   */
+  function: (params, onError) => {
+    /**
+     * @type {number|boolean}
+     */
+    let hasTopLevelHeading = false;
+    params.tokens.forEach((token) => {
+      if (token.type === 'heading_open' && token.tag === 'h1') {
+        // Avoid duplicate errors with MD025.
+        if (hasTopLevelHeading !== false && hasTopLevelHeading !== 1) {
+          onError({
+            lineNumber: token.lineNumber,
+          });
+        } else if (params.name.includes('/docs/pages/blog/')) {
+          onError({
+            lineNumber: token.lineNumber,
+            detail: 'In the blog, the h1 is already added using the markdown header.title value.',
+          });
+        }
+
+        // Store the first h1 of the page.
+        if (hasTopLevelHeading === false) {
+          hasTopLevelHeading = token.lineNumber;
+        }
+      }
+    });
+  },
+};

package/src/markdownlint/git-diff.mjs

@@ -0,0 +1,31 @@
+export default {
+  names: ['gitDiff'],
+  description: 'Respect the format output of git diff.',
+  tags: ['spaces'],
+  /**
+   * @param {import('./duplicate-h1.mjs').MdParams} params
+   * @param {import('./duplicate-h1.mjs').OnError} onError
+   */
+  function: (params, onError) => {
+    params.tokens.forEach((token) => {
+      if (token.type === 'fence' && token.info === 'diff') {
+        token.content.split('\n').forEach((line, index) => {
+          if (
+            line[0] !== ' ' &&
+            line[0] !== '-' &&
+            line[0] !== '+' &&
+            line !== '' &&
+            line.indexOf('@@ ') !== 0 &&
+            line.indexOf('diff --git ') !== 0 &&
+            line.indexOf('index ') !== 0
+          ) {
+            onError({
+              lineNumber: token.lineNumber + index + 1,
+              detail: `The line start with "+" or "-" or " ": ${line}`,
+            });
+          }
+        });
+      }
+    });
+  },
+};

package/src/markdownlint/index.mjs

@@ -0,0 +1,62 @@
+import straightQuotes from './straight-quotes.mjs';
+import gitDiff from './git-diff.mjs';
+import tableAlignment from './table-alignment.mjs';
+import terminalLanguage from './terminal-language.mjs';
+import duplicateH1 from './duplicate-h1.mjs';
+
+/**
+ * Create a base configuration for markdownlint.
+ * @param {Object} options
+ * @param {(typeof straightQuotes)[]} [options.rules] - An array of custom rules to include.
+ * @param {string[]} [options.ignores] - An array of glob patterns to ignore.
+ * @returns
+ */
+export function createBaseConfig(options = {}) {
+  const { rules = [], ignores = [] } = options;
+  // https://github.com/DavidAnson/markdownlint#rules--aliases
+  return {
+    config: {
+      default: true,
+      MD004: false, // MD004/ul-style. Buggy
+      MD009: {
+        // MD009/no-trailing-spaces
+        br_spaces: 0,
+        strict: true,
+        list_item_empty_lines: false,
+      },
+      MD013: false, // MD013/line-length. Already handled by Prettier.
+      MD014: false, // MD014/commands-show-output. It's OK.
+      MD024: { siblings_only: true }, // MD024/no-duplicate-heading/no-duplicate-header
+      MD025: {
+        // Heading level
+        level: 1,
+        // RegExp for matching title in front matter
+        front_matter_title: '',
+      },
+      MD033: false, // MD033/no-inline-html. We use it from time to time, it's fine.
+      MD034: false, // MD034/no-bare-urls. Not a concern for us, our Markdown interpreter supports it.
+      MD028: false, // MD028/no-blanks-blockquote prevent double blockquote
+      MD029: false, // MD029/ol-prefix. Buggy
+      MD031: false, // MD031/blanks-around-fences Some code blocks inside li
+      MD036: false, // MD036/no-emphasis-as-heading/no-emphasis-as-header. It's OK.
+      MD051: false, // MD051/link-fragments. Many false positives in the changelog.
+      MD052: false, // MD052/reference-links-images. Many false positives in the changelog.
+      MD059: false, // MD059/descriptive-link-text. Does not allow links on text like "link", whereas we redirect to "Link" component.
+      straightQuotes: true,
+      gitDiff: true,
+      tableAlignment: true,
+      terminalLanguage: true,
+      duplicateH1: true,
+    },
+    customRules: [straightQuotes, gitDiff, tableAlignment, terminalLanguage, duplicateH1, ...rules],
+    ignores: [
+      'CHANGELOG.old.md',
+      '**/node_modules/**',
+      '**/build/**',
+      '.github/PULL_REQUEST_TEMPLATE.md',
+      'docs/public/**',
+      'docs/export/**',
+      ...ignores,
+    ],
+  };
+}

package/src/markdownlint/straight-quotes.mjs

@@ -0,0 +1,26 @@
+const nonStraightQuotes = /[‘’“”]/;
+
+export default {
+  names: ['straightQuotes'],
+  description: 'Only allow straight quotes.',
+  tags: ['spelling'],
+  /**
+   * @param {import('./duplicate-h1.mjs').MdParams} params
+   * @param {import('./duplicate-h1.mjs').OnError} onError
+   */
+  function: (params, onError) => {
+    params.lines.forEach((line, lineNumber) => {
+      // It will match
+      // opening single quote: \xE2\x80\x98
+      // closing single quote: \xE2\x80\x99
+      // opening double quote: \xE2\x80\x9C
+      // closing double quote: \xE2\x80\x9D
+      if (nonStraightQuotes.test(line)) {
+        onError({
+          lineNumber: lineNumber + 1,
+          detail: `For line: ${line}`,
+        });
+      }
+    });
+  },
+};

package/src/markdownlint/table-alignment.mjs

@@ -0,0 +1,42 @@
+/**
+ * @param {import('./duplicate-h1.mjs').Attr[]} attrs
+ * @returns {Record<string, string>}
+ */
+function attr(attrs) {
+  return (attrs || []).reduce((acc, item) => ({ ...acc, [item[0]]: item[1] }), {});
+}
+
+export default {
+  names: ['tableAlignment'],
+  description: 'Set table alignment.',
+  tags: ['table'],
+  /**
+   * @param {import('./duplicate-h1.mjs').MdParams} params
+   * @param {import('./duplicate-h1.mjs').OnError} onError
+   */
+  function: (params, onError) => {
+    params.tokens.forEach((token) => {
+      // This is wrong:
+      // | Version | Supported          |
+      // | ------- | ------------------ |
+      //
+      // The second column should be left aligned because it contains text:
+      // | Version | Supported          |
+      // | ------- | :----------------- |
+      //
+      // However, columns that includes numbers should be right aligned:
+      // | Version | Supported          |
+      // | ------: | :----------------- |
+      //
+      // More details: https://ux.stackexchange.com/questions/24066/what-is-the-best-practice-for-data-table-cell-content-alignment
+      //
+      // In this check we expect the style to be 'text-align:right' or equivalent.
+      if (token.type === 'th_open' && attr(token.attrs).style == null) {
+        onError({
+          lineNumber: token.lineNumber,
+          detail: `${params.lines[token.lineNumber - 1]}`,
+        });
+      }
+    });
+  },
+};

package/src/markdownlint/terminal-language.mjs

@@ -0,0 +1,19 @@
+export default {
+  names: ['terminalLanguage'],
+  description: 'Set the right language for terminal code.',
+  tags: ['code'],
+  /**
+   * @param {import('./duplicate-h1.mjs').MdParams} params
+   * @param {import('./duplicate-h1.mjs').OnError} onError
+   */
+  function: (params, onError) => {
+    params.tokens.forEach((token) => {
+      if (token.type === 'fence' && token.info === 'sh') {
+        onError({
+          lineNumber: token.lineNumber,
+          detail: `Use "bash" instead of "sh".`,
+        });
+      }
+    });
+  },
+};