@ilyasemenov/oxc-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ilya Semenov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,146 @@
+# @ilyasemenov/oxc-config
+
+Reusable oxlint, oxfmt, and ESLint configurations for projects I develop or oversee.
+
+Code is linted with oxlint and formatted with oxfmt.
+For Vue, ESLint additionally lints and formats templates, which oxlint cannot do.
+Both HTML and Pug templates are supported.
+
+## Setup
+
+Install:
+
+```sh
+npm install -D @ilyasemenov/oxc-config oxlint oxfmt
+```
+
+Create `oxlint.config.ts`:
+
+```ts
+import base from "@ilyasemenov/oxc-config/oxlint"
+import { defineConfig } from "oxlint"
+
+export default defineConfig({
+  extends: [base],
+})
+```
+
+Create `oxfmt.config.ts`:
+
+```ts
+export { default } from "@ilyasemenov/oxc-config/oxfmt"
+```
+
+To change formatting options, spread the config into your own: `defineConfig({ ...base, printWidth: 100 })`.
+
+### Vue
+
+For Vue projects, also install:
+
+```sh
+npm install -D eslint @antfu/eslint-config typescript-eslint typescript@~6.0.3
+```
+
+typescript-eslint doesn't support TypeScript 6.1+ yet.
+
+Create `eslint.config.js`:
+
+```js
+// @ts-check
+
+import config from "@ilyasemenov/oxc-config/eslint"
+
+export default await config()
+```
+
+It uses the Vue rules from [@antfu/eslint-config](https://github.com/antfu/eslint-config) with my preferences on top, and only checks `.vue` files.
+The oxlint config leaves unused variables in Vue files to ESLint, so use both.
+
+To add your own Vue rules:
+
+```js
+// @ts-check
+
+import config from "@ilyasemenov/oxc-config/eslint"
+import { defineConfig } from "eslint/config"
+
+export default defineConfig({
+  files: ["**/*.vue"],
+  extends: [await config()],
+  rules: {
+    "vue/require-v-for-key": "error",
+  },
+})
+```
+
+### Pug
+
+For Pug templates, install:
+
+```sh
+npm install -D eslint-plugin-vue-pug@flat
+```
+
+As of 29.09.2026, the `latest` tag still points to the older 0.x version.
+Then enable Pug in `eslint.config.js`:
+
+```js
+// @ts-check
+
+import config from "@ilyasemenov/oxc-config/eslint"
+
+export default await config({ vuePug: true })
+```
+
+The Pug preset disables some HTML checks for all Vue files, so enable it only in Pug projects.
+
+## A few preferences
+
+- No semicolons.
+- Imports grouped as side effects, builtins, external, internal, parent, sibling/index, and unknown, with a blank line between groups.
+- `bun:*` imports grouped with `node:*`; `~`, `#`, and `@/` treated as internal prefixes.
+- Package subpaths kept together: `#app/…` before `#app-server/…`.
+- Named imports sorted by their original name, ignoring aliases; type imports before value imports from the same module.
+- Vue component names in kebab-case, for both HTML and Pug.
+- No empty component blocks; `v-for` without a key and string concatenation are allowed.
+
+Imports are sorted by Perfectionist in oxlint: oxfmt's `sortImports` doesn't support this order, so keep it disabled.
+
+## Running it
+
+```sh
+npx oxlint --fix
+npx eslint --fix '**/*.vue'
+npx oxfmt
+```
+
+Leave out the ESLint command in projects without Vue.
+If you also use Stylelint, run it before oxfmt.
+
+If an import needs both moving and sorting inside `{ … }`, oxlint needs a second `--fix` run ([oxc#16118](https://github.com/oxc-project/oxc/issues/16118)).
+
+### Monorepos
+
+Running oxlint from the root also loads configs of nested packages.
+If they resolve different copies of the same JS plugin, oxlint fails with `Plugin name 'perfectionist' is already registered`.
+If the root config covers all packages, pass it explicitly to skip nested configs:
+
+```sh
+npx oxlint --config oxlint.config.ts --fix
+```
+
+Otherwise, run oxlint from each package directory.
+
+## Development
+
+```sh
+mise trust
+mise install
+bun install
+bun test
+bun run types
+bun run build
+bun run lint
+```
+
+Tests run directly against the source configs; there's no need to build first.

package/dist/eslint.d.mts

@@ -0,0 +1,14 @@
+import { Linter } from "eslint";
+//#region src/eslint.d.ts
+/** Options for the Vue SFC configuration. */
+export interface EslintOptions {
+  /**
+   * Enable Pug templates with the optional eslint-plugin-vue-pug peer.
+   * This disables incompatible HTML rules for all Vue files in the config.
+   * @default false
+   */
+  vuePug?: boolean;
+}
+/** Create Vue SFC rules complementing oxlint, with optional Pug support. */
+export default function createConfig({ vuePug }?: EslintOptions): Promise<Linter.Config[]>;
+//#endregion

package/dist/eslint.mjs

@@ -0,0 +1,52 @@
+import { vue } from "@antfu/eslint-config";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+//#region src/eslint.ts
+/** Create Vue SFC rules complementing oxlint, with optional Pug support. */
+async function createConfig({ vuePug = false } = {}) {
+	const configs = defineConfig(await vue({
+		typescript: true,
+		sfcBlocks: false,
+		stylistic: { braceStyle: "1tbs" }
+	}), {
+		name: "ilyasemenov/vue/oxlint",
+		plugins: { "@typescript-eslint": tseslint.plugin },
+		rules: { "@typescript-eslint/no-unused-vars": ["error", { ignoreRestSiblings: true }] }
+	}, {
+		name: "ilyasemenov/vue/rules",
+		rules: {
+			"vue/component-name-in-template-casing": [
+				"error",
+				"kebab-case",
+				{ registeredComponentsOnly: false }
+			],
+			"vue/no-empty-component-block": "error",
+			"vue/prefer-template": "off",
+			"vue/require-v-for-key": "off"
+		}
+	});
+	if (vuePug) {
+		const { default: pluginVuePug } = await import("eslint-plugin-vue-pug");
+		configs.push(...defineConfig(pluginVuePug.configs["flat/recommended"], {
+			name: "ilyasemenov/vue-pug/compat",
+			rules: { "vue/html-quotes": [
+				"error",
+				"double",
+				{ avoidEscape: true }
+			] }
+		}, {
+			name: "ilyasemenov/vue-pug/rules",
+			rules: { "vue-pug/component-name-in-template-casing": [
+				"error",
+				"kebab-case",
+				{ registeredComponentsOnly: false }
+			] }
+		}));
+	}
+	return defineConfig({
+		files: ["**/*.vue"],
+		extends: configs
+	});
+}
+//#endregion
+export { createConfig as default };

package/dist/oxfmt.d.mts

@@ -0,0 +1,7 @@
+//#region src/oxfmt.d.ts
+/** Shared formatting; import sorting belongs to oxlint. */
+declare const _default: {
+  semi: false;
+};
+//#endregion
+export { _default as default };

package/dist/oxfmt.mjs

@@ -0,0 +1,6 @@
+import { defineConfig } from "oxfmt";
+//#region src/oxfmt.ts
+/** Shared formatting; import sorting belongs to oxlint. */
+var oxfmt_default = defineConfig({ semi: false });
+//#endregion
+export { oxfmt_default as default };

package/dist/oxlint.d.mts

@@ -0,0 +1,31 @@
+//#region src/oxlint.d.ts
+/** Import sorting and Vue script rules, paired with the ESLint entry point. */
+declare const _default: {
+  jsPlugins: string[];
+  rules: {
+    "perfectionist/sort-imports": ["error", {
+      type: "custom";
+      alphabet: string;
+      environment: "bun";
+      groups: (string | string[])[];
+      internalPattern: string[];
+      newlinesBetween: number;
+      fallbackSort: {
+        type: string;
+      };
+    }];
+    "perfectionist/sort-named-imports": ["error", {
+      type: "custom";
+      alphabet: string;
+      ignoreAlias: boolean;
+    }];
+  };
+  overrides: {
+    files: string[];
+    rules: {
+      "no-unused-vars": "off";
+    };
+  }[];
+};
+//#endregion
+export { _default as default };

package/dist/oxlint.mjs

@@ -0,0 +1,48 @@
+import { Alphabet } from "eslint-plugin-perfectionist/alphabet";
+import { defineConfig } from "oxlint";
+//#region src/oxlint.ts
+const alphabet = Alphabet.generateRecommendedAlphabet().sortByNaturalSort().placeCharacterBefore({
+	characterBefore: "/",
+	characterAfter: "-"
+}).placeCharacterBefore({
+	characterBefore: ".",
+	characterAfter: "/"
+}).getCharacters().replaceAll(/[\uD800-\uDFFF]/g, "");
+/** Import sorting and Vue script rules, paired with the ESLint entry point. */
+var oxlint_default = defineConfig({
+	jsPlugins: [import.meta.resolve("eslint-plugin-perfectionist")],
+	rules: {
+		"perfectionist/sort-imports": ["error", {
+			type: "custom",
+			alphabet,
+			environment: "bun",
+			groups: [
+				"side-effect",
+				"builtin",
+				"external",
+				"internal",
+				"parent",
+				["sibling", "index"],
+				"unknown"
+			],
+			internalPattern: [
+				"^~",
+				"^#",
+				"^@/"
+			],
+			newlinesBetween: 1,
+			fallbackSort: { type: "type-import-first" }
+		}],
+		"perfectionist/sort-named-imports": ["error", {
+			type: "custom",
+			alphabet,
+			ignoreAlias: true
+		}]
+	},
+	overrides: [{
+		files: ["**/*.vue"],
+		rules: { "no-unused-vars": "off" }
+	}]
+});
+//#endregion
+export { oxlint_default as default };

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@ilyasemenov/oxc-config",
+  "version": "0.1.0",
+  "description": "Shared oxlint, oxfmt, and ESLint configurations for JavaScript, TypeScript, and Vue",
+  "homepage": "https://github.com/IlyaSemenov/oxc-config#readme",
+  "bugs": "https://github.com/IlyaSemenov/oxc-config/issues",
+  "license": "MIT",
+  "author": "Ilya Semenov",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/IlyaSemenov/oxc-config.git"
+  },
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    "./oxlint": {
+      "types": "./dist/oxlint.d.mts",
+      "import": "./dist/oxlint.mjs"
+    },
+    "./oxfmt": {
+      "types": "./dist/oxfmt.d.mts",
+      "import": "./dist/oxfmt.mjs"
+    },
+    "./eslint": {
+      "types": "./dist/eslint.d.mts",
+      "import": "./dist/eslint.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepare": "lefthook install",
+    "types": "tsc && tsc -p tests/tsconfig.json",
+    "test": "bun test",
+    "prepublishOnly": "bun run build",
+    "lint": "oxlint --fix && oxfmt",
+    "lint:check": "oxlint && oxfmt --check"
+  },
+  "dependencies": {
+    "eslint-plugin-perfectionist": "^5.12.1"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^9.5.1",
+    "@arethetypeswrong/core": "^0.18.5",
+    "@changesets/cli": "^3.0.3",
+    "@tsconfig/bun": "^1.0.11",
+    "@types/bun": "^1.4.2",
+    "eslint": "^10.11.0",
+    "eslint-plugin-vue-pug": "^1.0.0-alpha.6",
+    "oxfmt": "^0.71.0",
+    "oxlint": "^1.86.0",
+    "publint": "^0.3.24",
+    "tsdown": "^0.23.0",
+    "typescript": "~6.0.3",
+    "typescript-eslint": "^8.71.0"
+  },
+  "peerDependencies": {
+    "@antfu/eslint-config": "^9.5.1",
+    "eslint": "^10.11.0",
+    "eslint-plugin-vue-pug": "^1.0.0-alpha.6",
+    "oxfmt": "^0.71.0",
+    "oxlint": "^1.86.0",
+    "typescript-eslint": "^8.71.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
+    "@antfu/eslint-config": {
+      "optional": true
+    },
+    "eslint-plugin-vue-pug": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": "^20.19.0 || ^22.18.0 || >=24.0.0"
+  },
+  "packageManager": "bun@1.4.2"
+}