vitral 0.11.3 → 0.11.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +166 -64
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -86,17 +86,57 @@ Os 10 frameworks têm testes de ponta a ponta no CI, com host e remote de framew
|
|
|
86
86
|
|
|
87
87
|
## Começo rápido
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
Exemplo: uma loja em React que mostra o carrinho, feito por outra equipe.
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
### Hoje, com Module Federation
|
|
92
|
+
|
|
93
|
+
Loja e carrinho combinam a configuração no build dos dois: o que cada um expõe, o que pega do outro e quais versões dividem.
|
|
94
|
+
|
|
95
|
+
```js
|
|
96
|
+
// carrinho/webpack.config.js
|
|
97
|
+
new ModuleFederationPlugin({
|
|
98
|
+
name: 'carrinho',
|
|
99
|
+
filename: 'remoteEntry.js',
|
|
100
|
+
exposes: { './Carrinho': './src/Carrinho' },
|
|
101
|
+
shared: { react: { singleton: true }, 'react-dom': { singleton: true } },
|
|
102
|
+
})
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
```js
|
|
106
|
+
// loja/webpack.config.js
|
|
107
|
+
new ModuleFederationPlugin({
|
|
108
|
+
name: 'loja',
|
|
109
|
+
remotes: { carrinho: 'carrinho@https://cdn.empresa.com/carrinho/remoteEntry.js' },
|
|
110
|
+
shared: { react: { singleton: true }, 'react-dom': { singleton: true } },
|
|
111
|
+
})
|
|
112
|
+
```
|
|
92
113
|
|
|
93
114
|
```jsx
|
|
94
|
-
// src/App.jsx
|
|
115
|
+
// loja/src/App.jsx
|
|
116
|
+
const Carrinho = React.lazy(() => import('carrinho/Carrinho'))
|
|
117
|
+
|
|
118
|
+
export function App() {
|
|
119
|
+
return (
|
|
120
|
+
<ErrorBoundary fallback={<p>Erro</p>}>
|
|
121
|
+
<Suspense fallback={<p>Carregando…</p>}>
|
|
122
|
+
<Carrinho userId={42} />
|
|
123
|
+
</Suspense>
|
|
124
|
+
</ErrorBoundary>
|
|
125
|
+
)
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### O mesmo app com vitral
|
|
130
|
+
|
|
131
|
+
Só o carrinho tem plugin. O build da loja não muda.
|
|
132
|
+
|
|
133
|
+
```jsx
|
|
134
|
+
// carrinho/src/App.jsx (o mesmo componente)
|
|
95
135
|
export default function Carrinho({ userId }) { … }
|
|
96
136
|
```
|
|
97
137
|
|
|
98
138
|
```js
|
|
99
|
-
// vite.config.js
|
|
139
|
+
// carrinho/vite.config.js (no lugar do ModuleFederationPlugin)
|
|
100
140
|
import react from '@vitejs/plugin-react'
|
|
101
141
|
import vitral from 'vitral/vite'
|
|
102
142
|
|
|
@@ -105,9 +145,8 @@ export default { plugins: [react(), vitral()] }
|
|
|
105
145
|
|
|
106
146
|
`vite build` gera o JS, o CSS e um `vitral.json`. Publique a pasta `dist` em qualquer CDN.
|
|
107
147
|
|
|
108
|
-
**2. No host**, registre a URL e mostre o remote:
|
|
109
|
-
|
|
110
148
|
```jsx
|
|
149
|
+
// loja/src/App.jsx (sem plugin no build da loja)
|
|
111
150
|
import { configure } from 'vitral'
|
|
112
151
|
import { Remote } from 'vitral/react'
|
|
113
152
|
|
|
@@ -118,7 +157,16 @@ export function App() {
|
|
|
118
157
|
}
|
|
119
158
|
```
|
|
120
159
|
|
|
121
|
-
Pronto. Mudar `props` atualiza o remote sem remontar.
|
|
160
|
+
Pronto. Mudar `props` atualiza o remote sem remontar. Para gerar loja e carrinho prontos: `npm create vitral@latest`.
|
|
161
|
+
|
|
162
|
+
### O que muda
|
|
163
|
+
|
|
164
|
+
| | Module Federation | vitral |
|
|
165
|
+
|---|---|---|
|
|
166
|
+
| Build da loja | Plugin com `remotes` e `shared` | Não muda |
|
|
167
|
+
| Versão do React | Combinada entre as equipes (`singleton`) | Cada um usa a sua. Uma cópia só com [`dedupe`](https://joaogabriel15.github.io/vitral/aprender/dedupe) |
|
|
168
|
+
| Carregando e erro | `Suspense` e `ErrorBoundary` | `fallback` e `error` do `<Remote>` |
|
|
169
|
+
| Framework | O mesmo nos dois lados | Qualquer um. A loja em React pode mostrar um carrinho em Vue |
|
|
122
170
|
|
|
123
171
|
Numa página HTML qualquer, sem build:
|
|
124
172
|
|
|
@@ -127,6 +175,8 @@ Numa página HTML qualquer, sem build:
|
|
|
127
175
|
<vitral-remote src="https://cdn.empresa.com/carrinho/vitral.json"></vitral-remote>
|
|
128
176
|
```
|
|
129
177
|
|
|
178
|
+
Guia completo: [Migrar do Module Federation](https://joaogabriel15.github.io/vitral/migracao/module-federation).
|
|
179
|
+
|
|
130
180
|
## Frameworks
|
|
131
181
|
|
|
132
182
|
| Framework | Remote | Host | Import |
|
|
@@ -144,63 +194,7 @@ Numa página HTML qualquer, sem build:
|
|
|
144
194
|
|
|
145
195
|
Host e remote não precisam ser do mesmo framework. Cada um tem uma página com exemplo completo em [Frameworks](https://joaogabriel15.github.io/vitral/frameworks/react).
|
|
146
196
|
|
|
147
|
-
## Next.js
|
|
148
|
-
|
|
149
|
-
O remote é sempre um projeto Vite (React, Vue ou outro), como no Começo rápido acima. O host pode ser um app Next ou Nuxt.
|
|
150
|
-
|
|
151
|
-
**Next.js (App Router):**
|
|
152
|
-
|
|
153
|
-
```tsx
|
|
154
|
-
// app/carrinho.tsx
|
|
155
|
-
'use client'
|
|
156
|
-
import { configure } from 'vitral'
|
|
157
|
-
import { Remote } from 'vitral/react'
|
|
158
|
-
|
|
159
|
-
if (typeof window !== 'undefined') {
|
|
160
|
-
configure({ remotes: { carrinho: 'https://cdn.empresa.com/carrinho/vitral.json' } })
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
export function Carrinho({ userId }: { userId: number }) {
|
|
164
|
-
return <Remote name="carrinho" props={{ userId }} fallback={<p>Carregando…</p>} />
|
|
165
|
-
}
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
```tsx
|
|
169
|
-
// app/page.tsx
|
|
170
|
-
import { Carrinho } from './carrinho'
|
|
171
|
-
|
|
172
|
-
export default function Page() {
|
|
173
|
-
return <main><Carrinho userId={42} /></main>
|
|
174
|
-
}
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
**Nuxt 3 e 4:**
|
|
178
|
-
|
|
179
|
-
```ts
|
|
180
|
-
// app/plugins/vitral.client.ts
|
|
181
|
-
import { configure } from 'vitral'
|
|
182
|
-
|
|
183
|
-
export default defineNuxtPlugin(() => {
|
|
184
|
-
configure({ remotes: { catalogo: 'https://cdn.empresa.com/catalogo/vitral.json' } })
|
|
185
|
-
})
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
```vue
|
|
189
|
-
<!-- app/pages/index.vue -->
|
|
190
|
-
<script setup lang="ts">
|
|
191
|
-
import { VitralRemote } from 'vitral/vue'
|
|
192
|
-
</script>
|
|
193
|
-
|
|
194
|
-
<template>
|
|
195
|
-
<VitralRemote name="catalogo" :props="{ userId: 42 }">
|
|
196
|
-
<template #fallback><p>Carregando…</p></template>
|
|
197
|
-
</VitralRemote>
|
|
198
|
-
</template>
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
Nos dois, o servidor renderiza o `fallback` e o remote monta no navegador. Não precisa de `dynamic(..., { ssr: false })` nem de `<ClientOnly>`.
|
|
202
|
-
|
|
203
|
-
## Multi-Zones ou vitral
|
|
197
|
+
## Next.js como host
|
|
204
198
|
|
|
205
199
|
Exemplo: uma loja em Next.js com a área "Minha conta", feita por outra equipe.
|
|
206
200
|
|
|
@@ -327,6 +321,114 @@ Se o código da conta já usa `next/link` ou `useRouter`, não precisa reescreve
|
|
|
327
321
|
|
|
328
322
|
Guia completo, com SSR por rota e prefetch: [Migrar do Next.js Multi-Zones](https://joaogabriel15.github.io/vitral/migracao/multi-zones).
|
|
329
323
|
|
|
324
|
+
No App Router, o host usa `<Remote>` de `vitral/react` num componente `'use client'`. Exemplo em [Next.js](https://joaogabriel15.github.io/vitral/frameworks/next#host-com-app-router).
|
|
325
|
+
|
|
326
|
+
## Nuxt como host
|
|
327
|
+
|
|
328
|
+
Exemplo: uma loja em Nuxt com a área "Catálogo", feita por outra equipe.
|
|
329
|
+
|
|
330
|
+
### Hoje, com dois apps Nuxt
|
|
331
|
+
|
|
332
|
+
A loja repassa as URLs de `/catalogo` para o app do catálogo.
|
|
333
|
+
|
|
334
|
+
```
|
|
335
|
+
loja/ app Nuxt principal
|
|
336
|
+
catalogo/ segundo app Nuxt
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
```ts
|
|
340
|
+
// catalogo/nuxt.config.ts
|
|
341
|
+
export default defineNuxtConfig({
|
|
342
|
+
app: { baseURL: '/catalogo/' },
|
|
343
|
+
})
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
```vue
|
|
347
|
+
<!-- catalogo/app/pages/index.vue -->
|
|
348
|
+
<template><h1>Catálogo</h1></template>
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
```ts
|
|
352
|
+
// loja/nuxt.config.ts
|
|
353
|
+
export default defineNuxtConfig({
|
|
354
|
+
routeRules: {
|
|
355
|
+
'/catalogo/**': { proxy: `${process.env.CATALOGO_URL}/catalogo/**` },
|
|
356
|
+
},
|
|
357
|
+
})
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
```vue
|
|
361
|
+
<!-- loja/app/components/Menu.vue -->
|
|
362
|
+
<!-- <a>, não <NuxtLink>: a página recarrega e baixa Nuxt e Vue de novo. -->
|
|
363
|
+
<a href="/catalogo">Catálogo</a>
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### O mesmo app com vitral
|
|
367
|
+
|
|
368
|
+
A loja continua sendo o único app Nuxt. O catálogo vira um remote: um projeto Vite com o mesmo componente.
|
|
369
|
+
|
|
370
|
+
```
|
|
371
|
+
loja/ app Nuxt (o host)
|
|
372
|
+
catalogo/ projeto Vite (o remote)
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
```js
|
|
376
|
+
// catalogo/vite.config.js (no lugar do app Nuxt do catálogo)
|
|
377
|
+
import vue from '@vitejs/plugin-vue'
|
|
378
|
+
import vitral from 'vitral/vite'
|
|
379
|
+
|
|
380
|
+
export default { plugins: [vue(), vitral({ name: 'catalogo', dedupe: ['vue'] })] }
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
```vue
|
|
384
|
+
<!-- catalogo/src/App.vue (o mesmo componente da página) -->
|
|
385
|
+
<template><h1>Catálogo</h1></template>
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
```ts
|
|
389
|
+
// loja/app/plugins/vitral.client.ts (no lugar do proxy)
|
|
390
|
+
import * as Vue from 'vue'
|
|
391
|
+
import { configure } from 'vitral'
|
|
392
|
+
|
|
393
|
+
export default defineNuxtPlugin(() => {
|
|
394
|
+
configure({
|
|
395
|
+
remotes: { catalogo: 'https://cdn.empresa.com/catalogo/vitral.json' },
|
|
396
|
+
dedupe: { vue: { version: Vue.version, modules: { vue: Vue } } }, // o catálogo usa este Vue
|
|
397
|
+
})
|
|
398
|
+
})
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
```vue
|
|
402
|
+
<!-- loja/app/pages/catalogo.vue (arquivo novo: a página que mostra o catálogo) -->
|
|
403
|
+
<script setup lang="ts">
|
|
404
|
+
import { VitralRemote } from 'vitral/vue'
|
|
405
|
+
</script>
|
|
406
|
+
|
|
407
|
+
<template>
|
|
408
|
+
<VitralRemote name="catalogo">
|
|
409
|
+
<template #fallback><p>Carregando…</p></template>
|
|
410
|
+
</VitralRemote>
|
|
411
|
+
</template>
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
```vue
|
|
415
|
+
<!-- loja/app/components/Menu.vue -->
|
|
416
|
+
<!-- <NuxtLink> normal: a troca é sem recarregar. -->
|
|
417
|
+
<NuxtLink to="/catalogo">Catálogo</NuxtLink>
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
O servidor renderiza o `fallback` e o catálogo monta no navegador. Não precisa de `<ClientOnly>`.
|
|
421
|
+
|
|
422
|
+
### O que muda
|
|
423
|
+
|
|
424
|
+
| | Dois apps Nuxt | vitral |
|
|
425
|
+
|---|---|---|
|
|
426
|
+
| Apps Nuxt | Um por área | Só a loja |
|
|
427
|
+
| Configuração | `baseURL` no catálogo, `proxy` na loja | Plugin no catálogo, `configure()` na loja |
|
|
428
|
+
| Trocar de área | Recarrega a página | Sem recarregar |
|
|
429
|
+
| Vue e Nuxt | Baixados de novo em cada área | Uma cópia do Vue para a página toda |
|
|
430
|
+
| Layout da loja | Cada app repete o seu | O catálogo fica dentro do layout da loja |
|
|
431
|
+
|
|
330
432
|
## O que mais vem junto
|
|
331
433
|
|
|
332
434
|
**Dependências compartilhadas.** Com `vitral({ dedupe: ['react'] })`, o remote usa o React que já está na página e não baixa outra cópia. [Dedupe](https://joaogabriel15.github.io/vitral/aprender/dedupe)
|
package/package.json
CHANGED