feat!: add code block rule and mdx formatters using oxfmt

Signed-off-by: Ryan Bower <rbower@qti.qualcomm.com>

Author: R-Bower

packages/configs/eslint-config-mdx/.remarkrc

@@ -10,7 +10,10 @@
     "remark-lint-no-consecutive-blank-lines",
     "remark-lint-no-duplicate-headings-in-section",
     ["remark-lint-no-heading-punctuation", ",.:;"],
-    ["remark-lint-unordered-list-marker-style", "-"]
+    ["remark-lint-unordered-list-marker-style", "-"],
+    "./dist/remark-lint-code-format.js",
+    "./dist/remark-lint-mdx-jsx-format.js",
+    "./dist/remark-preserve-alert-markers.js"
   ],
   "settings": {
     "bullet": "-",

packages/configs/eslint-config-mdx/CHANGELOG.md

@@ -22,7 +22,7 @@ Apr 19th, 2026
 
 ### Miscellaneous Chores
 
-- upgrade prettier and eslint dependenies, fix resulting formatting issues ([332185a](https://github.com/qualcomm/qualcomm-ui/commit/332185a))
+- upgrade prettier and eslint dependencies, fix resulting formatting issues ([332185a](https://github.com/qualcomm/qualcomm-ui/commit/332185a))
 
 ## 1.1.0
 

packages/configs/eslint-config-mdx/build.ts

@@ -0,0 +1,36 @@
+import type {BuildOptions} from "esbuild"
+
+import {buildOrWatch, hasArg, logPlugin} from "@qualcomm-ui/esbuild"
+
+import pkg from "./package.json"
+
+async function build(argv: string[]) {
+  const IS_WATCH = hasArg(argv, "--watch")
+
+  const buildOpts: BuildOptions = {
+    bundle: true,
+    entryPoints: [
+      "./src/index.ts",
+      "./src/remark-lint-code-format.ts",
+      "./src/remark-lint-mdx-jsx-format.ts",
+      "./src/remark-preserve-alert-markers.ts",
+      "./src/remarkrc.ts",
+    ],
+    external: [
+      ...Object.keys(pkg.devDependencies ?? {}),
+      ...Object.keys(pkg.peerDependencies ?? {}),
+    ],
+    format: "esm",
+    metafile: true,
+    outdir: "./dist",
+    platform: "node",
+    plugins: [logPlugin({bundleSizeOptions: {logMode: "all"}})],
+    sourcemap: true,
+    target: "es2022",
+    tsconfig: "tsconfig.lib.json",
+  }
+
+  await buildOrWatch(buildOpts, IS_WATCH)
+}
+
+build(process.argv)

packages/configs/eslint-config-mdx/index.d.ts

@@ -8,36 +8,73 @@
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "config",
+    "eslint",
+    "react"
+  ],
   "type": "module",
   "sideEffects": false,
   "files": [
-    "index.d.ts",
-    "index.js",
-    "recommended.js",
+    "dist/",
     ".remarkrc"
   ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js",
-      "default": "./index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     },
     "./remarkrc": {
-      "types": "./remarkrc.d.ts",
-      "import": "./remarkrc.js",
-      "default": "./remarkrc.js"
+      "types": "./dist/remarkrc.d.ts",
+      "import": "./dist/remarkrc.js",
+      "default": "./dist/remarkrc.js"
+    },
+    "./remark-lint-code-format": {
+      "types": "./dist/remark-lint-code-format.d.ts",
+      "import": "./dist/remark-lint-code-format.js",
+      "default": "./dist/remark-lint-code-format.js"
+    },
+    "./remark-lint-mdx-jsx-format": {
+      "types": "./dist/remark-lint-mdx-jsx-format.d.ts",
+      "import": "./dist/remark-lint-mdx-jsx-format.js",
+      "default": "./dist/remark-lint-mdx-jsx-format.js"
+    },
+    "./remark-preserve-alert-markers": {
+      "types": "./dist/remark-preserve-alert-markers.d.ts",
+      "import": "./dist/remark-preserve-alert-markers.js",
+      "default": "./dist/remark-preserve-alert-markers.js"
     }
   },
   "scripts": {
-    "prepublishOnly": "qui-cli pre-publish",
+    "build": "run-s clean build:js build:types",
+    "build:js": "tsx build.ts",
+    "build:types": "tsc -p tsconfig.lib.json",
+    "build:watch": "run-p watch:js watch:types",
+    "watch:js": "tsx build.ts --watch",
+    "watch:types": "tsc -p tsconfig.lib.json -w --preserveWatchOutput",
+    "clean": "shx rm -rf dist",
+    "lint": "eslint --quiet",
+    "test": "turbo build --filter @qualcomm-ui/eslint-config-mdx && vitest -c vitest.config.ts --run",
+    "test:unit:ci": "pnpm build && cross-env NODE_OPTIONS='' vitest -c vitest.config.ts --run --pool=threads --no-file-parallelism",
+    "prepublishOnly": "pnpm build && qui-cli pre-publish",
     "postpublish": "qui-cli post-publish"
   },
   "devDependencies": {
     "@eslint/core": "^1.0.0",
     "@qualcomm-ui/cli": "catalog:",
+    "@qualcomm-ui/esbuild": "catalog:",
+    "@qualcomm-ui/tsconfig": "catalog:",
+    "cross-env": "^10.1.0",
+    "esbuild": "catalog:",
     "eslint-mdx": "^3.7.0",
     "eslint-plugin-mdx": "^3.7.0",
     "eslint-plugin-react": "^7.37.5",
+    "npm-run-all2": "catalog:",
+    "oxfmt": "catalog:",
     "remark-frontmatter": "^5.0.0",
     "remark-lint-fenced-code-flag": "^4.2.0",
     "remark-lint-final-newline": "^3.0.1",
@@ -49,13 +86,18 @@
     "remark-lint-no-duplicate-headings-in-section": "^4.0.1",
     "remark-lint-no-heading-punctuation": "^4.0.1",
     "remark-lint-unordered-list-marker-style": "^4.0.1",
-    "unified": "catalog:"
+    "shx": "catalog:",
+    "tsx": "catalog:",
+    "typescript": "catalog:",
+    "unified": "catalog:",
+    "vitest": "catalog:"
   },
   "peerDependencies": {
     "eslint": ">=9.37.0",
     "eslint-mdx": ">=3.7.0",
     "eslint-plugin-mdx": ">=3.7.0",
     "eslint-plugin-react": ">=7.37.5",
+    "oxfmt": ">=0.48.0",
     "remark-frontmatter": ">=5.0.0",
     "remark-lint-fenced-code-flag": ">=4.2.0",
     "remark-lint-final-newline": ">=3.0.1",
@@ -70,10 +112,5 @@
     "typescript": ">=5.9.3",
     "typescript-eslint": ">=8.31.1",
     "unified": ">=11"
-  },
-  "keywords": [
-    "eslint",
-    "config",
-    "react"
-  ]
+  }
 }

packages/configs/eslint-config-mdx/index.js

@@ -0,0 +1,12 @@
+// Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: BSD-3-Clause-Clear
+
+import recommended from "./recommended.js"
+
+const mdxConfig = {
+  configs: {
+    recommended,
+  },
+}
+
+export default mdxConfig

packages/configs/eslint-config-mdx/package.json

@@ -0,0 +1,172 @@
+import {readFile} from "node:fs/promises"
+import {dirname, isAbsolute, join, parse, resolve} from "node:path"
+import {pathToFileURL} from "node:url"
+import {format as formatCode, type FormatConfig} from "oxfmt"
+import {parseConfigFileTextToJson} from "typescript"
+
+const CONFIG_FILENAMES = [".oxfmtrc.json", ".oxfmtrc.jsonc", "oxfmt.config.ts"]
+const configCache = new Map<string, Promise<FormatConfig>>()
+
+export async function loadOxfmtConfig(
+  filePath: string | undefined,
+): Promise<FormatConfig> {
+  const basePath = getAbsolutePath(filePath)
+  const startDir = parse(basePath).ext ? dirname(basePath) : basePath
+  const cachedConfig = configCache.get(startDir)
+
+  if (cachedConfig) {
+    return cachedConfig
+  }
+
+  const configPromise = findOxfmtConfig(startDir).catch((error: unknown) => {
+    configCache.delete(startDir)
+    throw error
+  })
+
+  configCache.set(startDir, configPromise)
+
+  return configPromise
+}
+
+export async function formatOxfmt(
+  filePath: string,
+  value: string,
+  config: FormatConfig,
+): Promise<null | string> {
+  try {
+    const result = await formatCode(filePath, value, config)
+
+    if (result.errors.length > 0) {
+      return null
+    }
+
+    return removeFinalEol(result.code)
+  } catch {
+    return null
+  }
+}
+
+export function getAbsolutePath(filePath: string | undefined): string {
+  if (!filePath) {
+    return process.cwd()
+  }
+
+  return isAbsolute(filePath) ? filePath : resolve(process.cwd(), filePath)
+}
+
+export function getErrorMessage(error: unknown): string {
+  if (error instanceof Error) {
+    return error.message
+  }
+
+  return String(error)
+}
+
+async function findOxfmtConfig(startDir: string): Promise<FormatConfig> {
+  let currentDir = startDir
+
+  while (true) {
+    for (const configFilename of CONFIG_FILENAMES) {
+      const configPath = join(currentDir, configFilename)
+      const config = await readOxfmtConfig(configPath, configFilename)
+
+      if (config) {
+        return config
+      }
+    }
+
+    const parentDir = dirname(currentDir)
+
+    if (parentDir === currentDir) {
+      return {}
+    }
+
+    currentDir = parentDir
+  }
+}
+
+async function readOxfmtConfig(
+  configPath: string,
+  configFilename: string,
+): Promise<FormatConfig | null> {
+  if (configFilename === "oxfmt.config.ts") {
+    return readTypeScriptConfig(configPath)
+  }
+
+  const source = await readOptionalFile(configPath)
+
+  if (source === null) {
+    return null
+  }
+
+  if (configFilename.endsWith(".jsonc")) {
+    return validateConfig(configPath, readJsoncConfig(configPath, source))
+  }
+
+  return validateConfig(configPath, JSON.parse(source))
+}
+
+async function readTypeScriptConfig(
+  configPath: string,
+): Promise<FormatConfig | null> {
+  const source = await readOptionalFile(configPath)
+
+  if (source === null) {
+    return null
+  }
+
+  const url = pathToFileURL(configPath)
+  url.searchParams.set("cache", Date.now().toString())
+
+  const module = (await import(url.href)) as {default?: unknown}
+
+  return validateConfig(configPath, module.default)
+}
+
+function readJsoncConfig(configPath: string, source: string): unknown {
+  const result = parseConfigFileTextToJson(configPath, source)
+
+  if (result.error) {
+    throw new Error(String(result.error.messageText))
+  }
+
+  return result.config
+}
+
+function validateConfig(configPath: string, config: unknown): FormatConfig {
+  if (!isPlainConfig(config)) {
+    throw new Error(`${configPath} must define an object`)
+  }
+
+  return config as FormatConfig
+}
+
+async function readOptionalFile(path: string): Promise<null | string> {
+  try {
+    return await readFile(path, "utf8")
+  } catch (error) {
+    if (isMissingFileError(error)) {
+      return null
+    }
+
+    throw error
+  }
+}
+
+function removeFinalEol(value: string): string {
+  return value.replace(/\r?\n$/u, "")
+}
+
+function isPlainConfig(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value)
+}
+
+function isMissingFileError(error: unknown): boolean {
+  if (typeof error !== "object" || error === null || !("code" in error)) {
+    return false
+  }
+
+  const {code} = error
+
+  return code === "ENOENT" || code === "ENOTDIR"
+}

packages/configs/eslint-config-mdx/src/index.ts

@@ -5,7 +5,7 @@ import {defineConfig} from "eslint/config"
 import * as mdx from "eslint-plugin-mdx"
 import reactPlugin from "eslint-plugin-react"
 
-export default defineConfig({
+const recommended = defineConfig({
   ...mdx.flat,
   plugins: {
     ...mdx.flat.plugins,
@@ -17,3 +17,5 @@ export default defineConfig({
     "no-unused-expressions": "off",
   },
 })
+
+export default recommended