eslint-plugin-oxfmt 0.26.0 → 0.28.0

package/README.md

@@ -24,22 +24,18 @@ Maintained in the [eslint-plugin-oxfmt monorepo](https://github.com/ntnyq/eslint
 
 - **ESLint**: `^9.5.0 || ^10.0.0` (Only supports ESLint flat config)
 - **Node.js**: `^22.13.0 || >=24`
-- **oxfmt**: `>= 0.71.0`
-
-Upgrading from oxfmt 0.70.0 to 0.71.0 preserves comment order around test-call
-arguments and comments on either side of assignment operators. It also fixes
-adjacent block comments, trailing spaces in block comments, and JSDoc hard
-breaks, including `/***` comments. The bundled Prettier upgrade from 3.9.6 to
-3.9.9 fixes embedded template indentation and Markdown handling of single
-tildes, dollar signs, Liquid syntax, blockquotes, and list indentation. Existing
-files may receive formatting fixes after upgrading. No formatting options were
-added, renamed, or removed, and config merge precedence is unchanged.
-
-The upstream native Markdown formatter is not yet used by the published
-formatting API; Markdown still uses Prettier, including frontmatter formatting.
-The upstream fix for repeated CLI calls in one process does not affect this
-plugin's worker, which uses the formatting API.
-See the upstream [0.71.0 release notes](https://github.com/oxc-project/oxc/releases/tag/oxfmt_v0.71.0).
+- **oxfmt**: `>= 0.73.0`
+
+Upgrading from oxfmt 0.72.0 to 0.73.0 adds language `associations` and opt-in
+Astro formatting. Install `@astrojs/compiler-rs` to use `astro: true` or an Astro
+options object. No existing options were renamed or removed.
+
+TOML now supports TOML 1.1 syntax and formats TOML frontmatter and Markdown code
+fences. Review these outputs after upgrading. Upstream also fixes CSS-in-JS
+interpolations, TypeScript instantiation parentheses, export wrapping, JSDoc
+paragraphs, and nested Svelte embeds. Config merge precedence is unchanged, and
+the loader already follows symlinked config files.
+See the upstream [0.73.0 release notes](https://github.com/oxc-project/oxc/releases/tag/oxfmt_v0.73.0).
 
 The monorepo migration aligns the Node.js requirement with `load-oxfmt-config`; Node.js 20 is no longer supported.
 
@@ -322,6 +318,7 @@ Tip: `jsdoc: true` is equivalent to enabling JSDoc with default settings.
 | `sortImports`     | `boolean \| object` | disabled | Experimental import sorting configuration                                    |
 | `sortPackageJson` | `boolean \| object` | `true`   | Experimental package.json sorting (object form: `{ sortScripts?: boolean }`) |
 | `sortTailwindcss` | `boolean \| object` | disabled | Experimental Tailwind CSS class sorting (enable with `{}` for defaults)      |
+| `astro`           | `boolean \| object` | disabled | Enable/configure Astro formatting; requires `@astrojs/compiler-rs`           |
 | `svelte`          | `boolean \| object` | disabled | Enable/configure `.svelte` formatting via `prettier-plugin-svelte`           |
 
 #### Import sorting (`sortImports`)
@@ -386,6 +383,68 @@ You can pass the Tailwind plugin options to control which attributes/functions a
 
 Paths in `sortTailwindcss.config` and `sortTailwindcss.stylesheet` are resolved relative to the oxfmt config file when set in that file or its overrides. Paths set in ESLint rule options or rule-level overrides are resolved relative to ESLint `cwd`. Absolute paths are used directly.
 
+## Language associations
+
+Use `associations` in your oxfmt config or inline rule options to format files
+as a language regardless of their extension:
+
+```js
+// eslint.config.mjs
+import pluginOxfmt from 'eslint-plugin-oxfmt'
+
+export default [
+  {
+    ...pluginOxfmt.configs.recommended,
+    files: ['**/*.{html,wxml,conf}'],
+    rules: {
+      'oxfmt/oxfmt': [
+        'error',
+        {
+          associations: [
+            {
+              files: ['**/*.html'],
+              excludeFiles: ['index.html'],
+              language: 'angular-html',
+            },
+            { files: ['**/*.wxml'], language: 'html' },
+            { files: ['**/*.conf'], language: 'json' },
+          ],
+        },
+      ],
+    },
+  },
+]
+```
+
+Each entry requires `files: string[]` and `language`; `excludeFiles: string[]`
+is optional. Later matching entries win. Languages are `javascript`, `jsx`,
+`typescript`, `tsx`, `json`, `jsonc`, `json5`, `css`, `scss`, `less`, `graphql`,
+`yaml`, `markdown`, `toml`, `html`, `angular-html`, `vue`, `svelte`, `astro`,
+`handlebars`, and `mdx`.
+
+Config associations match paths relative to the resolved config directory.
+Inline associations match relative to ESLint `cwd` and replace config
+associations entirely; `associations: []` clears them. `useConfig: false` keeps
+inline associations active. Ignores, EditorConfig, and overrides use the original
+file path. Upstream's excluded lockfiles remain excluded. Associations do not
+change ESLint file discovery or enable optional formatters automatically.
+
+### Astro options
+
+Install `@astrojs/compiler-rs` alongside this plugin, then set `astro: true`
+or an object. The compiler is an optional peer dependency.
+
+| Option                  | Type                        | Default | Description                                                                                              |
+| ----------------------- | --------------------------- | ------- | -------------------------------------------------------------------------------------------------------- |
+| `astro.allowShorthand`  | `boolean`                   | unset   | Normalize matching identifier attributes to shorthand or explicit form; unset preserves the written form |
+| `astro.compressHTML`    | `'jsx' \| 'html' \| 'none'` | `'jsx'` | Match Astro compiler whitespace collapsing                                                               |
+| `astro.skipFrontmatter` | `boolean`                   | `false` | Preserve frontmatter without formatting                                                                  |
+
+`astro: false` disables Astro formatting, including in overrides. `astro: true`
+resets inherited Astro options to defaults. With
+`embeddedLanguageFormatting: 'off'`, Astro frontmatter is still formatted by
+Prettier; use `astro.skipFrontmatter` to preserve it.
+
 ## File-specific overrides
 
 Use `overrides` to apply different oxfmt options per file glob (later entries win on conflicts):

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Linter, Rule as Rule$1 } from "eslint";
+import { Linter, Rule } from "eslint";
 import "load-oxfmt-config";
 import "oxfmt";
 //#region src/types.d.ts
@@ -13,7 +13,7 @@ interface PluginOxfmt {
     version: string;
   };
   rules: {
-    oxfmt: Rule$1.RuleModule;
+    oxfmt: Rule.RuleModule;
   };
 }
 //#endregion

package/dist/index.mjs

@@ -80,7 +80,7 @@ const configs = {
 //#region src/meta.ts
 const meta = {
 	name: "eslint-plugin-oxfmt",
-	version: "0.26.0"
+	version: "0.28.0"
 };
 //#endregion
 //#region src/dir.ts
@@ -164,6 +164,43 @@ const oxfmtOptionsSchema = {
 			enum: ["always", "avoid"],
 			type: "string"
 		},
+		astro: {
+			anyOf: [{ type: "boolean" }, {
+				additionalProperties: false,
+				type: "object",
+				properties: {
+					allowShorthand: {
+						type: "boolean",
+						description: "Whether to normalize matching identifier attributes to shorthand or explicit form.\nWhen unset, the form that was written stays as-is.\n\n- Default: Unset"
+					},
+					compressHTML: {
+						description: "Mirror of Astro's `compressHTML` config.\nTells the formatter which whitespace the compiler will collapse.\n\n- Default: `\"jsx\"`",
+						oneOf: [
+							{
+								enum: ["jsx"],
+								type: "string",
+								description: "Whitespace runs containing a newline are dropped; same-line spaces are content."
+							},
+							{
+								description: "Browser HTML whitespace rules.",
+								enum: ["html"],
+								type: "string"
+							},
+							{
+								description: "No collapsing.",
+								enum: ["none"],
+								type: "string"
+							}
+						]
+					},
+					skipFrontmatter: {
+						type: "boolean",
+						description: "Whether to skip formatting the frontmatter.\n\n- Default: `false`"
+					}
+				}
+			}],
+			description: "Options for `prettier-plugin-astro`.\n\nPass `true` or an object to enable `.astro` file formatting, `false` to disable (handy in overrides).\nSetting `true` resets to defaults, dropping options inherited from a parent scope.\n\nNOTE: `prettier-plugin-astro` requires the `@astrojs/compiler-rs` package at runtime.\nOxfmt does NOT bundle it, so install it in your project, otherwise formatting fails.\n\n- Languages: Astro\n- Default: Disabled"
+		},
 		bracketSameLine: {
 			description: `Put the > of a multi-line JSX element at the end of the last line\ninstead of being alone on the next line. (Default: false)`,
 			type: "boolean"
@@ -550,6 +587,54 @@ const oxfmtRuleSchema = {
 	properties: {
 		...oxfmtOptionsSchema.properties,
 		...oxfmtConfigSchema.properties,
+		associations: {
+			type: "array",
+			description: "Format matched files as the given language, instead of detecting it from the file name.\ne.g. Angular templates named `*.html`, or `*.wxml` files formatted as HTML.\nWhen a file matches multiple associations, the later one takes precedence (array order matters).\n\n- Default: `[]`",
+			items: {
+				additionalProperties: false,
+				required: ["files", "language"],
+				type: "object",
+				properties: {
+					excludeFiles: {
+						type: "array",
+						description: "Glob patterns excluded from this association, relative to the config directory or ESLint cwd for inline associations.",
+						items: { type: "string" }
+					},
+					files: {
+						type: "array",
+						description: "Glob patterns matched relative to the config directory, or ESLint cwd for inline associations.",
+						items: { type: "string" }
+					},
+					language: {
+						type: "string",
+						description: "The language to format matched files as, named by its Shiki id (as in Markdown code fences).",
+						enum: [
+							"javascript",
+							"jsx",
+							"typescript",
+							"tsx",
+							"json",
+							"jsonc",
+							"json5",
+							"css",
+							"scss",
+							"less",
+							"graphql",
+							"yaml",
+							"markdown",
+							"toml",
+							"html",
+							"angular-html",
+							"vue",
+							"svelte",
+							"astro",
+							"handlebars",
+							"mdx"
+						]
+					}
+				}
+			}
+		},
 		overrides: {
 			description: `File-specific overrides.\nWhen a file matches multiple overrides, the later override takes precedence (array order matters).\n\n- (Default: [])`,
 			type: "array",

package/dts/rule-options.d.ts

@@ -16,6 +16,15 @@ export type OxfmtOxfmt = []|[{
   
   arrowParens?: ("always" | "avoid")
   
+  astro?: (boolean | {
+    
+    allowShorthand?: boolean
+    
+    compressHTML?: ("jsx" | "html" | "none")
+    
+    skipFrontmatter?: boolean
+  })
+  
   bracketSameLine?: boolean
   
   bracketSpacing?: boolean
@@ -162,6 +171,15 @@ export type OxfmtOxfmt = []|[{
   
   withNodeModules?: boolean
   
+  associations?: {
+    
+    excludeFiles?: string[]
+    
+    files: string[]
+    
+    language: ("javascript" | "jsx" | "typescript" | "tsx" | "json" | "jsonc" | "json5" | "css" | "scss" | "less" | "graphql" | "yaml" | "markdown" | "toml" | "html" | "angular-html" | "vue" | "svelte" | "astro" | "handlebars" | "mdx")
+  }[]
+  
   overrides?: {
     
     excludeFiles?: string[]
@@ -172,6 +190,15 @@ export type OxfmtOxfmt = []|[{
       
       arrowParens?: ("always" | "avoid")
       
+      astro?: (boolean | {
+        
+        allowShorthand?: boolean
+        
+        compressHTML?: ("jsx" | "html" | "none")
+        
+        skipFrontmatter?: boolean
+      })
+      
       bracketSameLine?: boolean
       
       bracketSpacing?: boolean

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-oxfmt",
   "type": "module",
-  "version": "0.26.0",
+  "version": "0.28.0",
   "description": "An ESLint plugin for formatting code with oxfmt.",
   "keywords": [
     "eslint",
@@ -47,31 +47,36 @@
   },
   "sideEffects": false,
   "peerDependencies": {
+    "@astrojs/compiler-rs": "*",
     "eslint": "^9.5.0 || ^10.0.0",
-    "oxfmt": ">=0.71.0",
+    "oxfmt": ">=0.73.0",
     "svelte": "*"
   },
   "peerDependenciesMeta": {
+    "@astrojs/compiler-rs": {
+      "optional": true
+    },
     "svelte": {
       "optional": true
     }
   },
   "dependencies": {
     "generate-differences": "^0.1.1",
-    "ignore": "^7.0.10",
-    "load-oxfmt-config": "^0.26.0",
+    "ignore": "^7.0.12",
+    "load-oxfmt-config": "^0.28.0",
     "picomatch": "^4.0.7",
-    "synckit": "^0.11.13"
+    "synckit": "^0.12.3"
   },
   "devDependencies": {
+    "@astrojs/compiler-rs": "^0.5.1",
     "@types/json-schema": "^7.0.15",
     "eslint-parser-plain": "^0.1.1",
-    "eslint-plugin-oxfmt": "0.26.0",
+    "eslint-plugin-oxfmt": "0.28.0",
     "eslint-typegen": "^2.3.1",
     "eslint-vitest-rule-tester": "^3.2.0",
     "jsonc-eslint-parser": "^3.3.0",
     "show-invisibles": "^0.0.2",
-    "svelte": "^5.57.1",
+    "svelte": "^5.57.2",
     "tinyglobby": "^0.2.17"
   },
   "engines": {

package/workers/oxfmt.mjs

@@ -1,6 +1,6 @@
 // @ts-check
 
-import { dirname, extname, relative, resolve } from 'node:path'
+import { basename, dirname, extname, join, relative, resolve } from 'node:path'
 import ignore from 'ignore'
 import { isOxfmtIgnored, loadOxfmtConfigForFile } from 'load-oxfmt-config'
 import { format } from 'oxfmt'
@@ -96,6 +96,59 @@ const overrideMatcherCache = new Map()
  */
 const ignoreMatcherCache = new Map()
 
+/**
+ * Filename suffixes selecting the same formatter as upstream Language routes.
+ * The format() API does not accept a language, unlike the CLI.
+ * @type {Record<import('oxfmt').Language, string>}
+ */
+const LANGUAGE_SUFFIXES = {
+  'angular-html': 'component.html',
+  astro: 'astro',
+  css: 'css',
+  graphql: 'graphql',
+  handlebars: 'hbs',
+  html: 'html',
+  javascript: 'js',
+  json: 'json',
+  json5: 'json5',
+  jsonc: 'jsonc',
+  jsx: 'jsx',
+  less: 'less',
+  markdown: 'md',
+  mdx: 'mdx',
+  scss: 'scss',
+  svelte: 'svelte',
+  toml: 'toml',
+  tsx: 'tsx',
+  typescript: 'ts',
+  vue: 'vue',
+  yaml: 'yaml',
+}
+
+/**
+ * Upstream classify_as excludes these even when associations explicitly match.
+ * Keep this guard before substituting a formatter filename.
+ * @type {Set<string>}
+ */
+const ASSOCIATION_EXCLUDED_FILENAMES = new Set([
+  'bun.lock',
+  'Cargo.lock',
+  'composer.lock',
+  'deno.lock',
+  'flake.lock',
+  'Gopkg.lock',
+  'mcmod.info',
+  'MODULE.bazel.lock',
+  'package-lock.json',
+  'Package.resolved',
+  'pdm.lock',
+  'Pipfile.lock',
+  'pnpm-lock.yaml',
+  'poetry.lock',
+  'uv.lock',
+  'yarn.lock',
+])
+
 /**
  * Apply override entries to a base options object.
  * @param {string} relativePath - Relative file path used for matching.
@@ -215,8 +268,13 @@ async function formatViaOxfmt(filename, sourceText, options = {}) {
    * Inline overrides separated from root options to preserve merge order.
    * @type {OxfmtOptions}
    */
-  const { overrides: ruleOverrides, ...inlineOptionsWithoutOverrides } =
-    inlineFormatOptions
+  const {
+    associations: ruleAssociations,
+    overrides: ruleOverrides,
+    ...inlineOptionsWithoutOverrides
+  } = inlineFormatOptions
+  let associations = ruleAssociations
+  let associationBaseDir = inlineBaseDir
   /**
    * Effective formatter options with paths resolved against their source.
    * @type {import('oxfmt').FormatConfig}
@@ -235,8 +293,16 @@ async function formatViaOxfmt(filename, sourceText, options = {}) {
       filepath: filename,
       useCache,
     })
-    const { overrides: configOverrides, ...loadedConfig } = loaded.config
+    const {
+      associations: configAssociations,
+      overrides: configOverrides,
+      ...loadedConfig
+    } = loaded.config
     overrideBaseDir = loaded.dirname ?? overrideBaseDir
+    if (ruleAssociations === undefined) {
+      associations = configAssociations
+      associationBaseDir = overrideBaseDir
+    }
 
     finalOptions = {
       ...resolveTailwindPaths(loadedConfig, overrideBaseDir),
@@ -258,7 +324,27 @@ async function formatViaOxfmt(filename, sourceText, options = {}) {
     inlineBaseDir,
   )
 
-  return format(filename, sourceText, finalOptions)
+  const formatFilename = resolveAssociationFilename(
+    filename,
+    associations,
+    associationBaseDir,
+  )
+  if (
+    formatFilename !== filename &&
+    ASSOCIATION_EXCLUDED_FILENAMES.has(basename(filename))
+  ) {
+    return {
+      code: sourceText,
+      ignored: true,
+    }
+  }
+  const result = await format(formatFilename, sourceText, finalOptions)
+  if (formatFilename !== filename) {
+    for (const error of result.errors) {
+      error.message = error.message.replaceAll(formatFilename, () => filename)
+    }
+  }
+  return result
 }
 
 /**
@@ -354,6 +440,52 @@ function isStringArray(value) {
   return Array.isArray(value) && value.every(item => typeof item === 'string')
 }
 
+/**
+ * Resolve the last matching association, validating entries even if unmatched.
+ * @param {string} filename - Original file path.
+ * @param {OxfmtOptions['associations']} associations - Ordered associations.
+ * @param {string} baseDir - Directory that owns the association patterns.
+ * @returns {string} Filename used only for selecting the formatter.
+ */
+function resolveAssociationFilename(filename, associations, baseDir) {
+  if (associations === undefined) {
+    return filename
+  }
+  if (!Array.isArray(associations)) {
+    throw new TypeError('oxfmt associations must be an array.')
+  }
+
+  const relativePath = getRelativePath(baseDir, filename)
+  let formatFilename = filename
+  for (const association of associations) {
+    if (
+      !association ||
+      !isStringArray(association.files) ||
+      (association.excludeFiles !== undefined &&
+        !isStringArray(association.excludeFiles)) ||
+      !Object.hasOwn(LANGUAGE_SUFFIXES, association.language)
+    ) {
+      throw new TypeError(
+        'Invalid oxfmt association: expected files, optional excludeFiles, and a supported language.',
+      )
+    }
+
+    const matches = getCachedOverrideMatcher(association.files)(relativePath)
+    const excluded = association.excludeFiles
+      ? getCachedOverrideMatcher(association.excludeFiles)(relativePath)
+      : false
+    if (matches && !excluded) {
+      // Use a neutral basename to avoid package.json sorting and .component.html
+      // detection overriding the explicitly selected language.
+      formatFilename = join(
+        dirname(filename),
+        `__oxfmt__.${LANGUAGE_SUFFIXES[association.language]}`,
+      )
+    }
+  }
+  return formatFilename
+}
+
 /**
  * Resolve Tailwind paths before merging options from different sources.
  * @param {import('oxfmt').FormatConfig} options - Format options to normalize.
@@ -378,7 +510,10 @@ function resolveTailwindPaths(options, baseDir) {
     resolved.stylesheet = resolve(baseDir, resolved.stylesheet)
   }
 
-  return { ...options, sortTailwindcss: resolved }
+  return {
+    ...options,
+    sortTailwindcss: resolved,
+  }
 }
 
 /**