firestore-dart-generator 1.0.0-beta.1 → 1.0.1
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/INSTALACION.md +392 -0
- package/package.json +1 -1
package/INSTALACION.md
ADDED
|
@@ -0,0 +1,392 @@
|
|
|
1
|
+
# 📦 Guía de Instalación - Firestore Dart Generator
|
|
2
|
+
|
|
3
|
+
## 🚀 Instalación Global (Recomendado)
|
|
4
|
+
|
|
5
|
+
### Primera Instalación
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g firestore-dart-generator
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### Verificar Instalación
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
firestore-dart-gen --version
|
|
15
|
+
# Debería mostrar: 1.0.0
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Usar el CLI
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# Con archivo de configuración
|
|
22
|
+
firestore-dart-gen
|
|
23
|
+
|
|
24
|
+
# O con argumentos
|
|
25
|
+
firestore-dart-gen --service-account firebase_service_account.json
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 🔄 Actualizar a la Última Versión
|
|
31
|
+
|
|
32
|
+
### Si ya tienes instalado
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
# Actualizar a la última versión
|
|
36
|
+
npm update -g firestore-dart-generator
|
|
37
|
+
|
|
38
|
+
# O reinstalar
|
|
39
|
+
npm install -g firestore-dart-generator@latest
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Verificar versión instalada
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Ver versión actual
|
|
46
|
+
firestore-dart-gen --version
|
|
47
|
+
|
|
48
|
+
# Ver versión disponible en npm
|
|
49
|
+
npm view firestore-dart-generator version
|
|
50
|
+
|
|
51
|
+
# Ver todas las versiones disponibles
|
|
52
|
+
npm view firestore-dart-generator versions
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 📋 Instalación Local (En un Proyecto)
|
|
58
|
+
|
|
59
|
+
### Como Dependencia de Desarrollo
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# En tu proyecto Flutter/Dart
|
|
63
|
+
npm install --save-dev firestore-dart-generator
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Usar con npx (Sin Instalación)
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
# Ejecutar sin instalar globalmente
|
|
70
|
+
npx firestore-dart-generator --service-account credentials.json
|
|
71
|
+
|
|
72
|
+
# O con config
|
|
73
|
+
npx firestore-dart-generator
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Ventaja:** Siempre usa la última versión disponible.
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 🎯 Instalar Versión Específica
|
|
81
|
+
|
|
82
|
+
### Versión Exacta
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npm install -g firestore-dart-generator@1.0.0
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Versión Beta/Pre-release
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
npm install -g firestore-dart-generator@beta
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Última Versión
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
npm install -g firestore-dart-generator@latest
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 🔍 Verificar Instalación Completa
|
|
103
|
+
|
|
104
|
+
### 1. Verificar que está instalado
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
which firestore-dart-gen
|
|
108
|
+
# Debería mostrar: /usr/local/bin/firestore-dart-gen
|
|
109
|
+
# (o similar según tu sistema)
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 2. Verificar versión
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
firestore-dart-gen --version
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### 3. Ver ayuda
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
firestore-dart-gen --help
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### 4. Probar ejecución
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
# Debería mostrar el modo interactivo
|
|
128
|
+
firestore-dart-gen --service-account tu-credentials.json
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## 🐛 Troubleshooting
|
|
134
|
+
|
|
135
|
+
### "Command not found"
|
|
136
|
+
|
|
137
|
+
**Problema:** El comando no está en tu PATH.
|
|
138
|
+
|
|
139
|
+
**Solución:**
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
# Ver dónde npm instala paquetes globales
|
|
143
|
+
npm config get prefix
|
|
144
|
+
|
|
145
|
+
# Agregar al PATH (macOS/Linux)
|
|
146
|
+
export PATH=$(npm config get prefix)/bin:$PATH
|
|
147
|
+
|
|
148
|
+
# O reinstalar
|
|
149
|
+
npm install -g firestore-dart-generator
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Versión Antigua
|
|
153
|
+
|
|
154
|
+
**Problema:** Tienes una versión antigua instalada.
|
|
155
|
+
|
|
156
|
+
**Solución:**
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
# Desinstalar y reinstalar
|
|
160
|
+
npm uninstall -g firestore-dart-generator
|
|
161
|
+
npm install -g firestore-dart-generator@latest
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Permisos (macOS/Linux)
|
|
165
|
+
|
|
166
|
+
**Problema:** Error de permisos al instalar globalmente.
|
|
167
|
+
|
|
168
|
+
**Solución:**
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
# Opción 1: Usar sudo (no recomendado)
|
|
172
|
+
sudo npm install -g firestore-dart-generator
|
|
173
|
+
|
|
174
|
+
# Opción 2: Configurar npm para no usar sudo (recomendado)
|
|
175
|
+
mkdir ~/.npm-global
|
|
176
|
+
npm config set prefix '~/.npm-global'
|
|
177
|
+
export PATH=~/.npm-global/bin:$PATH
|
|
178
|
+
npm install -g firestore-dart-generator
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Cache de npm
|
|
182
|
+
|
|
183
|
+
**Problema:** npm usa versión en cache.
|
|
184
|
+
|
|
185
|
+
**Solución:**
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
# Limpiar cache
|
|
189
|
+
npm cache clean --force
|
|
190
|
+
|
|
191
|
+
# Reinstalar
|
|
192
|
+
npm install -g firestore-dart-generator@latest
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## 📊 Comparar Versiones
|
|
198
|
+
|
|
199
|
+
### Ver qué versión tienes vs. qué hay disponible
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
# Versión instalada localmente
|
|
203
|
+
firestore-dart-gen --version
|
|
204
|
+
|
|
205
|
+
# Última versión en npm
|
|
206
|
+
npm view firestore-dart-generator version
|
|
207
|
+
|
|
208
|
+
# Todas las versiones publicadas
|
|
209
|
+
npm view firestore-dart-generator versions --json
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Ejemplo de Output
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
$ firestore-dart-gen --version
|
|
216
|
+
1.0.0
|
|
217
|
+
|
|
218
|
+
$ npm view firestore-dart-generator version
|
|
219
|
+
1.0.0
|
|
220
|
+
|
|
221
|
+
# Si hay una nueva versión disponible:
|
|
222
|
+
$ npm view firestore-dart-generator version
|
|
223
|
+
1.1.0 # ← Nueva versión disponible
|
|
224
|
+
|
|
225
|
+
# Actualizar
|
|
226
|
+
$ npm update -g firestore-dart-generator
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## 🔄 Workflow de Actualización
|
|
232
|
+
|
|
233
|
+
### Para Usuarios
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
# 1. Verificar versión actual
|
|
237
|
+
firestore-dart-gen --version
|
|
238
|
+
|
|
239
|
+
# 2. Ver versión disponible
|
|
240
|
+
npm view firestore-dart-generator version
|
|
241
|
+
|
|
242
|
+
# 3. Si hay actualización, actualizar
|
|
243
|
+
npm update -g firestore-dart-generator
|
|
244
|
+
|
|
245
|
+
# 4. Verificar nueva versión
|
|
246
|
+
firestore-dart-gen --version
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Para Desarrolladores del Paquete
|
|
250
|
+
|
|
251
|
+
```bash
|
|
252
|
+
# 1. Actualizar versión en package.json
|
|
253
|
+
npm version patch # 1.0.0 -> 1.0.1
|
|
254
|
+
# o
|
|
255
|
+
npm version minor # 1.0.0 -> 1.1.0
|
|
256
|
+
# o
|
|
257
|
+
npm version major # 1.0.0 -> 2.0.0
|
|
258
|
+
|
|
259
|
+
# 2. Build
|
|
260
|
+
npm run build
|
|
261
|
+
|
|
262
|
+
# 3. Publicar
|
|
263
|
+
npm publish
|
|
264
|
+
|
|
265
|
+
# 4. Verificar publicación
|
|
266
|
+
npm view firestore-dart-generator version
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
|
|
271
|
+
## 📦 Instalación en Diferentes Sistemas
|
|
272
|
+
|
|
273
|
+
### macOS
|
|
274
|
+
|
|
275
|
+
```bash
|
|
276
|
+
# Con Homebrew (si tienes fórmula)
|
|
277
|
+
brew install firestore-dart-generator
|
|
278
|
+
|
|
279
|
+
# O con npm
|
|
280
|
+
npm install -g firestore-dart-generator
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Linux
|
|
284
|
+
|
|
285
|
+
```bash
|
|
286
|
+
# Con npm
|
|
287
|
+
npm install -g firestore-dart-generator
|
|
288
|
+
|
|
289
|
+
# O con npx (sin instalar)
|
|
290
|
+
npx firestore-dart-generator
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### Windows
|
|
294
|
+
|
|
295
|
+
```powershell
|
|
296
|
+
# Con npm
|
|
297
|
+
npm install -g firestore-dart-generator
|
|
298
|
+
|
|
299
|
+
# Verificar instalación
|
|
300
|
+
firestore-dart-gen --version
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
---
|
|
304
|
+
|
|
305
|
+
## ✅ Checklist Post-Instalación
|
|
306
|
+
|
|
307
|
+
Después de instalar, verifica:
|
|
308
|
+
|
|
309
|
+
- [ ] `firestore-dart-gen --version` funciona
|
|
310
|
+
- [ ] `firestore-dart-gen --help` muestra ayuda
|
|
311
|
+
- [ ] Puedes ejecutar el CLI con tu service account
|
|
312
|
+
- [ ] El modo interactivo funciona
|
|
313
|
+
- [ ] Puedes crear y usar `firestore-dart-gen.yaml`
|
|
314
|
+
|
|
315
|
+
---
|
|
316
|
+
|
|
317
|
+
## 🎯 Próximos Pasos Después de Instalar
|
|
318
|
+
|
|
319
|
+
### 1. Crear archivo de configuración
|
|
320
|
+
|
|
321
|
+
```bash
|
|
322
|
+
# En tu proyecto Flutter
|
|
323
|
+
cd mi-proyecto-flutter
|
|
324
|
+
|
|
325
|
+
# Crear config
|
|
326
|
+
cat > firestore-dart-gen.yaml << EOF
|
|
327
|
+
firebase:
|
|
328
|
+
serviceAccount: ./firebase_service_account.json
|
|
329
|
+
|
|
330
|
+
collections:
|
|
331
|
+
- users
|
|
332
|
+
- products
|
|
333
|
+
|
|
334
|
+
output:
|
|
335
|
+
directory: ./lib/src/models
|
|
336
|
+
sampleSize: 20
|
|
337
|
+
EOF
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### 2. Ejecutar
|
|
341
|
+
|
|
342
|
+
```bash
|
|
343
|
+
firestore-dart-gen
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### 3. Usar modelos generados
|
|
347
|
+
|
|
348
|
+
```dart
|
|
349
|
+
// En tu código Dart
|
|
350
|
+
import 'package:mi_proyecto/models/user_dto.dart';
|
|
351
|
+
|
|
352
|
+
final user = UserDTO.fromJson(firestoreDoc.data()!);
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
---
|
|
356
|
+
|
|
357
|
+
## 📚 Recursos
|
|
358
|
+
|
|
359
|
+
- **npm Package**: https://www.npmjs.com/package/firestore-dart-generator
|
|
360
|
+
- **GitHub**: https://github.com/TU_USUARIO/firestore-dart-generator
|
|
361
|
+
- **Documentación**: Ver `README.md`
|
|
362
|
+
- **Guía Config**: Ver `CONFIG_FILE_GUIDE.md`
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
## 💡 Tips
|
|
367
|
+
|
|
368
|
+
### Usar npx para Probar Sin Instalar
|
|
369
|
+
|
|
370
|
+
```bash
|
|
371
|
+
# Probar última versión sin instalar
|
|
372
|
+
npx firestore-dart-generator@latest --help
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### Mantener Actualizado
|
|
376
|
+
|
|
377
|
+
```bash
|
|
378
|
+
# Agregar a tu script de setup
|
|
379
|
+
npm install -g firestore-dart-generator@latest
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
### Ver Changelog
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
# Ver cambios de la versión
|
|
386
|
+
npm view firestore-dart-generator
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
¡Listo para usar! 🚀
|
|
392
|
+
|