Ordenação

Oxfmt inclui ordenação para imports, classes Tailwind e campos de package.json.

• Ordenar imports
• Ordenar classes Tailwind CSS
• Ordenar campos de package.json

Detalhes na referência do arquivo de config.

Sort imports

Baseado em eslint-plugin-perfectionist/sort-imports.

Desligado por padrão.

Exemplo de config

Mesma ordem do default do 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",
    ],
  },
});

Use "newlinesBetween": false no topo para desligar linhas em branco entre grupos; depois { "newlinesBetween": true } dentro de groups para forçar em um ponto.

.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 define grupos próprios. Cada um tem groupName referenciável em groups; elementNamePattern aceita globs para fontes de import.

.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",
    ],
  },
});

Sort Tailwind CSS classes

Ordena utilitários Tailwind.

Baseado em prettier-plugin-tailwindcss.

Desligado por padrão.

Exemplo de config

.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,
  },
});

Regex em attributes e functions não é suportado.

Sort package.json fields

Ordena chaves de package.json com ordem opinativa.

Detalhes em field ordering.

Ligado por padrão.

Exemplo de config

Desligar:

.oxfmtrc.json

{
  "sortPackageJson": false
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

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

Ordenar scripts alfabeticamente:

.oxfmtrc.json

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

oxfmt.config.ts

import { defineConfig } from "oxfmt";

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