eslint-plugin-oxfmt 0.0.9 → 0.0.10

package/README.md

@@ -14,7 +14,7 @@
 - 🎯 **ESLint Integration** - Seamlessly integrates with ESLint v9+ flat config
 - 📦 **Zero Config** - Works out of the box with sensible defaults
 - 🎨 **Highly Configurable** - Support for all oxfmt formatting options
-- 🌐 **Multi-language Support** - JavaScript, TypeScript, JSX, TSX and more
+- 🌐 **Multi-language Support** - JavaScript, TypeScript, JSX, TSX and [more](https://oxc.rs/docs/guide/usage/formatter.html#supported-languages)
 
 ## Requirements
 
@@ -23,15 +23,15 @@
 
 ## Installation
 
-```bash
+```shell
 npm install -D oxfmt eslint-plugin-oxfmt
 ```
 
-```bash
+```shell
 yarn add -D oxfmt eslint-plugin-oxfmt
 ```
 
-```bash
+```shell
 pnpm add -D oxfmt eslint-plugin-oxfmt
 ```
 
@@ -69,6 +69,10 @@ export default [
       'oxfmt/oxfmt': [
         'error',
         {
+          // Plugin options
+          useConfig: false,
+          configPath: 'configs/.oxfmtrc.json',
+
           // Formatting options
           semi: false,
           singleQuote: true,
@@ -126,6 +130,15 @@ export default [
 
 All options are optional and default to sensible values.
 
+### Plugin Options
+
+| Option       | Type      | Default | Description                                                                                            |
+| ------------ | --------- | ------- | ------------------------------------------------------------------------------------------------------ |
+| `useConfig`  | `boolean` | `true`  | Load `.oxfmtrc` / config files via `load-oxfmt-config`. Set to `false` to rely only on inline options. |
+| `configPath` | `string`  | —       | Custom path to an oxfmt config file. Resolved from ESLint `cwd` when set. |
+
+> Note: `cwd` is taken from ESLint automatically; you usually do not need to set it manually.
+
 ### Basic Options
 
 | Option           | Type       | Default | Description                                        |
@@ -239,16 +252,16 @@ export default [
 
 You can pass the Tailwind plugin options to control which attributes/functions are sorted or keep duplicates:
 
-```js
+```json
 {
-  experimentalTailwindcss: {
-    attributes: ['class', 'className', ':class'],
-    config: './tailwind.config.js',
-    functions: ['clsx', 'cn'],
-    preserveDuplicates: false,
-    preserveWhitespace: false,
-    stylesheet: './src/app.css',
-  },
+  "experimentalTailwindcss": {
+    "attributes": ["class", "className", ":class"],
+    "config": "./tailwind.config.js",
+    "functions": ["clsx", "cn"],
+    "preserveDuplicates": false,
+    "preserveWhitespace": false,
+    "stylesheet": "./src/app.css"
+  }
 }
 ```
 
@@ -304,7 +317,7 @@ This plugin provides a single rule that formats your code using oxfmt.
 - Fixable: Yes (automatically applies formatting)
 - Type: Layout
 
-## Examples
+## Integration
 
 ### Format on Save in VS Code
 
@@ -324,15 +337,9 @@ Add this to your `.vscode/settings.json`:
 }
 ```
 
-### Run from Command Line
+## Suppported languages
 
-```bash
-# Check for formatting issues
-npx eslint .
-
-# Fix formatting issues
-npx eslint . --fix
-```
+- Check [Oxfmt - Supported languages](https://oxc.rs/docs/guide/usage/formatter.html#supported-languages)
 
 ## Why oxfmt?
 

package/dist/index.mjs

@@ -67,7 +67,7 @@ const configs = { recommended };
 //#endregion
 //#region package.json
 var name = "eslint-plugin-oxfmt";
-var version = "0.0.9";
+var version = "0.0.10";
 
 //#endregion
 //#region src/meta.ts
@@ -399,6 +399,10 @@ const oxfmt = {
 			type: "object",
 			properties: {
 				...sharedSchema.properties,
+				configPath: {
+					description: `Path to Oxfmt configuration file.\nIf you provide an absolute path, Oxfmt will use it directly.\n If not provided, Oxfmt will search for configuration files starting from the current working directory upwards.\n\n- (Default: undefined)`,
+					type: "string"
+				},
 				overrides: {
 					description: `File-specific overrides.\nWhen a file matches multiple overrides, the later override takes precedence (array order matters).\n\n- (Default: [])`,
 					type: "array",
@@ -425,6 +429,10 @@ const oxfmt = {
 							}
 						}
 					}
+				},
+				useConfig: {
+					description: `Whether to load Oxfmt configuration file.\n\n- (Default: true)`,
+					type: "boolean"
 				}
 			}
 		}]

package/dts/rule-options.d.ts

@@ -100,6 +100,8 @@ export type OxfmtOxfmt = []|[{
   
   vueIndentScriptAndStyle?: boolean
   
+  configPath?: string
+  
   overrides?: {
     
     excludeFiles?: string[]
@@ -195,4 +197,6 @@ export type OxfmtOxfmt = []|[{
       vueIndentScriptAndStyle?: boolean
     }
   }[]
+  
+  useConfig?: boolean
 }]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-oxfmt",
   "type": "module",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "An ESLint plugin for formatting code with oxfmt.",
   "keywords": [
     "eslint",
@@ -52,11 +52,10 @@
     "synckit": "^0.11.12"
   },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^5.9.0",
-    "@ntnyq/prettier-config": "^3.0.1",
+    "@ntnyq/eslint-config": "^6.0.0-beta.2",
     "@types/json-schema": "^7.0.15",
-    "@types/node": "^25.0.9",
-    "@typescript/native-preview": "^7.0.0-dev.20260119.1",
+    "@types/node": "^25.0.10",
+    "@typescript/native-preview": "^7.0.0-dev.20260120.1",
     "bumpp": "^10.4.0",
     "eslint": "^9.39.2",
     "eslint-parser-plain": "^0.1.1",
@@ -66,24 +65,25 @@
     "nano-staged": "^0.9.0",
     "npm-run-all2": "^8.0.4",
     "oxfmt": "^0.26.0",
-    "prettier": "^3.8.0",
     "show-invisibles": "^0.0.2",
     "tinyglobby": "^0.2.15",
-    "tsdown": "^0.20.0-beta.3",
+    "tsdown": "^0.20.0-beta.4",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.17"
+    "vitest": "^4.0.17",
+    "eslint-plugin-oxfmt": "0.0.10"
   },
   "engines": {
     "node": "^20.19.0 || >=22.12.0"
   },
   "nano-staged": {
-    "*.{js,ts,mjs,cjs,md,vue,yml,yaml,toml,json}": "eslint --fix",
-    "*.{css,scss,html}": "prettier -uw"
+    "*.{js,ts,mjs,cjs,md,vue,yml,yaml,toml,json}": "eslint --fix"
   },
   "scripts": {
     "build": "pnpm run update:rule-options && tsdown",
     "dev": "tsdown --watch",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check",
     "lint": "eslint",
     "release": "run-s release:check release:version",
     "release:check": "run-s lint typecheck test build",