also lint mdx, add rule for canonicalReferences

Author: phryneas

eslint-local-rules/canonical-references.ts

@@ -67,6 +67,41 @@ export const validInheritDoc = ESLintUtils.RuleCreator.withoutDocs({
   defaultOptions: [],
 });
 
+export const validMdxCanonicalReferences = ESLintUtils.RuleCreator.withoutDocs({
+  create(context, optionsWithDefault) {
+    return {
+      JSXAttribute(node: AST.JSXAttribute) {
+        if (node.name.name == "canonicalReference") {
+          const ref =
+            node.value.type === "JSXExpressionContainer" ?
+              node.value.expression
+            : node.value;
+          if (!ref || ref.type !== "Literal" || typeof ref.value !== "string") {
+            context.report({
+              node: ref || node,
+              messageId: "shouldBeString",
+            });
+          } else if (!referenceSet.has(ref.value)) {
+            context.report({
+              node: ref,
+              messageId: "invalidCanonicalReference",
+            });
+          }
+        }
+      },
+    };
+  },
+  meta: {
+    messages: {
+      shouldBeString: "The canonicalReference value should be a string.",
+      invalidCanonicalReference: "Unknown canonical reference.",
+    },
+    type: "problem",
+    schema: [],
+  },
+  defaultOptions: [],
+});
+
 function locForMatch(
   source: SourceCode,
   node: AST.NodeOrTokenData,

eslint-local-rules/index.mjs

@@ -1,4 +1,7 @@
-import { validInheritDoc } from "./canonical-references.ts";
+import {
+  validInheritDoc,
+  validMdxCanonicalReferences,
+} from "./canonical-references.ts";
 import { rule as forbidActInDisabledActEnvironment } from "./forbid-act-in-disabled-act-environment.ts";
 import {
   importFromExport,
@@ -20,4 +23,5 @@ export default {
   "no-duplicate-exports": noDuplicateExports,
   "no-relative-imports": noRelativeImports,
   "valid-inherit-doc": validInheritDoc,
+  "mdx-valid-canonical-references": validMdxCanonicalReferences,
 };

eslint.config.mjs

@@ -21,6 +21,7 @@ import js from "@eslint/js";
 import typescriptEslint from "@typescript-eslint/eslint-plugin";
 import tsParser from "@typescript-eslint/parser";
 import _import from "eslint-plugin-import";
+import * as mdx from "eslint-plugin-mdx";
 import reactCompiler from "eslint-plugin-react-compiler";
 import globals from "globals";
 
@@ -39,15 +40,18 @@ const compat = new FlatCompat({
  */
 const runExtendedRules = !!process.env.EXTENDED_RULES;
 
+const tsPlugins = {
+  import: fixupPluginRules(_import),
+  "local-rules": {
+    rules: localRules,
+  },
+  "@typescript-eslint": typescriptEslint,
+};
+
 export default [
   {
-    plugins: {
-      "@typescript-eslint": typescriptEslint,
-      import: fixupPluginRules(_import),
-      "local-rules": {
-        rules: localRules,
-      },
-    },
+    files: ["**/*.ts", "**/*.tsx"],
+    plugins: tsPlugins,
     ignores: ["tests.codegen.ts"],
 
     languageOptions: {
@@ -139,6 +143,7 @@ export default [
 
     plugins: {
       "react-compiler": reactCompiler,
+      ...tsPlugins,
     },
 
     languageOptions: {
@@ -192,7 +197,6 @@ export default [
       ],
 
       "import/consistent-type-specifier-style": ["error", "prefer-top-level"],
-
       "local-rules/require-using-disposable": "error",
       "local-rules/valid-inherit-doc": "error",
     },
@@ -215,6 +219,7 @@ export default [
       "**/?(*.)+(test).[jt]sx",
     ],
 
+    plugins: tsPlugins,
     languageOptions: {
       ecmaVersion: 5,
       sourceType: "script",
@@ -257,4 +262,21 @@ export default [
       "local-rules/no-relative-imports": "off",
     },
   },
+  {
+    basePath: "docs",
+    ...mdx.flat,
+    plugins: {
+      ...mdx.flat.plugins,
+      "local-rules": {
+        rules: localRules,
+      },
+    },
+    rules: {
+      "local-rules/mdx-valid-canonical-references": "error",
+    },
+  },
+  {
+    basePath: "docs",
+    ...mdx.flatCodeBlocks,
+  },
 ];