排序

Oxfmt 包含用于导入、Tailwind 类和 package.json 的排序功能。

• 排序导入
• 排序 Tailwind CSS 类
• 排序 package.json 字段

详见 配置文件参考。

排序导入

基于 eslint-plugin-perfectionist/sort-imports。

默认禁用。

配置示例

与 eslint-plugin-perfectionist/sort-imports 的默认顺序相同。

.oxfmtrc.json

{
  "sortImports": {
    "groups": [
      "type-import",
      ["value-builtin", "value-external"],
      "type-internal",
      "value-internal",
      ["type-parent", "type-sibling", "type-index"],
      ["value-parent", "value-sibling", "value-index"],
      "unknown"
    ]
  }
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

export default defineConfig({
  sortImports: {
    groups: [
      "type-import",
      ["value-builtin", "value-external"],
      "type-internal",
      "value-internal",
      ["type-parent", "type-sibling", "type-index"],
      ["value-parent", "value-sibling", "value-index"],
      "unknown",
    ],
  },
});

在顶层使用 "newlinesBetween": false 来禁用组之间的换行，然后在 groups 中使用 { "newlinesBetween": true } 在特定位置插入换行。

.oxfmtrc.json

{
  "sortImports": {
    "newlinesBetween": false,
    "groups": [
      ["value-builtin", "value-external"],
      ["value-internal", "value-parent", "value-sibling", "value-index"],
      { "newlinesBetween": true },
      "type-import",
      "unknown"
    ]
  }
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

export default defineConfig({
  sortImports: {
    newlinesBetween: false,
    groups: [
      ["value-builtin", "value-external"],
      ["value-internal", "value-parent", "value-sibling", "value-index"],
      { newlinesBetween: true },
      "type-import",
      "unknown",
    ],
  },
});

使用 customGroups 为特定导入定义自己的分组。每个自定义分组都有一个可在 groups 中引用的 groupName。elementNamePattern 接受 glob 模式来匹配导入源。

.oxfmtrc.json

{
  "sortImports": {
    "customGroups": [
      {
        "groupName": "react-libs",
        "elementNamePattern": ["react", "react-**"]
      }
    ],
    "groups": [
      "react-libs",
      ["value-builtin", "value-external"],
      "value-internal",
      ["value-parent", "value-sibling", "value-index"],
      "unknown"
    ]
  }
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

export default defineConfig({
  sortImports: {
    customGroups: [
      {
        groupName: "react-libs",
        elementNamePattern: ["react", "react-**"],
      },
    ],
    groups: [
      "react-libs",
      ["value-builtin", "value-external"],
      "value-internal",
      ["value-parent", "value-sibling", "value-index"],
      "unknown",
    ],
  },
});

排序 Tailwind CSS 类

排序 Tailwind 工具类。

基于 prettier-plugin-tailwindcss。

默认禁用。

配置示例

.oxfmtrc.json

{
  "sortTailwindcss": {
    "stylesheet": "./path/to/stylesheet.css",
    "functions": ["clsx", "cn"],
    "preserveWhitespace": true
  }
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

export default defineConfig({
  sortTailwindcss: {
    stylesheet: "./path/to/stylesheet.css",
    functions: ["clsx", "cn"],
    preserveWhitespace: true,
  },
});

不支持 attributes 和 functions 的正则表达式模式。

排序 package.json 字段

使用预设的顺序对 package.json 中的键进行排序。

详见 字段顺序。

默认启用。

配置示例

禁用：

.oxfmtrc.json

{
  "sortPackageJson": false
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

export default defineConfig({
  sortPackageJson: false,
});

要按字母顺序排序 scripts：

.oxfmtrc.json

{
  "sortPackageJson": {
    "sortScripts": true
  }
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

export default defineConfig({
  sortPackageJson: {
    sortScripts: true,
  },
});