@mui/internal-code-infra 0.1.1-canary.11 → 0.1.1-canary.13

package/build/remark/config.d.mts

@@ -1,5 +1,3 @@
-import remarkGfm from 'remark-gfm';
-import remarkLint from 'remark-lint';
 /**
  * Returns a remark preset wiring the MUI-authored remark-lint plugins together
  * with a curated set of community plugins. Drop this into `.remarkrc.mjs`:
@@ -23,21 +21,14 @@ import remarkLint from 'remark-lint';
  * ```
  *
  * @param {Object} [options]
+ * @param {boolean} [options.allowDefinitionComments=false] Allow titled `[//]` link-reference comments.
  * @param {Array<{ files: string | string[], rules: Record<string, false | unknown[]> }>} [options.overrides]
+ * @returns {import('unified').Preset}
  */
-export declare function createRemarkConfig({ overrides }?: {
+export declare function createRemarkConfig({ overrides, allowDefinitionComments }?: {
+    allowDefinitionComments?: boolean;
     overrides?: Array<{
         files: string | string[];
         rules: Record<string, false | unknown[]>;
     }>;
-}): {
-    settings: {
-        bullet: string;
-        emphasis: string;
-        fence: string;
-        listItemIndent: string;
-        resourceLink: boolean;
-        rule: string;
-    };
-    plugins: (any[] | typeof remarkGfm | typeof remarkLint)[];
-};
+}): import('unified').Preset;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-code-infra",
-  "version": "0.1.1-canary.11",
+  "version": "0.1.1-canary.13",
   "author": "MUI Team",
   "description": "Infra scripts and configs to be used across MUI repos.",
   "license": "MIT",
@@ -53,31 +53,31 @@
     "code-infra": "./bin/code-infra.mjs"
   },
   "dependencies": {
-    "@argos-ci/core": "6.8.6",
+    "@argos-ci/core": "6.8.7",
     "@babel/cli": "^8.0.6",
-    "@babel/core": "^8.0.6",
+    "@babel/core": "^8.0.7",
     "@babel/plugin-syntax-jsx": "^8.0.1",
     "@babel/plugin-syntax-typescript": "^8.0.3",
     "@babel/plugin-transform-react-pure-annotations": "^8.0.1",
     "@babel/plugin-transform-runtime": "^8.0.6",
-    "@babel/preset-env": "^8.0.6",
+    "@babel/preset-env": "^8.0.7",
     "@babel/preset-react": "^8.0.1",
-    "@babel/preset-typescript": "^8.0.1",
+    "@babel/preset-typescript": "^8.0.7",
     "@eslint/compat": "^2.1.1",
     "@eslint/js": "^10.0.1",
-    "@eslint/json": "^2.1.0",
-    "@inquirer/confirm": "^6.3.2",
-    "@inquirer/select": "^5.2.5",
-    "@mui/internal-babel-plugin-display-name": "2.0.1-canary.1",
-    "@mui/internal-babel-plugin-minify-errors": "3.0.1-canary.1",
-    "@mui/internal-babel-plugin-resolve-imports": "3.0.1-canary.2",
+    "@eslint/json": "^2.1.1",
+    "@inquirer/confirm": "^6.3.3",
+    "@inquirer/select": "^5.2.6",
+    "@mui/internal-babel-plugin-display-name": "2.0.1-canary.2",
+    "@mui/internal-babel-plugin-minify-errors": "3.0.1-canary.2",
+    "@mui/internal-babel-plugin-resolve-imports": "3.0.1-canary.3",
     "@napi-rs/keyring": "^2.1.0",
     "@octokit/auth-action": "^6.0.3",
     "@octokit/oauth-methods": "^6.0.5",
     "@octokit/plugin-retry": "^8.1.1",
     "@octokit/plugin-throttling": "^11.0.5",
     "@octokit/rest": "^22.0.1",
-    "@pnpm/config.version-policy": "^1100.2.5",
+    "@pnpm/config.version-policy": "^1100.2.7",
     "@pnpm/find-workspace-dir": "^1000.1.5",
     "@pnpm/parse-wanted-dependency": "^1001.0.0",
     "@typescript-eslint/types": "^8.71.1",
@@ -104,11 +104,11 @@
     "eslint-plugin-react-compiler": "^19.1.0-rc.2",
     "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-testing-library": "^7.16.2",
-    "execa": "^10.0.1",
+    "execa": "^10.1.0",
     "git-url-parse": "^16.1.0",
     "globals": "^17.13.0",
     "globby": "^16.2.4",
-    "html-validate": "^11.16.1",
+    "html-validate": "^11.16.2",
     "minimatch": "^10.2.6",
     "node-html-parser": "^9.0.4",
     "open": "^11.0.4",
@@ -189,7 +189,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitSha": "f0f2046d46bd579cf674deedc6c85eb83f6ec2bf",
+  "gitSha": "abd0d2ce073f905bfa623ebf593a5d37de499b72",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typescript": "tsc -noEmit",

package/src/remark/config.mjs

@@ -97,6 +97,37 @@ function withOverrides(name, plugin, baseSettings, overrideEntries) {
   return wrapper;
 }
 
+/**
+ * Allows link-reference comments while retaining diagnostics for real links and definitions.
+ * Existing docs generators use these markers in both Markdown and MDX and parse them as metadata.
+ * Authored MDX can use JSX comments without this compatibility option.
+ *
+ * @param {import('unified').Plugin<any[], any, any>} plugin
+ */
+function withDefinitionComments(plugin) {
+  /** @param {any[]} settings */
+  return function wrapper(...settings) {
+    const processor = unified().use(plugin, ...settings);
+    /** @type {import('unified').Transformer} */
+    return async function transformer(tree, file) {
+      const previousMessages = file.messages.length;
+      await processor.run(tree, file);
+      file.messages = file.messages.filter((message, index) => {
+        const node = message.ancestors?.at(-1);
+        return !(
+          index >= previousMessages &&
+          node?.type === 'definition' &&
+          'identifier' in node &&
+          node.identifier === '//' &&
+          'title' in node &&
+          typeof node.title === 'string' &&
+          node.title.length > 0
+        );
+      });
+    };
+  };
+}
+
 /**
  * Returns a remark preset wiring the MUI-authored remark-lint plugins together
  * with a curated set of community plugins. Drop this into `.remarkrc.mjs`:
@@ -120,9 +151,11 @@ function withOverrides(name, plugin, baseSettings, overrideEntries) {
  * ```
  *
  * @param {Object} [options]
+ * @param {boolean} [options.allowDefinitionComments=false] Allow titled `[//]` link-reference comments.
  * @param {Array<{ files: string | string[], rules: Record<string, false | unknown[]> }>} [options.overrides]
+ * @returns {import('unified').Preset}
  */
-export function createRemarkConfig({ overrides = [] } = {}) {
+export function createRemarkConfig({ overrides = [], allowDefinitionComments = false } = {}) {
   for (const override of overrides) {
     const unknown = Object.keys(override.rules).filter((ruleName) => !(ruleName in RULES));
     if (unknown.length > 0) {
@@ -130,10 +163,14 @@ export function createRemarkConfig({ overrides = [] } = {}) {
     }
   }
 
+  /** @type {import('unified').PluggableList} */
   const entries = Object.entries(RULES).map(([name, entry]) => {
-    const [plugin, baseSettings] = /** @type {[import('unified').Plugin<any[], any, any>, any]} */ (
-      entry
-    );
+    const [rulePlugin, baseSettings] =
+      /** @type {[import('unified').Plugin<any[], any, any>, any]} */ (entry);
+    const plugin =
+      allowDefinitionComments && (name === 'no-empty-url' || name === 'no-unused-definitions')
+        ? withDefinitionComments(rulePlugin)
+        : rulePlugin;
     const overrideEntries = overrides
       .filter((override) => name in override.rules)
       .map((override) => ({ files: override.files, settings: override.rules[name] }));