@doolehealth/service-lib 0.0.5 → 0.0.6
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 +112 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,24 +1,123 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Guía para Compilar y Publicar la Librería `service-lib`
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Introducción
|
|
4
|
+
Este documento detalla el proceso para compilar y publicar la librería interna `service-lib` de manera eficiente y organizada. Sigue estos pasos para garantizar que el paquete cumpla con los estándares de la empresa.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
---
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
> Note: Don't forget to add `--project service-lib` or else it will be added to the default project in your `angular.json` file.
|
|
8
|
+
## 1. Compilar la Librería
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
### Paso 1: Verificar la Configuración
|
|
11
|
+
Antes de comenzar, asegúrate de que el archivo `package.json` de tu librería tenga el formato correcto en el campo `name`:
|
|
11
12
|
|
|
12
|
-
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"name": "@doolehealth/service-lib",
|
|
16
|
+
"version": "x.x.x", // Asegúrate de usar el formato correcto de versionado semántico
|
|
17
|
+
...
|
|
18
|
+
}
|
|
19
|
+
```
|
|
13
20
|
|
|
14
|
-
|
|
21
|
+
### Paso 2: Ejecutar el Comando de Build
|
|
15
22
|
|
|
16
|
-
|
|
23
|
+
Para compilar la librería, utiliza el comando:
|
|
17
24
|
|
|
18
|
-
|
|
25
|
+
```bash
|
|
26
|
+
ng build service-lib
|
|
27
|
+
```
|
|
28
|
+
Esto generará un directorio `dist/service-lib` donde se encontrará la versión compilada de la librería.
|
|
19
29
|
|
|
20
|
-
|
|
30
|
+
---
|
|
21
31
|
|
|
22
|
-
##
|
|
32
|
+
## 2. Publicar la Librería en NPM
|
|
33
|
+
|
|
34
|
+
### Paso 1: Verificar el Package Ready para Publicar
|
|
35
|
+
|
|
36
|
+
1. Ve al directorio generado al compilar la librería:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
cd dist/service-lib
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
2. Asegúrate de que el archivo `package.json` tenga el nombre correcto, siguiendo el formato:
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"name": "@doolehealth/service-lib",
|
|
47
|
+
"version": "x.x.x",
|
|
48
|
+
"main": "index.js",
|
|
49
|
+
...
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Paso 2: Autenticarse en NPM
|
|
54
|
+
Si no estás autenticado en tu cuenta de NPM, ejecuta:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npm login
|
|
58
|
+
```
|
|
59
|
+
Esto te pedirá:
|
|
60
|
+
- Tu usuario de NPM.
|
|
61
|
+
- Contraseña.
|
|
62
|
+
- Correo electrónico asociado.
|
|
63
|
+
|
|
64
|
+
### Paso 3: Publicar en NPM
|
|
65
|
+
|
|
66
|
+
Desde el directorio `dist/service-lib`, ejecuta:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npm publish
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Nota:** Asegúrate de que la versión de la librería no sea repetida. Si intentas publicar con una versión existente, NPM rechazará la publicación.
|
|
73
|
+
|
|
74
|
+
Si es necesario, actualiza la versión en el `package.json` antes de publicar. Por ejemplo, incrementa la versión en el formato **semántico** (major.minor.patch):
|
|
75
|
+
|
|
76
|
+
```json
|
|
77
|
+
"version": "1.0.1"
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Paso 4: Confirmar la Publicación
|
|
81
|
+
|
|
82
|
+
Una vez publicada, puedes verificar que la librería esté disponible ejecutando:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npm view @doolehealth/service-lib
|
|
86
|
+
```
|
|
87
|
+
Esto mostrará información de la versión publicada y otros detalles.
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## 3. Notas Importantes
|
|
92
|
+
|
|
93
|
+
1. **Verificar Dependencias**: Antes de compilar y publicar, asegúrate de que todas las dependencias necesarias estén correctamente instaladas.
|
|
94
|
+
2. **Evitar Versiones Duplicadas**: Cada nueva versión publicada debe tener un número único. Utiliza versionado semántico para mantener el control.
|
|
95
|
+
3. **Publicación Interna**: Este proceso es para publicar librerías internas de la empresa y no deben ser accesibles al público general.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Resumen de Comandos
|
|
100
|
+
|
|
101
|
+
1. Compilar la librería:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
ng build service-lib
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
2. Acceder al directorio compilado:
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
cd dist/service-lib
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
3. Publicar en NPM:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
npm publish
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
**ATENCIÓN:**
|
|
122
|
+
- La configuración del `name` en el `package.json` debe seguir el formato `@doolehealth/nombrelibreria`.
|
|
23
123
|
|
|
24
|
-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
|