@producteca/producteca-ui-kit 1.6.0 → 1.7.0-alpha.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/README.md +35 -0
- package/package.json +7 -8
package/README.md
CHANGED
|
@@ -13,6 +13,9 @@
|
|
|
13
13
|
- 🌟 [Typescript](https://www.typescriptlang.org/)
|
|
14
14
|
- 🐶 [Husky](https://typicode.github.io/husky) & [Lint Staged](https://www.npmjs.com/package/lint-staged) - Pre-commit Hooks
|
|
15
15
|
- 👷 [Github Actions](https://github.com/features/actions)
|
|
16
|
+
- 🚀 [Semantic Release](https://semantic-release.gitbook.io/semantic-release) para automatizar el versionado y publicación de paquetes.
|
|
17
|
+
|
|
18
|
+
|
|
16
19
|
|
|
17
20
|
## Main Scripts
|
|
18
21
|
|
|
@@ -28,6 +31,38 @@
|
|
|
28
31
|
- `pre-commit`: Installs Husky and sets up Git hooks for pre-commit validation.
|
|
29
32
|
- `build-storybook`: Builds the static Storybook project.
|
|
30
33
|
|
|
34
|
+
### ✅ Commit Linting con Husky
|
|
35
|
+
Este proyecto utiliza commitlint junto con husky para asegurar que todos los mensajes de commit sigan el [formato convencional](https://www.conventionalcommits.org/en/v1.0.0/).
|
|
36
|
+
|
|
37
|
+
#### ¿Por qué?
|
|
38
|
+
El formato convencional de commits permite:
|
|
39
|
+
|
|
40
|
+
- Generar changelogs automáticamente.
|
|
41
|
+
- Clasificar los cambios en versiones (patch, minor, major).
|
|
42
|
+
- Tener un historial de commits más claro y estructurado.
|
|
43
|
+
|
|
44
|
+
#### 🛠️ Instalación y configuración
|
|
45
|
+
Ya está todo configurado en el proyecto. Si estás trabajando localmente, asegurate de ejecutar lo siguiente luego de clonar e instalar dependencias:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
bun install
|
|
49
|
+
npx husky install
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Esto se asegura de que los hooks de Git estén correctamente instalados.
|
|
53
|
+
|
|
54
|
+
#### ⚙️ Archivos relevantes
|
|
55
|
+
- `.husky/commit-msg`: hook que ejecuta commitlint antes de hacer un commit.
|
|
56
|
+
- `commitlint.config.js`: define las reglas que deben cumplir los mensajes de commit.
|
|
57
|
+
- `.husky/pre-commit`: (opcional) puede correr linters u otros chequeos automáticos.
|
|
58
|
+
|
|
59
|
+
📝 Ejemplo de mensaje de commit válido
|
|
60
|
+
```sh
|
|
61
|
+
feat: agrega componente de botón primario
|
|
62
|
+
fix(ci): corrige configuración de release en rama test
|
|
63
|
+
chore(deps): actualiza dependencias de desarrollo
|
|
64
|
+
```
|
|
65
|
+
|
|
31
66
|
### Setting up `@producteca/producteca-ui-kit`
|
|
32
67
|
|
|
33
68
|
Follow these steps to integrate and configure the `@producteca/producteca-ui-kit` package in your project:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@producteca/producteca-ui-kit",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0-alpha.1",
|
|
4
4
|
"main": "./dist/producteca-ui-kit.umd.js",
|
|
5
5
|
"types": "./dist/index.d.ts",
|
|
6
6
|
"repository": {
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
41
|
"@chromatic-com/storybook": "^1.3.3",
|
|
42
|
+
"@producteca/releaseteca": "^1.2.0",
|
|
42
43
|
"@storybook/addon-actions": "^8.1.6",
|
|
43
44
|
"@storybook/addon-designs": "^8.0.0",
|
|
44
45
|
"@storybook/addon-essentials": "^8.0.9",
|
|
@@ -78,12 +79,6 @@
|
|
|
78
79
|
"devDependencies": {
|
|
79
80
|
"@commitlint/cli": "^19.8.1",
|
|
80
81
|
"@commitlint/config-conventional": "^19.8.1",
|
|
81
|
-
"@semantic-release/changelog": "^6.0.3",
|
|
82
|
-
"@semantic-release/commit-analyzer": "^13.0.1",
|
|
83
|
-
"@semantic-release/exec": "^7.0.3",
|
|
84
|
-
"@semantic-release/git": "^10.0.1",
|
|
85
|
-
"@semantic-release/github": "^11.0.1",
|
|
86
|
-
"@semantic-release/release-notes-generator": "^14.0.3",
|
|
87
82
|
"autoprefixer": "^10.4.19",
|
|
88
83
|
"chromatic": "^11.3.0",
|
|
89
84
|
"clsx": "^2.1.1",
|
|
@@ -105,5 +100,9 @@
|
|
|
105
100
|
"@emotion/styled": "^11.14.0",
|
|
106
101
|
"@mui/icons-material": "^6.4.0",
|
|
107
102
|
"@mui/material": "^6.4.0"
|
|
108
|
-
}
|
|
103
|
+
},
|
|
104
|
+
"trustedDependencies": [
|
|
105
|
+
"@parcel/watcher",
|
|
106
|
+
"@swc/core"
|
|
107
|
+
]
|
|
109
108
|
}
|