@soybeanjs/oxc-config 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SoybeanJS Team
+
+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.en.md

@@ -0,0 +1,155 @@
+# @soybeanjs/oxc-config
+
+[![npm version](https://img.shields.io/npm/v/@soybeanjs/oxc-config)](https://www.npmjs.com/package/@soybeanjs/oxc-config)
+[![license](https://img.shields.io/github/license/soybeanjs/oxc-config)](https://github.com/soybeanjs/oxc-config/blob/main/LICENSE)
+
+Shared [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and [oxfmt](https://oxc.rs/docs/guide/usage/formatter.html) configuration for SoybeanJS projects.
+
+> [中文](./README.md) | English
+
+## Features
+
+- 🚀 **oxfmt formatter config** — Unified code style with fine-grained import sorting groups
+- 🔍 **oxlint linter config** — Integrated with ESLint / TypeScript / Unicorn / Vue plugins
+- 📦 **Import sorting** — Auto-group and sort imports by dependency layer
+- 🎯 **type-before-value rule** — Custom oxlint JS plugin ensuring `import type` comes after `import` for the same module
+
+## Installation
+
+```bash
+pnpm add -D @soybeanjs/oxc-config oxfmt oxlint
+```
+
+## Usage
+
+### oxfmt
+
+Create `oxfmt.config.ts` at project root:
+
+```ts
+import { fmt } from "@soybeanjs/oxc-config";
+
+export default fmt;
+```
+
+You can also extend it:
+
+```ts
+import { fmt } from "@soybeanjs/oxc-config";
+
+export default {
+  ...fmt,
+  printWidth: 100 // Override defaults
+};
+```
+
+#### Import Sort Groups
+
+Imports are automatically grouped and sorted by dependency layer:
+
+| Order | Group                                      | Description                                                                                        |
+| ----- | ------------------------------------------ | -------------------------------------------------------------------------------------------------- |
+| 1     | `builtin`                                  | Node.js built-in modules (`node:fs`, `node:path`, etc.)                                            |
+| 2     | `external-*`                               | External deps by layer in `order.json` (build-tools → test → framework → state → UI → CSS → utils) |
+| 3     | `external`                                 | Other unclassified external deps                                                                   |
+| 4     | `side_effect` / `side_effect_style`        | Side-effect and style side-effect imports                                                          |
+| 5     | `internal-*`                               | Project aliases (`@/`) by layer (config → infra → data → state → logic → views)                    |
+| 6     | `internal`                                 | Other unclassified internal imports                                                                |
+| 7     | `subpath` / `parent` / `sibling` / `index` | Relative path imports                                                                              |
+| 8     | `style`                                    | Stylesheet imports                                                                                 |
+| 9     | `unknown`                                  | Unknown import types                                                                               |
+
+External dependency sort order (`order.json`):
+
+```
+Build tools (vite, webpack, esbuild, tsdown...)
+  → Testing (vitest, playwright, cypress...)
+  → Frameworks (vue, nuxt, react, next...)
+  → State management (pinia, zustand, jotai...)
+  → UI libraries (element-plus, ant-design-vue, naive-ui...)
+  → CSS engines (tailwindcss, unocss, postcss...)
+  → Utilities (axios, date-fns, es-toolkit, @tanstack/**...)
+```
+
+Internal alias sort order (`order.json`):
+
+```
+Config (config, setting, constants...)
+  → Shared/Utils (shared, utils, lib...)
+  → Plugins/Directives (plugins, directives...)
+  → Middleware (middleware...)
+  → Data layer (api, service...)
+  → i18n (i18n, locales...)
+  → State (store, context...)
+  → Composables/Hooks (composables, hooks...)
+  → Router (router...)
+  → Feature modules (modules...)
+  → Views (components...)
+  → Styles/Assets (styles, assets...)
+```
+
+> See the full ordering in `node_modules/@soybeanjs/oxc-config/dist/order.json`, or customize by editing `src/order.json` in the source.
+
+### oxlint
+
+Create `oxlint.config.ts` at project root:
+
+```ts
+import { lint } from "@soybeanjs/oxc-config";
+
+export default lint;
+```
+
+#### Enabled Plugins
+
+- **eslint** — ESLint-compatible rules
+- **typescript** — TypeScript-specific rules
+- **unicorn** — Best practice rules
+- **oxc** — OXC-specific rules
+- **import** — Import/Export rules
+- **vue** — Vue SFC rules
+
+#### Custom Rule: import-type-order
+
+A custom oxlint JS plugin that ensures `import type` always comes after `import` for the same module:
+
+```ts
+// ✅ Correct
+import { ref } from "vue";
+import type { Ref } from "vue";
+
+// ❌ Incorrect
+import type { Ref } from "vue";
+import { ref } from "vue";
+```
+
+The exported `lint` config already includes this plugin and rule. To override or extend:
+
+```ts
+import { lint } from "@soybeanjs/oxc-config";
+
+export default {
+  ...lint,
+  jsPlugins: ["@soybeanjs/oxc-config/import-type-order"],
+  rules: {
+    "import-type-order/type-after-value": "warn"
+  }
+};
+```
+
+## Scripts
+
+Add to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "lint": "oxlint --fix",
+    "fmt": "oxfmt"
+  }
+}
+```
+
+## License
+
+[MIT](./LICENSE)

package/README.md

@@ -0,0 +1,157 @@
+# @soybeanjs/oxc-config
+
+[![npm version](https://img.shields.io/npm/v/@soybeanjs/oxc-config)](https://www.npmjs.com/package/@soybeanjs/oxc-config)
+[![license](https://img.shields.io/github/license/soybeanjs/oxc-config)](https://github.com/soybeanjs/oxc-config/blob/main/LICENSE)
+
+SoybeanJS 的共享 [oxlint](https://oxc.rs/docs/guide/usage/linter.html) 和 [oxfmt](https://oxc.rs/docs/guide/usage/formatter.html) 配置。
+
+> 中文 | [English](./README.en.md)
+
+## 特性
+
+- 🚀 **oxfmt 格式化配置** — 统一代码风格，包含精细的 import 排序分组
+- 🔍 **oxlint 代码检查** — 集成 ESLint / TypeScript / Unicorn / Vue 等插件
+- 📦 **Import 排序** — 按依赖层级自动分组排序 external 和 internal import
+- 🎯 **type-before-value 规则** — 自定义 oxlint JS 插件，确保同模块 `import type` 在 `import` 之后
+
+## 安装
+
+```bash
+pnpm add -D @soybeanjs/oxc-config oxfmt oxlint
+```
+
+## 使用
+
+### oxfmt 配置
+
+在项目根目录创建 `oxfmt.config.ts`：
+
+```ts
+import { fmt } from "@soybeanjs/oxc-config";
+
+export default fmt;
+```
+
+也可以在此基础上扩展：
+
+```ts
+import { fmt } from "@soybeanjs/oxc-config";
+
+export default {
+  ...fmt,
+  printWidth: 100 // 覆盖默认配置
+};
+```
+
+#### Import 排序分组
+
+本配置将 import 按依赖层级自动分组排序：
+
+| 顺序 | 分组                                       | 说明                                                                                            |
+| ---- | ------------------------------------------ | ----------------------------------------------------------------------------------------------- |
+| 1    | `builtin`                                  | Node.js 内置模块 (`node:fs`, `node:path` 等)                                                    |
+| 2    | `external-*`                               | 外部依赖，按 `order.json` 中的层级排列（构建工具 → 测试 → 框架 → 状态管理 → UI → CSS → 工具库） |
+| 3    | `external`                                 | 其他未分类的外部依赖                                                                            |
+| 4    | `side_effect` / `side_effect_style`        | 副作用导入和样式副作用导入                                                                      |
+| 5    | `internal-*`                               | 项目内部别名（`@/`），按依赖层级排列（配置 → 基础设施 → 数据层 → 状态 → 逻辑 → 视图）           |
+| 6    | `internal`                                 | 其他未分类的内部导入                                                                            |
+| 7    | `subpath` / `parent` / `sibling` / `index` | 相对路径导入                                                                                    |
+| 8    | `style`                                    | 样式文件导入                                                                                    |
+| 9    | `unknown`                                  | 未知类型导入                                                                                    |
+
+External 依赖排序层级（`order.json`）：
+
+```
+构建工具 (vite, webpack, esbuild, tsdown...)
+  → 测试 (vitest, playwright, cypress...)
+  → 框架 (vue, nuxt, react, next...)
+  → 状态管理 (pinia, zustand, jotai...)
+  → UI 组件库 (element-plus, ant-design-vue, naive-ui...)
+  → CSS 引擎 (tailwindcss, unocss, postcss...)
+  → 工具库 (axios, date-fns, es-toolkit, @tanstack/**...)
+```
+
+Internal 别名排序层级（`order.json`）：
+
+```
+配置 (config, setting, constants...)
+  → 共享/工具 (shared, utils, lib...)
+  → 插件/指令 (plugins, directives...)
+  → 中间件 (middleware...)
+  → 数据层 (api, service...)
+  → 国际化 (i18n, locales...)
+  → 状态 (store, context...)
+  → 逻辑复用 (composables, hooks...)
+  → 路由 (router...)
+  → 功能模块 (modules...)
+  → 视图 (components...)
+  → 样式/资源 (styles, assets...)
+```
+
+> 你可以在 `node_modules/@soybeanjs/oxc-config/dist/order.json` 中查看完整排序，或直接修改源码中的 `src/order.json` 来自定义。
+
+### oxlint 配置
+
+在项目根目录创建 `oxlint.config.ts`：
+
+```ts
+import { lint } from "@soybeanjs/oxc-config";
+
+export default lint;
+```
+
+#### 启用的插件
+
+- **eslint** — ESLint 兼容规则
+- **typescript** — TypeScript 专用规则
+- **unicorn** — 最佳实践规则
+- **oxc** — OXC 特有规则
+- **import** — Import/Export 规则
+- **vue** — Vue SFC 规则
+
+#### 自定义规则：import-type-order
+
+本配置附带一个 oxlint JS 插件，确保同一模块的 `import type` 始终在 `import` 之后：
+
+```ts
+// ✅ 正确
+import { ref } from "vue";
+import type { Ref } from "vue";
+
+// ❌ 错误
+import type { Ref } from "vue";
+import { ref } from "vue";
+```
+
+在 `oxlint.config.ts` 中启用：
+
+(导出的lint默认已经包含了插件和规则，这里仅展示如何覆盖或添加规则)
+
+```ts
+import { lint } from "@soybeanjs/oxc-config";
+
+export default {
+  ...lint,
+  jsPlugins: ["@soybeanjs/oxc-config/import-type-order"],
+  rules: {
+    "import-type-order/type-after-value": "warn"
+  }
+};
+```
+
+## 脚本
+
+在 `package.json` 中添加：
+
+```json
+{
+  "scripts": {
+    "lint": "oxlint --fix",
+    "fmt": "oxfmt"
+  }
+}
+```
+
+## 许可证
+
+[MIT](./LICENSE)

package/dist/import-type-order.js

@@ -0,0 +1,112 @@
+//#region src/import-type-order.js
+/**
+* oxlint JS plugin: import-type-order
+*
+* 确保同一模块的 `import type` 始终在 `import` (value import) 之后。
+* 与 oxfmt 的 sortImports 配合使用：oxfmt 负责分组排序，此插件负责同模块 value-before-type。
+*
+* 基于 eslint-plugin-simple-import-sort 的核心思路实现。
+*/
+/**
+* 判断 import 是否为 type-only import（`import type { X } from '...'`）
+* 也兼容 `import typeof`（Flow 语法）。
+*/
+function isTypeImport(node) {
+	return node.importKind === "type" || node.importKind === "typeof";
+}
+/**
+* 获取 import 声明前附着的注释的起始位置。
+* 如果没有前导注释，返回节点自身的起始位置。
+*/
+function getStartWithComments(node, sourceCode) {
+	const comments = sourceCode.getCommentsBefore(node);
+	if (comments.length > 0) return comments[0].range[0];
+	return node.range[0];
+}
+const plugin = {
+	meta: { name: "import-type-order" },
+	rules: { "type-after-value": {
+		meta: {
+			type: "layout",
+			fixable: "code",
+			docs: {
+				description: "Ensure value imports come before type imports for the same module source.",
+				url: "https://github.com/soybeanjs/oxfmt-import-order"
+			},
+			messages: { typeBeforeValue: "Type import from \"{{source}}\" must be placed after its value import." },
+			schema: []
+		},
+		create(context) {
+			const sourceCode = context.sourceCode;
+			return { "Program:exit"() {
+				const body = sourceCode.ast.body;
+				const allImports = [];
+				for (let i = 0; i < body.length; i++) if (body[i].type === "ImportDeclaration") allImports.push({
+					node: body[i],
+					bodyIndex: i
+				});
+				if (allImports.length < 2) return;
+				const groups = [];
+				let currentGroup = [allImports[0]];
+				for (let i = 1; i < allImports.length; i++) {
+					const prev = allImports[i - 1];
+					const curr = allImports[i];
+					const linesBetween = curr.node.loc.start.line - prev.node.loc.end.line;
+					if (prev.node.source.value === curr.node.source.value && linesBetween <= 1) currentGroup.push(curr);
+					else {
+						groups.push(currentGroup);
+						currentGroup = [curr];
+					}
+				}
+				groups.push(currentGroup);
+				for (const group of groups) {
+					if (group.length < 2) continue;
+					if (!group.some((item, i) => {
+						if (!isTypeImport(item.node)) return false;
+						for (let j = i + 1; j < group.length; j++) if (!isTypeImport(group[j].node)) return true;
+						return false;
+					})) continue;
+					const sorted = [...group].sort((a, b) => {
+						const aIsType = isTypeImport(a.node);
+						if (aIsType === isTypeImport(b.node)) return 0;
+						return aIsType ? 1 : -1;
+					});
+					const firstNode = group[0].node;
+					const lastNode = group[group.length - 1].node;
+					const source = firstNode.source.value;
+					context.report({
+						node: firstNode,
+						messageId: "typeBeforeValue",
+						data: { source },
+						fix(fixer) {
+							const parts = [];
+							for (let i = 0; i < sorted.length; i++) {
+								const item = sorted[i];
+								const prevItem = i > 0 ? sorted[i - 1] : null;
+								const start = getStartWithComments(item.node, sourceCode);
+								const text = sourceCode.text.slice(start, item.node.range[1]);
+								if (i > 0) {
+									const prevOriginalIndex = group.findIndex((g) => g === prevItem);
+									const currOriginalIndex = group.findIndex((g) => g === item);
+									if (Math.abs(currOriginalIndex - prevOriginalIndex) === 1) {
+										const earlier = group[Math.min(prevOriginalIndex, currOriginalIndex)];
+										const later = group[Math.max(prevOriginalIndex, currOriginalIndex)];
+										const sep = sourceCode.text.slice(earlier.node.range[1], getStartWithComments(later.node, sourceCode));
+										parts.push(sep);
+									} else parts.push("\n");
+								}
+								parts.push(text);
+							}
+							const rangeStart = getStartWithComments(firstNode, sourceCode);
+							const rangeEnd = lastNode.range[1];
+							return fixer.replaceTextRange([rangeStart, rangeEnd], parts.join(""));
+						}
+					});
+				}
+			} };
+		}
+	} }
+};
+
+//#endregion
+export { plugin as default };

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { OxfmtConfig } from "oxfmt";
+import { OxlintConfig } from "oxlint";
+
+//#region src/oxfmt.d.ts
+declare const fmt: OxfmtConfig;
+//#endregion
+//#region src/oxlint.d.ts
+declare const lint: OxlintConfig;
+//#endregion
+export { fmt, lint };

package/dist/index.js

@@ -0,0 +1,187 @@
+//#region src/order.json
+var external = [
+	"vite",
+	"@vitejs/**",
+	"vite-plugin-*",
+	"tsdown",
+	"unplugin-*",
+	"vitest",
+	"@vitest/**",
+	"playwright",
+	"cypress",
+	"vue",
+	"@vue/**",
+	"vue-router",
+	"@vueuse/**",
+	"nuxt",
+	"@nuxt/**",
+	"react",
+	"react-dom",
+	"@react/**",
+	"next",
+	"@next/**",
+	"pinia",
+	"pinia-colada",
+	"zustand",
+	"jotai",
+	"@soybeanjs/**",
+	"nuxt-ui",
+	"element-plus",
+	"ant-design-vue",
+	"antd-next",
+	"naive-ui",
+	"@arco-design/**",
+	"@iconify/**",
+	"tailwindcss",
+	"@tailwindcss/**",
+	"unocss",
+	"@unocss/**",
+	"postcss",
+	"@postcss/**",
+	"axios",
+	"date-fns",
+	"dayjs",
+	"es-toolkit",
+	"defu",
+	"ohash",
+	"@tanstack/**"
+];
+var internal = [
+	"@/config",
+	"@/config/**",
+	"@/configs",
+	"@/configs/**",
+	"@/constant",
+	"@/constant/**",
+	"@/constants",
+	"@/constants/**",
+	"@/setting",
+	"@/setting/**",
+	"@/settings",
+	"@/settings/**",
+	"@/shared",
+	"@/shared/**",
+	"@/utils",
+	"@/utils/**",
+	"@/lib",
+	"@/lib/**",
+	"@/plugin",
+	"@/plugin/**",
+	"@/plugins",
+	"@/plugins/**",
+	"@/directives",
+	"@/directives/**",
+	"@/middleware",
+	"@/middleware/**",
+	"@/api",
+	"@/api/**",
+	"@/service",
+	"@/service/**",
+	"@/services",
+	"@/services/**",
+	"@/i18n",
+	"@/i18n/**",
+	"@/locales",
+	"@/locales/**",
+	"@/store",
+	"@/store/**",
+	"@/context",
+	"@/context/**",
+	"@/composables",
+	"@/composables/**",
+	"@/hooks",
+	"@/hooks/**",
+	"@/router",
+	"@/modules",
+	"@/modules/**",
+	"@/components",
+	"@/styles",
+	"@/assets",
+	"@/assets/**",
+	"@/**",
+	"@/types",
+	"@/types/**"
+];
+
+//#endregion
+//#region src/oxfmt.ts
+const customGroups = [];
+const externalGroupNames = [];
+const internalGroupNames = [];
+external.forEach((item, index) => {
+	const groupName = `external-${index}`;
+	externalGroupNames.push(groupName);
+	customGroups.push({
+		groupName,
+		elementNamePattern: [item],
+		selector: "external"
+	});
+});
+internal.forEach((item, index) => {
+	const groupName = `internal-${index}`;
+	internalGroupNames.push(groupName);
+	customGroups.push({
+		groupName,
+		elementNamePattern: [item],
+		selector: "internal"
+	});
+});
+const fmt = {
+	printWidth: 120,
+	singleQuote: true,
+	trailingComma: "none",
+	arrowParens: "avoid",
+	htmlWhitespaceSensitivity: "ignore",
+	experimentalSortPackageJson: { sortScripts: true },
+	sortImports: {
+		newlinesBetween: false,
+		customGroups,
+		groups: [
+			"builtin",
+			...externalGroupNames,
+			"external",
+			"side_effect",
+			"side_effect_style",
+			...internalGroupNames,
+			"internal",
+			"subpath",
+			"parent",
+			"sibling",
+			"index",
+			"style",
+			"unknown"
+		]
+	}
+};
+
+//#endregion
+//#region src/oxlint.ts
+const lint = {
+	categories: {
+		correctness: "error",
+		suspicious: "error"
+	},
+	plugins: [
+		"eslint",
+		"typescript",
+		"unicorn",
+		"oxc",
+		"import",
+		"vue"
+	],
+	jsPlugins: ["@soybeanjs/oxc-config/import-type-order"],
+	rules: {
+		"import/no-unassigned-import": "off",
+		"import-type-order/type-after-value": "warn",
+		"no-unused-vars": "off",
+		"unicorn/consistent-function-scoping": "off",
+		"unicorn/no-array-reverse": "off",
+		"unicorn/no-array-sort": "off",
+		"unicorn/no-empty-file": "off",
+		"unicorn/require-module-specifiers": "off",
+		"vue/prefer-import-from-vue": "off"
+	}
+};
+
+//#endregion
+export { fmt, lint };

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@soybeanjs/oxc-config",
+  "version": "0.0.1",
+  "description": "SoybeanJS's oxlint and oxfmt config",
+  "keywords": [
+    "eslint",
+    "oxfmt",
+    "oxlint",
+    "prettier",
+    "soybeanjs"
+  ],
+  "homepage": "https://github.com/soybeanjs/oxc-config",
+  "bugs": {
+    "url": "https://github.com/soybeanjs/oxc-config/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Soybean",
+    "email": "soybeanjs@outlook.com",
+    "url": "https://github.com/soybeanjs"
+  },
+  "repository": {
+    "url": "https://github.com/soybeanjs/oxc-config.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./import-type-order": {
+      "import": "./dist/import-type-order.js",
+      "require": "./dist/import-type-order.js"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@soybeanjs/cli": "^1.7.2",
+    "@soybeanjs/oxc-config": "link:dist",
+    "@types/node": "^25.9.0",
+    "lint-staged": "^17.0.5",
+    "oxfmt": "^0.51.0",
+    "oxlint": "^1.66.0",
+    "simple-git-hooks": "^2.13.1",
+    "tsdown": "^0.22.0",
+    "tsx": "^4.22.3",
+    "typescript": "^6.0.3"
+  },
+  "simple-git-hooks": {
+    "commit-msg": "pnpm soy git-commit-verify",
+    "pre-commit": "pnpm typecheck && pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "oxlint . --fix && oxfmt"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "commit": "soy git-commit",
+    "lint": "oxlint --fix",
+    "fmt": "oxfmt",
+    "publish-pkg": "pnpm publish --access public",
+    "release": "soy release",
+    "typecheck": "tsc --noEmit --skipLibCheck",
+    "upkg": "soy ncu"
+  }
+}