Plugin Prettier

O prettier-plugin-intlayer organiza as chaves das suas traduções em uma ordem fixa a cada formatação do Prettier. Os diffs permanecem pequenos, conflitos de merge tornam-se raros e um locale ausente torna-se fácil de detectar.

// antes
t({ en: "Hello", ru: "Привет", fr: "Bonjour", "en-GB": "Hello", ar: "مرحبا" });

// depois
t({ en: "Hello", ar: "مرحبا", "en-GB": "Hello", fr: "Bonjour", ru: "Привет" });

Instalação

npm install --save-dev prettier prettier-plugin-intlayer

Requer o Prettier 3 ou superior.

Se o seu projeto já utiliza o Prettier, intlayer init prettier instala o plugin e o adiciona à sua configuração automaticamente.

Uso

Adicione o plugin à sua configuração do Prettier:

{
  "plugins": ["prettier-plugin-intlayer"]
}

Para aplicá-lo apenas às suas declarações de conteúdo, utilize um override:

{
  "overrides": [
    {
      "files": "*.content.{ts,tsx,js,jsx,mjs,cjs,json}",
      "options": {
        "plugins": ["prettier-plugin-intlayer"],
        "intlayerSortContentKeys": true
      }
    }
  ]
}

O que é ordenado

t(): locales

Os locales fixados aparecem primeiro (en por padrão). Os demais locales seguem em ordem alfabética.

t({
  en: "Invitation not found",
  ar: "الدعوة غير موجودة",
  de: "Einladung nicht gefunden",
  "en-GB": "Invitation not found",
  fr: "Invitation introuvable",
  "he-IL": "ההזמנה לא נמצאה",
});

plural(): ordem CLDR

As categorias vão da menor quantidade até a alternativa (fallback): zero, one, two, few, many, other.

plural({
  one: "{{count}} вакансия",
  few: "{{count}} вакансии",
  many: "{{count}} вакансий",
  other: "{{count}} вакансий",
});

enu(): limites ascendentes

As condições são ordenadas pelo seu número e depois pelo operador (<1, <=1, 1, >=1, >1). fallback fica por último.

enu({
  "<-1": "Menos de menos um carro",
  "0": "Nenhum carro",
  "2": "Dois carros",
  ">=3": "Muitos carros",
  fallback: "Alguns carros",
});

Em tempo de execução, a primeira condição correspondente prevalece. O plugin aplica a nova ordem somente quando cada quantidade continuar resultando no mesmo conteúdo. Quando a ordem determina o resultado, o objeto é mantido exatamente como escrito. Por exemplo, em { '<1': …, '<=-2.3': … } a chave '<1' captura qualquer número negativo.

select(): alfabético

Os casos são ordenados alfabeticamente e fallback fica por último.

select({
  draft: "Esta publicação é um rascunho",
  published: "Esta publicação está publicada",
  scheduled: "Esta publicação está agendada",
  fallback: "Status desconhecido",
});

Sem uma chave fallback ou other, o último caso é usado como fallback. Esse caso permanece em último e apenas os casos anteriores a ele são ordenados.

Arquivos .content.json

A forma serializada é ordenada da mesma maneira: { "nodeType": "translation", "translation": { … } }, assim como os nós plural, enumeration e select.

Chaves de conteúdo (opcional)

Com intlayerSortContentKeys: true, o plugin também ordena as chaves de content do dicionário em ordem alfabética em todos os níveis de aninhamento. Isso se aplica apenas a arquivos *.content.*.

export default {
  key: "app",
  content: {
    description: t({ en: "…", fr: "…" }),
    footer: {
      copyright: "© Intlayer",
      links: [{ href: "/doc", label: t({ en: "Docs", fr: "Docs" }) }],
    },
    title: t({ en: "Hello", fr: "Bonjour" }),
  },
} satisfies Dictionary;

A ordenação continua através de cada função utilitária (t, plural, enu, select, cond, gender, md, insert, nest, file…) para alcançar os objetos internos. A estrutura interna de cada utilitário preserva sua ordenação. As chaves passadas para cond() e gender() nunca são reordenadas, pois a última chave serve de fallback. Os campos vizinhos a content (key, title, locale…) permanecem inalterados.

Opções

O que permanece intocado

• Objetos contendo spread (...base), chave computada ([key]), método ou chave duplicada.
• Mapas plural() com chave que não pertença às categorias CLDR.
• Mapas enu() cuja nova ordem alteraria o conteúdo resolvido.
• Chamadas para qualquer outra função com nome semelhante a um helper, mas recebendo argumento diferente de objeto.

Comentários acompanham a chave à qual pertencem.

Parsers suportados

babel, babel-flow, babel-ts, typescript, flow, acorn, espree, meriyah, json, json5 e jsonc. Os blocos <script> de arquivos Vue, Svelte e Astro são formatados com esses parsers.

Limitação conhecida. O Prettier executa apenas um plugin por parser. Se outro plugin também substituir os parsers de JavaScript/TypeScript (por exemplo prettier-plugin-tailwindcss), apenas o último listado se aplicará a esses arquivos. Restrinja o prettier-plugin-intlayer a arquivos *.content.* através de um override para evitar esse conflito.