@intlayer/docs 8.12.4 → 9.0.0-canary.10

package/docs/pt/packages/react-intlayer/usePathname.md

@@ -0,0 +1,87 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: Documentação do Hook usePathname | react-intlayer
+description: Aprenda como usar o hook usePathname do pacote react-intlayer para obter o pathname da URL atual sem o segmento de localidade.
+keywords:
+  - usePathname
+  - pathname
+  - react
+  - intlayer
+  - routing
+  - internacionalização
+slugs:
+  - doc
+  - packages
+  - react-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Adicionado o utilitário usePathname"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Inicializar histórico"
+author: aymericzip
+---
+
+# Integração React: Documentação do Hook `usePathname`
+
+O hook `usePathname` do `react-intlayer` retorna o pathname atual do navegador com o segmento de localidade removido. Ele conta com a propriedade nativa `window.location.pathname` e reage aos eventos de navegação do navegador por meio de `popstate`.
+
+## Importando `usePathname`
+
+```typescript
+import { usePathname } from "react-intlayer";
+```
+
+## Visão Geral
+
+Diferentemente dos hooks de roteamento específicos de um framework (como aqueles no `next-intlayer` ou `react-router`), este hook é uma solução leve e independente de framework para aplicativos React puros. Ele extrai a URL atual e remove qualquer prefixo de localidade correspondente (por exemplo, `/pt/about` torna-se `/about`).
+
+## Uso
+
+```tsx fileName="src/components/Navigation.tsx" codeFormat={["typescript", "esm"]}
+import type { FC } from "react";
+import { usePathname } from "react-intlayer";
+
+const Navigation: FC = () => {
+  const pathname = usePathname();
+
+  return (
+    <nav>
+      <a
+        href="/home"
+        style={{ fontWeight: pathname === "/home" ? "bold" : "normal" }}
+      >
+        Início
+      </a>
+      <a
+        href="/about"
+        style={{ fontWeight: pathname === "/about" ? "bold" : "normal" }}
+      >
+        Sobre
+      </a>
+    </nav>
+  );
+};
+
+export default Navigation;
+```
+
+## Valor de Retorno
+
+| Tipo     | Descrição                                                                                                |
+| -------- | -------------------------------------------------------------------------------------------------------- |
+| `string` | O pathname atual do navegador com o prefixo de localidade removido (ex: `/pt/dashboard` → `/dashboard`). |
+
+## Comportamento
+
+- **Remoção de Locale**: Usa a utilidade `getPathWithoutLocale` internamente para detectar e remover automaticamente a localidade do pathname com base na configuração Intlayer do aplicativo.
+- **Reatividade**: Ouve o evento `popstate`. Quando o usuário navega usando os botões de voltar/avançar do navegador ou quando `pushState`/`replaceState` é chamado, o hook atualiza o pathname retornado.
+- **Fallback SSR**: No servidor (onde `window` é indefinido), o padrão é retornar `/` pois ele não tem acesso à URL da solicitação por padrão em um contexto React puro.
+
+## Documentação Relacionada
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/react-intlayer/useLocale.md)
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/intlayer/getPathWithoutLocale.md)

package/docs/pt/packages/react-intlayer/useRewriteURL.md

@@ -14,6 +14,7 @@ slugs:
   - packages
   - react-intlayer
   - useRewriteURL
+author: aymericzip
 ---
 
 # Hook useRewriteURL

package/docs/pt/packages/react-native-intlayer/exports.md

@@ -1,8 +1,8 @@
 ---
 createdAt: 2026-01-21
-updatedAt: 2026-01-21
+updatedAt: 2026-06-25
 title: Documentação do pacote react-native-intlayer
-description: Suporte a React Native para o Intlayer, fornecendo providers e polyfills.
+description: Suporte a React Native para o Intlayer, fornecendo providers, hooks, polyfills e configuração Metro.
 keywords:
   - react-native-intlayer
   - react-native
@@ -14,14 +14,20 @@ slugs:
   - react-native-intlayer
   - exports
 history:
+  - version: 9.0.0
+    date: 2026-06-25
+    changes: "Reexportar a API completa do react-intlayer (hooks, utilitários, subcaminhos format/html/markdown) para que um aplicativo React Native dependa apenas de react-native-intlayer"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentação unificada para todas as exportações"
+author: aymericzip
 ---
 
 # Pacote react-native-intlayer
 
-O pacote `react-native-intlayer` fornece as ferramentas necessárias para integrar o Intlayer em aplicações React Native. Inclui um provider e polyfills para suporte a locale.
+O pacote `react-native-intlayer` fornece as ferramentas necessárias para integrar o Intlayer em aplicações React Native. Reexporta a API completa do `react-intlayer` (hooks e utilitários) com um `IntlayerProvider` pronto para React Native, além dos polyfills e da configuração Metro exigidos pelo React Native.
+
+> Em um aplicativo React Native, importe **tudo** de `react-native-intlayer`. Você não precisa instalar ou importar `react-intlayer` diretamente.
 
 ## Instalação
 
@@ -33,14 +39,30 @@ npm install react-native-intlayer
 
 ### Provider
 
-| Componente         | Descrição                                                                       |
-| ------------------ | ------------------------------------------------------------------------------- |
-| `IntlayerProvider` | Componente Provider que envolve sua aplicação e fornece o contexto do Intlayer. |
+| Componente         | Descrição                                                                                                                        |
+| ------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
+| `IntlayerProvider` | Componente Provider que envolve sua aplicação e fornece o contexto do Intlayer. Aplica automaticamente os polyfills necessários. |
+
+```tsx
+import { IntlayerProvider } from "react-native-intlayer";
+```
+
+### Hooks e utilitários
+
+Estes são reexportados de `react-intlayer`, portanto você pode importá-los diretamente de `react-native-intlayer`:
 
-Import:
+| Exportação                                                                                                        | Descrição                                                |
+| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
+| `useIntlayer`                                                                                                     | Acessa conteúdo localizado para uma chave de dicionário. |
+| `useLocale`                                                                                                       | Lê e altera o locale atual.                              |
+| `useDictionary`, `useDictionaryAsync`, `useDictionaryDynamic`, `useLoadDynamic`                                   | Carrega conteúdo de dicionário de diversas formas.       |
+| `useI18n`                                                                                                         | Hook compatível com i18next.                             |
+| `t`                                                                                                               | Auxiliar de tradução inline.                             |
+| `getIntlayer`, `getDictionary`                                                                                    | Getters imperativos de conteúdo.                         |
+| `localeCookie`, `localeInStorage`, `setLocaleCookie`, `setLocaleInStorage`, `useLocaleCookie`, `useLocaleStorage` | Auxiliares de persistência de locale.                    |
 
 ```tsx
-import "react-native-intlayer";
+import { useIntlayer, useLocale, t } from "react-native-intlayer";
 ```
 
 ### Polyfill
@@ -49,10 +71,25 @@ import "react-native-intlayer";
 | ------------------ | --------------------------------------------------------------------------------------- |
 | `intlayerPolyfill` | Função que aplica os polyfills necessários para o React Native dar suporte ao Intlayer. |
 
-Import:
+```tsx
+import { intlayerPolyfill } from "react-native-intlayer";
+```
+
+> O polyfill é aplicado automaticamente quando você importa `IntlayerProvider`. Chame `intlayerPolyfill` manualmente apenas se precisar dos polyfills antes que o provider seja montado.
+
+### Formatadores
+
+Hooks de formatação numérica, de data e outros baseados em Intl estão disponíveis no subcaminho `/format`:
+
+```tsx
+import { useNumber, useDate } from "react-native-intlayer/format";
+```
+
+### Renderização de Markdown e HTML
 
 ```tsx
-import "react-native-intlayer";
+import { MarkdownProvider } from "react-native-intlayer/markdown";
+import { HTMLProvider } from "react-native-intlayer/html";
 ```
 
 ### Configuração do Metro
@@ -65,8 +102,6 @@ O pacote `react-native-intlayer` fornece utilitários de configuração do Metro
 | `configMetroIntlayerSync` | Função síncrona que mescla a configuração do Metro sem preparar os recursos do Intlayer.     |
 | `exclusionList`           | Cria um padrão RegExp para o blockList do Metro para excluir arquivos de conteúdo do bundle. |
 
-Importação:
-
 ```tsx
-import "react-native-intlayer/metro";
+import { configMetroIntlayer } from "react-native-intlayer/metro";
 ```

package/docs/pt/packages/solid-intlayer/IntlayerProvider.md

@@ -21,6 +21,7 @@ history:
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentação unificada para todas as exports"
+author: aymericzip
 ---
 
 # Documentação do Componente IntlayerProvider

package/docs/pt/packages/solid-intlayer/exports.md

@@ -14,9 +14,13 @@ slugs:
   - solid-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Adicionar o utilitário usePathname"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentação unificada para todas as exportações"
+author: aymericzip
 ---
 
 # pacote solid-intlayer
@@ -58,6 +62,7 @@ import "solid-intlayer";
 | `useDictionaryAsync`   | Igual a `useDictionary`, mas lida com dicionários assíncronos.                                                                     | -                                                                                                                       |
 | `useDictionaryDynamic` | Igual a `useDictionary`, mas lida com dicionários dinâmicos.                                                                       | -                                                                                                                       |
 | `useLocale`            | Retorna o locale atual e uma função para defini-lo.                                                                                | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/solid-intlayer/useLocale.md)         |
+| `usePathname`          | Retorna o pathname atual como um `Accessor<string>` com o segmento de locale removido. Reativo a `popstate`.                       | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/solid-intlayer/usePathname.md)     |
 | `useRewriteURL`        | Hook do lado do cliente para gerir reescritas de URL. Atualiza automaticamente a URL se existir uma regra de reescrita localizada. | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/solid-intlayer/useRewriteURL.md) |
 | `useIntl`              | Retorna o objeto Intl para o locale atual.                                                                                         | -                                                                                                                       |
 | `useLoadDynamic`       | Hook para carregar dicionários dinâmicos.                                                                                          | -                                                                                                                       |

package/docs/pt/packages/solid-intlayer/useIntlayer.md

@@ -24,6 +24,7 @@ history:
   - version: 8.0.0
     date: 2026-01-21
     changes: "Unified documentation for all exports"
+author: aymericzip
 ---
 
 # Documentação do Hook useIntlayer

package/docs/pt/packages/solid-intlayer/useLocale.md

@@ -21,6 +21,7 @@ history:
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentação unificada para todas as exportações"
+author: aymericzip
 ---
 
 # Documentação do Hook useLocale

package/docs/pt/packages/solid-intlayer/usePathname.md

@@ -0,0 +1,119 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: Documentação do Hook usePathname | solid-intlayer
+description: Veja como utilizar o hook usePathname do pacote solid-intlayer
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internacionalização
+  - Documentação
+  - Solid
+  - Solid.js
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - solid-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Adicionar o utilitário usePathname"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Init history"
+author: aymericzip
+---
+
+# Integração com Solid: Documentação do Hook `usePathname`
+
+O hook `usePathname` retorna o pathname do navegador atual com o segmento de locale removido, na forma de um `Accessor<string>` do Solid. É útil para a navegação com reconhecimento de locale — por exemplo, determinar qual item de navegação está ativo — sem a necessidade de remover manualmente o prefixo de locale.
+
+## Importando `usePathname` no Solid
+
+```typescript
+import { usePathname } from "solid-intlayer";
+```
+
+## Visão Geral
+
+O `usePathname` cria um sinal reativo inicializado a partir de `window.location.pathname`, remove o prefixo do locale via `getPathWithoutLocale` e atualiza o sinal sempre que o navegador aciona um evento `popstate` (navegação avançar/voltar). O ouvinte de evento é limpo automaticamente via `onCleanup`.
+
+## Uso
+
+```tsx fileName="src/components/NavItem.tsx"
+import type { Component } from "solid-js";
+import { usePathname } from "solid-intlayer";
+
+type NavItemProps = {
+  href: string;
+  label: string;
+};
+
+const NavItem: Component<NavItemProps> = ({ href, label }) => {
+  const pathname = usePathname();
+
+  return (
+    <a href={href} aria-current={pathname() === href ? "page" : undefined}>
+      {label}
+    </a>
+  );
+};
+
+export default NavItem;
+```
+
+## Valor de Retorno
+
+| Tipo               | Descrição                                                                                |
+| ------------------ | ---------------------------------------------------------------------------------------- |
+| `Accessor<string>` | Accessor do Solid (getter reativo) que retorna o pathname atual sem o prefixo do locale. |
+
+## Comportamento
+
+- **Remoção de Locale**: Remove o segmento inicial do locale (ex. `/pt/dashboard` → `/dashboard`).
+- **Reativo**: Atualiza automaticamente em eventos `popstate` (navegação voltar/avançar no navegador).
+- **Seguro em SSR**: Retorna `""` quando o `window` não está disponível.
+- **Limpeza**: O ouvinte `popstate` é removido automaticamente por meio do `onCleanup` do Solid.
+
+## Exemplo
+
+```tsx fileName="src/components/Sidebar.tsx"
+import type { Component } from "solid-js";
+import { For } from "solid-js";
+import { usePathname } from "solid-intlayer";
+
+const links = [
+  { href: "/dashboard", label: "Dashboard" },
+  { href: "/settings", label: "Configurações" },
+];
+
+const Sidebar: Component = () => {
+  const pathname = usePathname();
+
+  return (
+    <nav>
+      <For each={links}>
+        {({ href, label }) => (
+          <a
+            href={href}
+            style={{ "font-weight": pathname() === href ? "bold" : "normal" }}
+          >
+            {label}
+          </a>
+        )}
+      </For>
+    </nav>
+  );
+};
+
+export default Sidebar;
+```
+
+## Relacionado
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/solid-intlayer/useLocale.md) — locale atual + alternador de locale
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/intlayer/getPathWithoutLocale.md) — utilitário subjacente usado por este hook

package/docs/pt/packages/solid-intlayer/useRewriteURL.md

@@ -14,6 +14,7 @@ slugs:
   - packages
   - solid-intlayer
   - useRewriteURL
+author: aymericzip
 ---
 
 # Hook useRewriteURL

package/docs/pt/packages/svelte-intlayer/exports.md

@@ -14,9 +14,13 @@ slugs:
   - svelte-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Adicionar utilitário usePathname"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentação unificada para todas as exportações"
+author: aymericzip
 ---
 
 # Pacote svelte-intlayer
@@ -70,6 +74,7 @@ import "svelte-intlayer";
 | `useDictionaryAsync`   | Mesmo que `useDictionary`, mas lida com dicionários assíncronos.                                                                     | -                                                                                                                        |
 | `useDictionaryDynamic` | Mesmo que `useDictionary`, mas lida com dicionários dinâmicos.                                                                       | -                                                                                                                        |
 | `useLocale`            | Retorna o locale atual e uma função para defini-lo.                                                                                  | -                                                                                                                        |
+| `usePathname`          | Retorna o pathname atual como um store `Readable<string>` com o segmento da locale removido. Reativo a `popstate`.                   | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/svelte-intlayer/usePathname.md)     |
 | `useRewriteURL`        | Função do lado do cliente para gerir reescritas de URL. Atualiza automaticamente a URL se existir uma regra de reescrita localizada. | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/svelte-intlayer/useRewriteURL.md) |
 | `useIntl`              | Retorna o objeto Intl para o locale atual.                                                                                           | -                                                                                                                        |
 

package/docs/pt/packages/svelte-intlayer/usePathname.md

@@ -0,0 +1,103 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: Documentação da Função usePathname | svelte-intlayer
+description: Veja como usar a função usePathname do pacote svelte-intlayer
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internacionalização
+  - Documentação
+  - Svelte
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - svelte-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Adicionar utilitário usePathname"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Inicializar histórico"
+author: aymericzip
+---
+
+# Integração com Svelte: Documentação da `usePathname`
+
+A função `usePathname` retorna o pathname atual do navegador com o segmento da locale removido, como um store Svelte `Readable<string>`. É útil para construir navegação com reconhecimento de locale — por exemplo, determinar qual item de navegação está ativo — sem ter que remover o prefixo da locale manualmente.
+
+## Importando `usePathname` no Svelte
+
+```typescript
+import { usePathname } from "svelte-intlayer";
+```
+
+## Visão Geral
+
+`usePathname` cria um store legível Svelte que lê `window.location.pathname`, remove o prefixo da locale através de `getPathWithoutLocale`, e emite um novo valor sempre que o navegador dispara um evento `popstate` (navegação voltar/avançar). Subscreva com a sintaxe de store `$` em componentes.
+
+## Uso
+
+```svelte fileName="src/components/NavItem.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  export let href: string;
+  export let label: string;
+
+  const pathname = usePathname();
+</script>
+
+<a {href} aria-current={$pathname === href ? "page" : undefined}>
+  {label}
+</a>
+```
+
+## Valor de Retorno
+
+| Tipo               | Descrição                                                                  |
+| ------------------ | -------------------------------------------------------------------------- |
+| `Readable<string>` | Store legível do Svelte contendo o pathname atual sem o prefixo da locale. |
+
+## Comportamento
+
+- **Remoção da locale**: Remove o segmento inicial da locale (ex: `/pt/dashboard` → `/dashboard`).
+- **Reativo**: Emite um novo valor a cada evento `popstate` (navegação de voltar/avançar do navegador).
+- **Seguro para SSR**: Retorna `""` quando `window` não está disponível.
+- **Limpeza**: O listener de `popstate` é removido automaticamente quando o último subscritor se desinscreve.
+
+## Exemplo
+
+```svelte fileName="src/components/Sidebar.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  const links = [
+    { href: "/dashboard", label: "Dashboard" },
+    { href: "/settings", label: "Configurações" },
+  ];
+
+  const pathname = usePathname();
+</script>
+
+<nav>
+  {#each links as link}
+    <a
+      href={link.href}
+      style:font-weight={$pathname === link.href ? "bold" : "normal"}
+    >
+      {link.label}
+    </a>
+  {/each}
+</nav>
+```
+
+## Relacionado
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/svelte-intlayer/useLocale.md) — locale atual + seletor de locale
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/intlayer/getPathWithoutLocale.md) — o utilitário subjacente usado por este hook

package/docs/pt/packages/svelte-intlayer/useRewriteURL.md

@@ -15,6 +15,7 @@ slugs:
   - packages
   - svelte-intlayer
   - useRewriteURL
+author: aymericzip
 ---
 
 # Hook useRewriteURL

package/docs/pt/packages/vite-intlayer/exports.md

@@ -18,6 +18,7 @@ history:
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentação unificada para todas as exportações"
+author: aymericzip
 ---
 
 # pacote vite-intlayer

package/docs/pt/packages/vite-intlayer/intlayer.md

@@ -20,6 +20,7 @@ history:
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documento inicial"
+author: aymericzip
 ---
 
 # Documentação do Plugin intlayer para Vite

package/docs/pt/packages/vite-intlayer/intlayerCompiler.md

@@ -0,0 +1,120 @@
+---
+createdAt: 2026-06-25
+updatedAt: 2026-06-25
+title: Documentação do plugin Vite intlayerCompiler | vite-intlayer
+description: Plugin do Vite que extrai declarações de conteúdo embutidas do Intlayer de arquivos de componentes e as grava em arquivos JSON de dicionário no momento da compilação/transformação.
+keywords:
+  - intlayerCompiler
+  - vite
+  - plugin
+  - compilador
+  - conteúdo
+  - dicionário
+  - internacionalização
+  - i18n
+slugs:
+  - doc
+  - packages
+  - vite-intlayer
+  - intlayerCompiler
+history:
+  - version: 9.0.0
+    date: 2026-06-25
+    changes: "Integrado no intlayer(); inicialização da doc"
+author: aymericzip
+---
+
+# intlayerCompiler
+
+O `intlayerCompiler` é um plugin do Vite que varre os arquivos de código-fonte dos componentes em busca de **declarações de conteúdo embutidas do Intlayer** — conteúdo definido diretamente dentro de um componente, em vez de em um arquivo `.content.ts` separado — e as grava em arquivos JSON de dicionário durante a fase de transformação.
+
+> **A partir do Intlayer v9**, o `intlayerCompiler` é incluído automaticamente dentro do plugin principal [`intlayer()`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/vite-intlayer/intlayer.md) quando `compiler.enabled` é `true` e `compiler.output` está configurado nas suas configurações do Intlayer. Você só precisa registrá-lo separadamente quando desejar controle total sobre as configurações específicas do compilador.
+
+## Uso
+
+### Como parte do `intlayer()` (recomendado, v9+)
+
+Ative o compilador através das configurações do Intlayer:
+
+```ts
+// intlayer.config.ts
+import { defineConfig } from "intlayer";
+
+export default defineConfig({
+  compiler: {
+    enabled: true,
+    output: "./src/dictionaries", // onde os dicionários extraídos são gravados
+  },
+});
+```
+
+Em seguida, use o plugin padrão sem nenhum registro adicional:
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import { intlayer } from "vite-intlayer";
+
+export default defineConfig({
+  plugins: [intlayer()],
+});
+```
+
+### Standalone (quando necessário)
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import { intlayerCompiler } from "vite-intlayer";
+
+export default defineConfig({
+  plugins: [intlayerCompiler()],
+});
+```
+
+## Opções
+
+```ts
+import type { IntlayerCompilerOptions } from "vite-intlayer";
+```
+
+| Opção            | Tipo                      | Descrição                                                                                                   |
+| ---------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| `configOptions`  | `GetConfigurationOptions` | Substituições de configuração do Intlayer encaminhadas para `getConfiguration()`.                           |
+| `compilerConfig` | `Partial<CompilerConfig>` | Substituições para a seção de configuração específica do compilador (ex: `enabled`, `output`, `filesList`). |
+
+### Exemplo
+
+```ts
+intlayerCompiler({
+  configOptions: { configFile: "./config/intlayer.config.ts" },
+  compilerConfig: { enabled: true, output: "./src/dictionaries" },
+});
+```
+
+## Como funciona
+
+### Fase de transformação
+
+Para cada arquivo fonte que corresponda a `compiler.filesList`, o plugin do compilador:
+
+1. Passa o conteúdo do arquivo através de `extractContent` do `@intlayer/babel`.
+2. Chama `onExtract` para cada declaração encontrada, gravando o JSON do dicionário resultante em `compiler.output`.
+3. Retorna o código-fonte transformado com as declarações embutidas substituídas por chamadas padrão `useIntlayer('key')` / `getIntlayer('key')`.
+
+Tipos de arquivos suportados: `.ts`, `.tsx`, `.js`, `.jsx`, `.vue`, `.svelte`, `.astro`.
+
+### HMR (Hot Module Replacement)
+
+Quando um arquivo de componente é salvo no modo de desenvolvimento, o compilador:
+
+1. Detecta a alteração do arquivo por meio do gancho (hook) `handleHotUpdate` do Vite.
+2. Extrai novamente o conteúdo do arquivo atualizado.
+3. Grava o JSON do dicionário atualizado.
+4. Dispara uma atualização completa da página (`server.ws.send({ type: 'full-reload' })`).
+
+Um debounce de 500 ms impede que a gravação do dicionário em si (que também dispara um evento de alteração de arquivo) cause um loop infinito de extração.
+
+### Eliminação de duplicatas (Deduplicação)
+
+O `intlayerCompiler` usa o mesmo mecanismo de deduplicação `createPrimaryInstanceGuard` que os outros plugins integrados. Quando tanto `intlayer()` (que empacota o compilador) quanto uma chamada manual ao `intlayerCompiler()` estão presentes, apenas a primeira instância registrada é executada — nenhum dicionário é gravado duas vezes.