nuxt-bun-compile 0.1.17 → 0.1.18

package/README.md

@@ -10,25 +10,7 @@
 
 ---
 
-> **⚠️ IMPORTANT: Use `bun run -b build` to generate the binary**
->
-> The following commands **DO NOT** trigger binary compilation:
-> ```bash
-> bun run build        # ❌ does not generate the binary
-> npm run build        # ❌ does not generate the binary
-> pnpm run build       # ❌ does not generate the binary
-> ```
->
-> The correct command is:
-> ```bash
-> bun run -b build     # ✅ generates the binary (nuxtbin or the name set in outfile)
-> ```
->
-> [Why is `-b` required?](https://github.com/jprando/nuxt-bun-compile?tab=readme-ov-file#why-is--b-required)
-
----
-
-## 🚀 Super Flash Start
+## ⚡ Quick Start
 
 Add the module to any Nuxt project in two steps:
 
@@ -44,56 +26,23 @@ bun nuxt add nuxt-bun-compile
 bun run -b build
 ```
 
-Done! Your standalone binary is ready.
+[Why is `-b` required?](https://github.com/jprando/nuxt-bun-compile?tab=readme-ov-file#why-is--b-required)
 
----
+[If you encounter memory issues during build](https://github.com/jprando/nuxt-bun-compile?tab=readme-ov-file#why-node_options--max-old-space-size8192)
 
-## ⚡ Quick Start
+**Step 3: Run your binary**
 
 ```bash
-# Install from NPM registry
-bun add -D nuxt-bun-compile
-
-# Or install directly from GitHub
-bun add -D github:jprando/nuxt-bun-compile
-
-# Or link locally for development
-git clone https://github.com/jprando/nuxt-bun-compile.git
-cd nuxt-bun-compile && bun install && bun link
-cd your-nuxt-app && bun link nuxt-bun-compile && bun nuxt add nuxt-bun-compile
-```
-
-Add to your `nuxt.config.ts`:
-
-```ts
-export default defineNuxtConfig({
-  modules: ["nuxt-bun-compile"],
-  bunCompile: {
-    outfile: "myapp",
-  },
-})
+./nuxtbin
+# Listening on http://localhost:3000
 ```
 
-Build and run:
-
-```bash
-NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
-./myapp
-```
+Done! Your standalone binary is ready.
 
 That's it. One binary. No `node_modules`. No runtime. Just your app.
 
 ---
 
-## 🌟 Example
-
-Check out a real project using this module:
-
-- **Repository:** [nuxt-duckdb-wasm](https://github.com/jprando/nuxt-duckdb-wasm)
-- **Demo:** [https://nuxt-duckdb-wasm.jeudi.workers.dev/](https://nuxt-duckdb-wasm.jeudi.workers.dev/)
-
----
-
 ## 🎯 What It Does
 
 The module hooks into Nuxt's build pipeline and handles **everything** automatically:
@@ -153,14 +102,6 @@ bunCompile: {
 
 ## 🏗️ Architecture
 
-```
-src/
-  module.ts         # Main module — configures Nitro + auto-compiles
-package.json
-tsconfig.json
-dprint.json         # Code formatter config
-```
-
 The module uses a **hook-based architecture**:
 
 - **`nitro:config`** — Adjusts Nitro settings (preset, externals, bundling)
@@ -200,7 +141,7 @@ The **`-b`** (or `--bun`) flag forces Bun to be the runtime that executes the sc
 |---|---|---|
 | 🔤 | **TypeScript** | ESNext target, strict mode, bundler resolution |
 | 🐰 | **Bun** | Runtime 1.3.9+, package manager |
-| 💚 | **Nuxt** | 3.x / 4.x via `@nuxt/kit` + `@nuxt/schema` |
+| 💚 | **Nuxt** | 4.x |
 | 📐 | **dprint** | Code formatter (TS, JSON, MD, TOML, YAML, and more) |
 | 📦 | **ESM** | Pure ES modules (`"type": "module"`) |
 
@@ -208,43 +149,25 @@ The **`-b`** (or `--bun`) flag forces Bun to be the runtime that executes the sc
 
 ## 🧑‍💻 Development
 
-### Commands
-
-```bash
-# Install dependencies
-bun install
-
-# Format code
-bun run format
-
-# Link for local testing
-bun link
-```
-
-### Code Style
-
-- **Formatter:** dprint — always run `bun run format` before committing
-- **Strings:** Double quotes
-- **Semicolons:** Yes
-- **Constants:** `UPPER_SNAKE_CASE` for module-level (`DEFAULT_EXTERNALS`)
-- **Types:** `interface` for public APIs, `import type` for type-only imports
-- **Node built-ins:** Use `node:` prefix (e.g. `node:child_process`)
-
 ### Testing Locally in a Nuxt App
 
 ```bash
-# 1. Link the module
-cd nuxt-bun-compile && bun link
+# 1. Clone this repo for local development
+git clone https://github.com/jprando/nuxt-bun-compile.git
 
-# 2. Use it in your Nuxt app
+# 2. Link the module
+cd nuxt-bun-compile && bun install && bun prepack && bun link
+
+# 3. Use it in your Nuxt app
 cd your-nuxt-app && bun link nuxt-bun-compile
 
-# 3. Add to nuxt.config.ts modules array
+# 4. Add to nuxt.config.ts modules array
+bun nuxt add nuxt-bun-compile
 
-# 4. Build
+# 5. Build
 NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
 
-# 5. Run the binary
+# 6. Run the binary
 ./nuxtbin
 ```
 

package/README.ptBR.md

@@ -4,131 +4,80 @@
 
 ![Logo Nuxt Bun Compile](/images/logo-transparent--nuxt-bun-compile.png "Logo Nuxt Bun Compile")
 
-> 🚀 Modulo Nuxt que configura automaticamente o Nitro para `bun build --compile`, gerando um **binario executavel standalone** a partir da sua aplicacao Nuxt — sem dependencias de runtime.
+> 🚀 Módulo Nuxt que configura automaticamente o Nitro para `bun build --compile`, gerando um **binário executável standalone** a partir da sua aplicação Nuxt — sem dependências de runtime.
 
 [Read in English](README.md)
 
 ---
 
-> **⚠️ IMPORTANTE: Use `bun run -b build` para gerar o binario**
->
-> Os comandos abaixo **NAO** acionam a compilacao do binario:
-> ```bash
-> bun run build        # ❌ nao gera o binario
-> npm run build        # ❌ nao gera o binario
-> pnpm run build       # ❌ nao gera o binario
-> ```
->
-> O comando correto eh:
-> ```bash
-> bun run -b build     # ✅ gera o binario (nuxtbin ou o nome definido em outfile)
-> ```
->
-> [Por que é necessário o parâmetro `-b`?](https://github.com/jprando/nuxt-bun-compile/blob/main/README.ptBR.md#por-que-o--b-eh-obrigatorio)
+## ⚡ Início Rápido
 
----
-
-## 🚀 Super Flash Start
-
-Adicione o modulo a qualquer projeto Nuxt em dois passos:
+Adicione o módulo a qualquer projeto Nuxt em dois passos:
 
-**Passo 1: Instalar o modulo**
+**Passo 1: Instalar o módulo**
 
 ```bash
 bun nuxt add nuxt-bun-compile
 ```
 
-**Passo 2: Gerar seu binario**
+**Passo 2: Compilar seu binário**
 
 ```bash
 bun run -b build
 ```
 
-Pronto! Seu binario standalone esta pronto.
+[Por que é necessário o parâmetro `-b`?](https://github.com/jprando/nuxt-bun-compile?tab=readme-ov-file#por-que--b-eh-obrigatorio)
 
----
+[Se você enfrentar problemas de memória durante a compilação](https://github.com/jprando/nuxt-bun-compile?tab=readme-ov-file#por-que-node_options---max-old-space-size8192)
 
-## ⚡ Inicio Rapido
+**Passo 3: Executar seu binário**
 
 ```bash
-# Instalar do NPM registry
-bun add -D nuxt-bun-compile
-
-# Instalar diretamente do GitHub
-bun add -D github:jprando/nuxt-bun-compile
-
-# Ou linkar localmente para desenvolvimento
-git clone https://github.com/jprando/nuxt-bun-compile.git
-cd nuxt-bun-compile && bun install && bun link
-cd sua-app-nuxt && bun link nuxt-bun-compile && bun nuxt add nuxt-bun-compile
-```
-
-Adicione ao seu `nuxt.config.ts`:
-
-```ts
-export default defineNuxtConfig({
-  modules: ["nuxt-bun-compile"],
-  bunCompile: {
-    outfile: "myapp",
-  },
-})
+./nuxtbin
+# Listening on http://localhost:3000
 ```
 
-Build e execucao:
-
-```bash
-NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
-./myapp
-```
+Pronto! Seu binário standalone está pronto.
 
-So isso. Um binario. Sem `node_modules`. Sem runtime. Apenas sua aplicacao.
+Só um binário. Sem `node_modules`. Sem runtime. Apenas sua aplicação.
 
 ---
 
-## 🌟 Exemplo
+## 🎯 O que Faz
 
-Veja um projeto real utilizando este modulo:
+O módulo se conecta ao pipeline de build do Nuxt e cuida de **tudo** automaticamente:
 
-- **Repositorio:** [nuxt-duckdb-wasm](https://github.com/jprando/nuxt-duckdb-wasm)
-- **Demo:** [https://nuxt-duckdb-wasm.jeudi.workers.dev/](https://nuxt-duckdb-wasm.jeudi.workers.dev/)
+1. **Configura o Nitro** com as configurações ótimas para compilação em binário
+2. **Externaliza pacotes problemáticos** que quebram com bundling completo
+3. **Executa `bun build --compile`** após o build para produzir um executável standalone
 
----
+### Configuração do Nitro (aplicada automaticamente)
 
-## 🎯 O que faz
-
-O modulo se conecta ao pipeline de build do Nuxt e cuida de **tudo** automaticamente:
-
-1. **Configura o Nitro** com as configuracoes otimas para compilacao em binario
-2. **Externaliza pacotes problematicos** que quebram com bundling completo
-3. **Executa `bun build --compile`** apos o build para produzir um executavel standalone
-
-### Configuracao do Nitro (aplicada automaticamente)
-
-| Configuracao | Valor | Motivo |
+| Configuração | Valor | Motivo |
 |---|---|---|
 | `preset` | `"bun"` | Usar o runtime Bun como alvo |
 | `noExternals` | `true` | Empacotar tudo no output |
-| `inlineDynamicImports` | `true` | Achatar imports dinamicos para output em arquivo unico |
-| `serveStatic` | `"inline"` | Embutir assets estaticos no binario |
-| `esbuild.options.target` | `"esnext"` | Usar as features JS mais recentes para maximo desempenho |
+| `inlineDynamicImports` | `true` | Achatar imports dinâmicos para output em arquivo único |
+| `serveStatic` | `"inline"` | Embutir assets estáticos no binário |
+| `esbuild.options.target` | `"esnext"` | Usar as features JS mais recentes para máximo desempenho |
 
 ---
 
-## ⚙️ Opcoes
+## ⚙️ Opções
 
-| Opcao | Tipo | Padrao | Descricao |
+| Opção | Tipo | Padrão | Descrição |
 |---|---|---|---|
-| `enabled` | `boolean` | `true` | Habilitar/desabilitar o modulo |
-| `outfile` | `string` | `"nuxtbin"` | Nome do arquivo binario de saida |
+| `enabled` | `boolean` | `true` | Habilitar/desabilitar o módulo |
+| `outfile` | `string` | `"nuxtbin"` | Nome do arquivo binário de saída |
 | `bunPath` | `string` | `undefined` | Caminho para o executável do bun. Pode ser um diretório (ex: `/opt/bun/`) ou o caminho direto para o binário (ex: `/opt/bun/bun`). Se for um diretório, '/bun' será anexado. O padrão é 'bun' do PATH do sistema. |
 | `extraExternals` | `(string \| RegExp)[]` | `[]` | Pacotes adicionais para marcar como external |
-| `autoCompile` | `boolean` | `true` | Executar `bun build --compile` automaticamente apos o build |
+| `autoCompile` | `boolean` | `true` | Executar `bun build --compile` automaticamente após o build |
 
 ---
 
-## 📦 Pacotes External Padrao
+## 📦 Pacotes External Padrão
 
-Estes pacotes sao conhecidos por quebrar com `noExternals: true` e sao excluidos por padrao:
+Estes pacotes são conhecidos por quebrar com `noExternals: true` e são excluídos por padrão:
 
 | Pacote | Pattern |
 |---|---|
@@ -147,24 +96,16 @@ bunCompile: {
 }
 ```
 
-> **⚠️ Importante:** As bibliotecas listadas em `extraExternals` (assim como as externals padrao) **nao sao embutidas no binario**. Para que o binario `nuxtbin` execute corretamente, essas dependencias precisam estar disponiveis em uma pasta `node_modules` ao lado do binario gerado.
+> **⚠️ Importante:** As bibliotecas listadas em `extraExternals` (assim como as externals padrão) **não são embutidas no binário**. Para que o binário `nuxtbin` execute corretamente, essas dependências precisam estar disponíveis em uma pasta `node_modules` ao lado do binário gerado.
 
 ---
 
 ## 🏗️ Arquitetura
 
-```
-src/
-  module.ts         # Modulo principal — configura o Nitro + auto-compila
-package.json
-tsconfig.json
-dprint.json         # Configuracao do formatador de codigo
-```
+O módulo usa uma **arquitetura baseada em hooks**:
 
-O modulo usa uma **arquitetura baseada em hooks**:
-
-- **`nitro:config`** — Ajusta configuracoes do Nitro (preset, externals, bundling)
-- **`nitro:compiled`** — Aciona `bun build --compile` apos o Nitro terminar o build do servidor
+- **`nitro:config`** — Ajusta configurações do Nitro (preset, externals, bundling)
+- **`nitro:compiled`** — Aciona `bun build --compile` após o Nitro terminar o build do servidor
 
 ### Como Funciona
 
@@ -177,12 +118,12 @@ bun run -b build
     │
     └─ hook nitro compiled ──▶ bun build .output/server/index.mjs --compile --outfile <nome>
                                    │
-                                   └──▶ 🎉 Binario standalone pronto!
+                                   └──▶ 🎉 Binário standalone pronto!
 ```
 
-### Por que o `-b` eh obrigatorio?
+### Por que `-b` é obrigatório?
 
-Quando voce executa `bun run build` (sem `-b`), o Bun age como um **gerenciador de tarefas** e pode delegar a execucao do script ao Node.js. Nesse cenario, as variaveis `globalThis.Bun` e `process.versions.bun` **nao existem**, e o modulo nao consegue detectar o runtime Bun:
+Quando você executa `bun run build` (sem `-b`), o Bun age como um **gerenciador de tarefas** e pode delegar a execução do script ao Node.js. Nesse cenário, as variáveis `globalThis.Bun` e `process.versions.bun` **não existem**, e o módulo não consegue detectar o runtime Bun:
 
 ```ts
 const isBun = typeof globalThis.Bun !== "undefined"
@@ -190,7 +131,7 @@ const isBun = typeof globalThis.Bun !== "undefined"
 ```
 [src/module.ts:L70-L76](https://github.com/jprando/nuxt-bun-compile/blob/main/src/module.ts#L70-L76)
 
-O parametro **`-b`** (ou `--bun`) forca o Bun a ser o runtime que executa o script. Com ele, as variaveis acima ficam disponiveis e a etapa de `bun build --compile` eh executada corretamente.
+O parâmetro **`-b`** (ou `--bun`) força o Bun a ser o runtime que executa o script. Com ele, as variáveis acima ficam disponíveis e a etapa de `bun build --compile` é executada corretamente.
 
 ---
 
@@ -200,51 +141,33 @@ O parametro **`-b`** (ou `--bun`) forca o Bun a ser o runtime que executa o scri
 |---|---|---|
 | 🔤 | **TypeScript** | Target ESNext, strict mode, bundler resolution |
 | 🐰 | **Bun** | Runtime 1.3.9+, gerenciador de pacotes |
-| 💚 | **Nuxt** | 3.x / 4.x via `@nuxt/kit` + `@nuxt/schema` |
-| 📐 | **dprint** | Formatador de codigo (TS, JSON, MD, TOML, YAML e mais) |
+| 💚 | **Nuxt** | 4.x |
+| 📐 | **dprint** | Formatador de código (TS, JSON, MD, TOML, YAML e mais) |
 | 📦 | **ESM** | ES modules puro (`"type": "module"`) |
 
 ---
 
 ## 🧑‍💻 Desenvolvimento
 
-### Comandos
+### Testando Localmente em uma Aplicação Nuxt
 
 ```bash
-# Instalar dependencias
-bun install
-
-# Formatar codigo
-bun run format
-
-# Linkar para testes locais
-bun link
-```
-
-### Estilo de Codigo
-
-- **Formatador:** dprint — sempre execute `bun run format` antes de commitar
-- **Strings:** Aspas duplas
-- **Ponto e virgula:** Sim
-- **Constantes:** `UPPER_SNAKE_CASE` para nivel de modulo (`DEFAULT_EXTERNALS`)
-- **Tipos:** `interface` para APIs publicas, `import type` para imports somente de tipo
-- **Built-ins do Node:** Use prefixo `node:` (ex: `node:child_process`)
-
-### Testando Localmente em uma App Nuxt
+# 1. Clone este repositório para desenvolvimento local
+git clone https://github.com/jprando/nuxt-bun-compile.git
 
-```bash
-# 1. Linkar o modulo
-cd nuxt-bun-compile && bun link
+# 2. Linke o módulo
+cd nuxt-bun-compile && bun install && bun prepack && bun link
 
-# 2. Usar na sua app Nuxt
+# 3. Use em sua aplicação Nuxt
 cd sua-app-nuxt && bun link nuxt-bun-compile
 
-# 3. Adicionar ao array modules no nuxt.config.ts
+# 4. Adicione ao array modules no nuxt.config.ts
+bun nuxt add nuxt-bun-compile
 
-# 4. Build
+# 5. Compile
 NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
 
-# 5. Executar o binario
+# 6. Execute o binário
 ./nuxtbin
 ```
 
@@ -254,7 +177,7 @@ NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
 
 - [Bun](https://bun.sh) 1.3.9+ (para a etapa de `--compile`)
 - Nuxt 3.x / 4.x
-- Node 24+ (quando nao usar Bun como runtime)
+- Node 24+ (quando não usar Bun como runtime)
 
 ---
 
@@ -262,18 +185,18 @@ NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
 
 ### Por que `NODE_OPTIONS="--max-old-space-size=8192"`?
 
-O processo de build do Nuxt com `noExternals: true` e `inlineDynamicImports: true` faz com que o Rollup/esbuild tente empacotar **todas** as dependencias em um unico bundle. Em projetos com muitas dependencias, isso pode consumir mais memoria do que o limite padrao do V8 (aproximadamente 1.5–2 GB), causando o erro:
+O processo de build do Nuxt com `noExternals: true` e `inlineDynamicImports: true` faz com que o Rollup/esbuild tente empacotar **todas** as dependências em um único bundle. Em projetos com muitas dependências, isso pode consumir mais memória do que o limite padrão do V8 (aproximadamente 1.5–2 GB), causando o erro:
 
 ```
 FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory
 ```
 
-A variavel `NODE_OPTIONS="--max-old-space-size=8192"` aumenta o limite de memoria heap do V8 para 8 GB, dando margem suficiente para que o bundling termine sem estourar a memoria. O valor de `8192` (MB) eh uma referencia segura para a maioria dos projetos — ajuste conforme necessario para projetos maiores ou maquinas com menos RAM.
+A variável `NODE_OPTIONS="--max-old-space-size=8192"` aumenta o limite de memória heap do V8 para 8 GB, dando margem suficiente para que o bundling termine sem estourar a memória. O valor de `8192` (MB) é uma referência segura para a maioria dos projetos — ajuste conforme necessário para projetos maiores ou máquinas com menos RAM.
 
-> **Nota:** Essa variavel afeta o processo do Node.js/V8 que roda o build do Nuxt, e nao o binario final gerado pelo `bun build --compile`.
+> **Nota:** Essa variável afeta o processo do Node.js/V8 que roda o build do Nuxt, e não o binário final gerado pelo `bun build --compile`.
 
 ---
 
-## 📄 Licenca
+## 📄 Licença
 
 MIT

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-bun-compile",
   "configKey": "bunCompile",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-bun-compile",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "description": "Nuxt module that automatically configures Nitro for `bun build --compile`, generating a standalone executable binary from your Nuxt app.",
   "repository": "jprando/nuxt-bun-compile",
   "license": "MIT",