eslint-plugin-oxfmt 0.0.0 → 0.0.1

package/README.md

@@ -5,7 +5,7 @@
 [![NPM DOWNLOADS](https://img.shields.io/npm/dy/eslint-plugin-oxfmt.svg)](https://www.npmjs.com/package/eslint-plugin-oxfmt)
 [![LICENSE](https://img.shields.io/github/license/ntnyq/eslint-plugin-oxfmt.svg)](https://github.com/ntnyq/eslint-plugin-oxfmt/blob/main/LICENSE)
 
-A starter template for node projects.
+An ESLint plugin that format code via oxfmt.
 
 ## Install
 
@@ -21,6 +21,33 @@ yarn add eslint-plugin-oxfmt
 pnpm add eslint-plugin-oxfmt
 ```
 
+## Usage
+
+```ts
+// eslint.config.mjs
+
+import pluginOxfmt from 'eslint-plugin-oxfmt'
+import { defineConfig } from 'eslint/config'
+
+export default defineConfig([
+  {
+    ...pluginOxfmt.configs.recommended,
+    files: ['**/*.{js,ts,mjs,cjs,jsx,tsx}'],
+    rules: {
+      'oxfmt/oxfmt': [
+        'error',
+        {
+          semi: false,
+          useTabs: true,
+          singleAttributePerLine: true,
+          trailingComma: 'all',
+        },
+      ],
+    },
+  },
+])
+```
+
 ## License
 
 [MIT](./LICENSE) License © 2025-PRESENT [ntnyq](https://github.com/ntnyq)

package/dist/index.d.mts

@@ -0,0 +1,39 @@
+import * as eslint0 from "eslint";
+import { Linter, Rule } from "eslint";
+
+//#region src/types.d.ts
+interface PluginOxfmt {
+  configs: {
+    recommended: Linter.Config<Linter.RulesRecord>;
+  };
+  meta: {
+    name: string;
+    version: string;
+  };
+  rules: {
+    oxfmt: Rule.RuleModule;
+  };
+}
+//#endregion
+//#region src/meta.d.ts
+declare const meta: {
+  name: string;
+  version: string;
+};
+//#endregion
+//#region src/rules/index.d.ts
+declare const rules: {
+  oxfmt: eslint0.Rule.RuleModule;
+};
+//#endregion
+//#region src/parser.d.ts
+declare const parserPlain: Linter.Parser;
+//#endregion
+//#region src/configs.d.ts
+declare const recommended: Linter.Config<Linter.RulesRecord>;
+declare const configs: PluginOxfmt['configs'];
+//#endregion
+//#region src/index.d.ts
+declare const plugin: PluginOxfmt;
+//#endregion
+export { configs, plugin as default, plugin, meta, parserPlain, recommended, rules };

package/dist/index.mjs

@@ -0,0 +1,357 @@
+import { join } from "node:path";
+import { createSyncFn } from "synckit";
+import { URL, fileURLToPath } from "node:url";
+import { DIFFERENCE, generateDifferences } from "generate-differences";
+
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __export = (all, symbols) => {
+	let target = {};
+	for (var name$2 in all) {
+		__defProp(target, name$2, {
+			get: all[name$2],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+
+//#endregion
+//#region node_modules/.pnpm/eslint-parser-plain@0.1.1/node_modules/eslint-parser-plain/dist/index.mjs
+var dist_exports = /* @__PURE__ */ __export({
+	meta: () => meta$1,
+	parseForESLint: () => parseForESLint
+});
+const name$1 = "eslint-parser-plain";
+const version$1 = "0.1.1";
+const parseForESLint = (code) => ({
+	ast: {
+		type: "Program",
+		loc: {
+			start: 0,
+			end: code.length
+		},
+		range: [0, code.length],
+		body: [],
+		comments: [],
+		tokens: []
+	},
+	services: { isPlain: true },
+	scopeManager: null,
+	visitorKeys: { Program: [] }
+});
+const meta$1 = {
+	name: name$1,
+	version: version$1
+};
+
+//#endregion
+//#region src/parser.ts
+const parserPlain = dist_exports;
+
+//#endregion
+//#region src/configs.ts
+const recommended = {
+	name: "oxfmt/recommended",
+	languageOptions: { parser: parserPlain },
+	plugins: { get oxfmt() {
+		return src_default;
+	} },
+	rules: { "oxfmt/oxfmt": "error" }
+};
+const configs = { recommended };
+
+//#endregion
+//#region package.json
+var name = "eslint-plugin-oxfmt";
+var version = "0.0.1";
+
+//#endregion
+//#region src/meta.ts
+const meta = {
+	name,
+	version
+};
+
+//#endregion
+//#region src/dir.ts
+const dirWorkers = fileURLToPath(new URL("../workers", import.meta.url));
+
+//#endregion
+//#region node_modules/.pnpm/show-invisibles@0.0.1/node_modules/show-invisibles/dist/index.mjs
+const DEFAULT_MAPPINGS = /* @__PURE__ */ new Map([
+	[" ", "·"],
+	["\n", "⏎"],
+	["\r", "␍"],
+	["	", "↹"]
+]);
+function showInvisibles(input, options = {}) {
+	const { mappings = DEFAULT_MAPPINGS } = options;
+	if (typeof input !== "string") throw new TypeError(`Expected input to type string, got ${typeof input}`);
+	return input.split("").map((c) => mappings.get(c) || c).join("");
+}
+
+//#endregion
+//#region src/reporter.ts
+/**
+* @copyright {@link https://github.com/antfu/eslint-formatting-reporter}
+*/
+const messages = {
+	[DIFFERENCE.DELETE]: "Delete `{{ deleteText }}`",
+	[DIFFERENCE.INSERT]: "Insert `{{ insertText }}`",
+	[DIFFERENCE.REPLACE]: "Replace `{{ deleteText }}` with `{{ insertText }}`"
+};
+function reportDifferences(context, source, formatted, offset = 0) {
+	if (source === formatted) return;
+	const differences = generateDifferences(source, formatted);
+	for (const difference of differences) _reportDifference(context, difference, offset);
+}
+function _reportDifference(context, difference, rangeOffset = 0) {
+	const { offset, operation } = difference;
+	let deleteText = "";
+	let insertText = "";
+	if ("deleteText" in difference && difference.deleteText) deleteText = difference.deleteText;
+	if ("insertText" in difference && difference.insertText) insertText = difference.insertText;
+	const range = [offset + rangeOffset, offset + rangeOffset + deleteText.length];
+	const [start, end] = range.map((index) => context.sourceCode.getLocFromIndex(index));
+	context.report({
+		loc: {
+			end,
+			start
+		},
+		messageId: operation,
+		data: {
+			deleteText: showInvisibles(deleteText),
+			insertText: showInvisibles(insertText)
+		},
+		fix: (fixer) => fixer.replaceTextRange(range, insertText)
+	});
+}
+
+//#endregion
+//#region src/rules/oxfmt.ts
+let formatViaOxfmt;
+const oxfmt = {
+	meta: {
+		defaultOptions: [],
+		fixable: "code",
+		messages,
+		type: "layout",
+		docs: {
+			description: "Format code via oxfmt",
+			recommended: true,
+			url: "https://github.com/ntnyq/eslint-plugin-oxfmt"
+		},
+		schema: [{
+			additionalProperties: false,
+			type: "object",
+			properties: {
+				arrowParens: {
+					description: `Include parentheses around a sole arrow function parameter. (Default: "always")`,
+					enum: ["always", "avoid"],
+					type: "string"
+				},
+				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"
+				},
+				bracketSpacing: {
+					description: `Print spaces between brackets in object literals. (Default: true)`,
+					type: "boolean"
+				},
+				embeddedLanguageFormatting: {
+					description: `Control whether formats quoted code embedded in the file. (Default: "auto")`,
+					enum: ["auto", "off"],
+					type: "string"
+				},
+				endOfLine: {
+					description: `Which end of line characters to apply. (Default: "lf")`,
+					enum: [
+						"lf",
+						"crlf",
+						"cr"
+					],
+					type: "string"
+				},
+				experimentalSortImports: {
+					additionalProperties: false,
+					description: `Experimental: Sort import statements. Disabled by default.`,
+					type: "object",
+					properties: {
+						groups: {
+							description: `Custom groups configuration for organizing imports.\nEach array element represents a group, and multiple group names in the same array are treated as one.\nAccepts both string and string[] as group elements.`,
+							type: "array",
+							items: {
+								type: "array",
+								items: { type: "string" }
+							}
+						},
+						ignoreCase: {
+							description: `Ignore case when sorting. (Default: true)`,
+							type: "boolean"
+						},
+						internalPattern: {
+							description: `Glob patterns to identify internal imports.`,
+							type: "array",
+							items: { type: "string" }
+						},
+						newlinesBetween: {
+							description: `Add newlines between import groups. (Default: true)`,
+							type: "boolean"
+						},
+						order: {
+							description: `Sort order. (Default: "asc")`,
+							enum: ["asc", "desc"],
+							type: "string"
+						},
+						partitionByComment: {
+							description: `Partition imports by comments. (Default: false)`,
+							type: "boolean"
+						},
+						partitionByNewline: {
+							description: `Partition imports by newlines. (Default: false)`,
+							type: "boolean"
+						},
+						sortSideEffects: {
+							description: `Sort side-effect imports. (Default: "false")`,
+							type: "boolean"
+						}
+					}
+				},
+				experimentalSortPackageJson: {
+					description: `Experimental: Sort package.json keys. (Default: true)`,
+					type: "boolean"
+				},
+				ignorePatterns: {
+					description: `Ignore files matching these glob patterns. Current working directory is used as the root.`,
+					type: "array",
+					items: { type: "string" }
+				},
+				jsxSingleQuote: {
+					description: `Use single quotes instead of double quotes in JSX. (Default: false)`,
+					type: "boolean"
+				},
+				objectWrap: {
+					description: `How to wrap object literals when they could fit on one line or span multiple lines. (Default: "preserve")\nNOTE: In addition to Prettier's "preserve" and "collapse", we also support "always".`,
+					enum: [
+						"preserve",
+						"collapse",
+						"always"
+					],
+					type: "string"
+				},
+				printWidth: {
+					description: `The line length that the printer will wrap on. (Default: 100)`,
+					type: "integer"
+				},
+				quoteProps: {
+					description: `Change when properties in objects are quoted. (Default: "as-needed")`,
+					enum: [
+						"as-needed",
+						"consistent",
+						"preserve"
+					],
+					type: "string"
+				},
+				semi: {
+					description: `Print semicolons at the ends of statements. (Default: true)`,
+					type: "boolean"
+				},
+				singleAttributePerLine: {
+					description: `Put each attribute on a new line in JSX. (Default: false)`,
+					type: "boolean"
+				},
+				singleQuote: {
+					description: `Use single quotes instead of double quotes. (Default: false)`,
+					type: "boolean"
+				},
+				tabWidth: {
+					description: `Number of spaces per indentation level. (Default: 2)`,
+					type: "integer"
+				},
+				trailingComma: {
+					description: `Print trailing commas wherever possible. (Default: "all")`,
+					enum: [
+						"all",
+						"es5",
+						"none"
+					],
+					type: "string"
+				},
+				useTabs: {
+					description: `Use tabs for indentation or spaces. (Default: false)`,
+					type: "boolean"
+				}
+			}
+		}]
+	},
+	create(context) {
+		if (!formatViaOxfmt) formatViaOxfmt = createSyncFn(join(dirWorkers, "oxfmt.mjs"));
+		return { Program() {
+			const sourceText = context.sourceCode.text;
+			try {
+				const formatResult = formatViaOxfmt(context.filename, sourceText, { ...context.options?.[0] });
+				if (formatResult.errors?.length) for (const error of formatResult.errors) {
+					const label = error.labels?.[0];
+					if (label) {
+						const start = context.sourceCode.getLocFromIndex(label.start);
+						const end = context.sourceCode.getLocFromIndex(label.end);
+						context.report({
+							loc: {
+								end,
+								start
+							},
+							message: error.message
+						});
+					} else context.report({
+						message: error.message,
+						loc: {
+							end: {
+								column: 0,
+								line: 1
+							},
+							start: {
+								column: 0,
+								line: 1
+							}
+						}
+					});
+				}
+				else reportDifferences(context, sourceText, formatResult.code);
+			} catch {
+				context.report({
+					message: `Failed to format file ${context.filename}`,
+					loc: {
+						end: {
+							column: 0,
+							line: 1
+						},
+						start: {
+							column: 0,
+							line: 1
+						}
+					}
+				});
+			}
+		} };
+	}
+};
+
+//#endregion
+//#region src/rules/index.ts
+const rules = { oxfmt };
+
+//#endregion
+//#region src/index.ts
+const plugin = {
+	configs,
+	meta,
+	rules
+};
+var src_default = plugin;
+
+//#endregion
+export { configs, src_default as default, meta, parserPlain, plugin, recommended, rules };

package/dts/rule-options.d.ts

@@ -0,0 +1,69 @@
+/* eslint-disable */
+/* prettier-ignore */
+import type { Linter } from 'eslint'
+
+export type RuleOptions = {
+  /**
+   * Format code via oxfmt
+   * @see https://github.com/ntnyq/eslint-plugin-oxfmt
+   */
+  'oxfmt/oxfmt'?: Linter.RuleEntry<OxfmtOxfmt>
+}
+
+/* ======= Declarations ======= */
+// ----- oxfmt/oxfmt -----
+export type OxfmtOxfmt = []|[{
+  
+  arrowParens?: ("always" | "avoid")
+  
+  bracketSameLine?: boolean
+  
+  bracketSpacing?: boolean
+  
+  embeddedLanguageFormatting?: ("auto" | "off")
+  
+  endOfLine?: ("lf" | "crlf" | "cr")
+  
+  experimentalSortImports?: {
+    
+    groups?: string[][]
+    
+    ignoreCase?: boolean
+    
+    internalPattern?: string[]
+    
+    newlinesBetween?: boolean
+    
+    order?: ("asc" | "desc")
+    
+    partitionByComment?: boolean
+    
+    partitionByNewline?: boolean
+    
+    sortSideEffects?: boolean
+  }
+  
+  experimentalSortPackageJson?: boolean
+  
+  ignorePatterns?: string[]
+  
+  jsxSingleQuote?: boolean
+  
+  objectWrap?: ("preserve" | "collapse" | "always")
+  
+  printWidth?: number
+  
+  quoteProps?: ("as-needed" | "consistent" | "preserve")
+  
+  semi?: boolean
+  
+  singleAttributePerLine?: boolean
+  
+  singleQuote?: boolean
+  
+  tabWidth?: number
+  
+  trailingComma?: ("all" | "es5" | "none")
+  
+  useTabs?: boolean
+}]

package/package.json

@@ -1,9 +1,16 @@
 {
   "name": "eslint-plugin-oxfmt",
   "type": "module",
-  "version": "0.0.0",
-  "description": "__TODO__",
-  "keywords": [],
+  "version": "0.0.1",
+  "description": "An ESLint plugin that format code via oxfmt.",
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "oxc",
+    "oxfmt",
+    "oxlint",
+    "prettier"
+  ],
   "license": "MIT",
   "author": {
     "name": "ntnyq",
@@ -17,45 +24,68 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./rule-options": {
+      "types": "./dts/rule-options.d.ts"
     }
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "files": [
-    "dist"
+    "dist",
+    "dts",
+    "workers"
   ],
   "publishConfig": {
     "access": "public"
   },
   "sideEffects": false,
+  "peerDependencies": {
+    "eslint": "^9.5.0"
+  },
+  "dependencies": {
+    "generate-differences": "^0.1.0",
+    "oxfmt": "^0.19.0",
+    "synckit": "^0.11.11"
+  },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^5.6.0",
+    "@ntnyq/eslint-config": "^5.8.0",
     "@ntnyq/prettier-config": "^3.0.1",
-    "@types/node": "^24.9.1",
-    "bumpp": "^10.3.1",
-    "eslint": "^9.38.0",
+    "@types/json-schema": "^7.0.15",
+    "@types/node": "^25.0.3",
+    "@typescript/native-preview": "7.0.0-dev.20251204.1",
+    "bumpp": "^10.3.2",
+    "eslint": "^9.39.2",
+    "eslint-parser-plain": "^0.1.1",
+    "eslint-typegen": "^2.3.0",
+    "eslint-vitest-rule-tester": "^3.0.1",
     "husky": "^9.1.7",
-    "nano-staged": "^0.8.0",
+    "json-schema": "^0.4.0",
+    "nano-staged": "^0.9.0",
     "npm-run-all2": "^8.0.4",
-    "prettier": "^3.6.2",
-    "tsdown": "^0.15.9",
+    "prettier": "^3.7.4",
+    "show-invisibles": "^0.0.1",
+    "tinyglobby": "^0.2.15",
+    "tsdown": "^0.18.1",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.16"
   },
   "nano-staged": {
     "*.{js,ts,mjs,cjs,md,vue,yml,yaml,toml,json}": "eslint --fix",
     "*.{css,scss,html}": "prettier -uw"
   },
   "scripts": {
-    "build": "tsdown",
+    "build": "pnpm run update:rule-options && tsdown",
     "dev": "tsdown --watch",
     "lint": "eslint",
     "release": "run-s release:check release:version",
-    "release:check": "run-s lint typecheck test",
+    "release:check": "run-s lint typecheck test build",
     "release:version": "bumpp",
     "test": "vitest",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsgo --noEmit",
+    "update:rule-options": "tsx scripts/udpateRuleOptions.ts"
   }
 }

package/workers/oxfmt.mjs

@@ -0,0 +1,28 @@
+// @ts-check
+
+import { format } from 'oxfmt'
+import { runAsWorker } from 'synckit'
+
+/**
+ * @import { FormatOptions } from 'oxfmt'
+ */
+
+runAsWorker(
+  async (
+    /**
+     * @type {string} filename
+     */
+    filename,
+    /**
+     * @type {string} source text
+     */
+    sourceText,
+    /**'
+     * @type {FormatOptions} format options
+     */
+    options,
+  ) => {
+    const formatResult = await format(filename, sourceText, options)
+    return formatResult
+  },
+)

package/dist/index.d.ts

@@ -1,5 +0,0 @@
-//#region src/index.d.ts
-declare const msg = "hello world";
-declare function greet(): string;
-//#endregion
-export { greet, msg };

package/dist/index.js

@@ -1,9 +0,0 @@
-//#region src/index.ts
-const msg = "hello world";
-function greet() {
-	console.log(msg);
-	return msg;
-}
-
-//#endregion
-export { greet, msg };