carconnect-gatherleads-ui-lib 1.0.0 → 1.0.2

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.
Files changed (3) hide show
  1. package/README.md +59 -67
  2. package/package.json +4 -10
  3. package/dist/carconnect-gatherleads-ui-lib-1.0.0.tgz +0 -0
package/README.md CHANGED
@@ -1,69 +1,61 @@
1
- # React + TypeScript + Vite
2
-
3
- This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4
-
5
- Currently, two official plugins are available:
6
-
7
- - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
8
- - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9
-
10
- ## Expanding the ESLint configuration
11
-
12
- If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
13
-
14
- ```js
15
- export default tseslint.config([
16
- globalIgnores(['dist']),
17
- {
18
- files: ['**/*.{ts,tsx}'],
19
- extends: [
20
- // Other configs...
21
-
22
- // Remove tseslint.configs.recommended and replace with this
23
- ...tseslint.configs.recommendedTypeChecked,
24
- // Alternatively, use this for stricter rules
25
- ...tseslint.configs.strictTypeChecked,
26
- // Optionally, add this for stylistic rules
27
- ...tseslint.configs.stylisticTypeChecked,
28
-
29
- // Other configs...
30
- ],
31
- languageOptions: {
32
- parserOptions: {
33
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
34
- tsconfigRootDir: import.meta.dirname,
35
- },
36
- // other options...
37
- },
38
- },
39
- ]);
40
- ```
1
+ # carconnect-gatherleads-ui-lib
2
+
3
+ `carconnect-gatherleads-ui-lib` es una librería de componentes UI desarrollada para **CarConnect**, construida con **React**, **Tailwind v4** y **shadcn/ui**. Permite reutilizar componentes consistentes en distintas aplicaciones del ecosistema CarConnect.
4
+
5
+ ---
6
+
7
+ ## Gestión de Versiones con Semantic Release
8
+
9
+ La librería utiliza **Semantic Release** para automatizar el versionado y el registro de cambios.
10
+ El versionado sigue **SemVer (MAJOR.MINOR.PATCH)**, y los commits deben seguir la convención **Conventional Commits**:
11
+
12
+ ### Tipos de commits más comunes
13
+
14
+ - `feat`: Nueva funcionalidad → incrementa **MINOR**
15
+ - `fix`: Corrección de errores → incrementa **PATCH**
16
+ - `chore`: Tareas internas, sin impacto en la API
17
+ - `docs`: Cambios en documentación
18
+ - `refactor`: Refactorización de código
19
+ - `perf`: Mejoras de rendimiento
20
+ - `test`: Añadir o corregir tests
21
+ - `BREAKING CHANGE`: Cambios incompatibles → incrementa **MAJOR**
22
+
23
+ ---
24
+
25
+ ## Gestión de Commits y Versiones
26
+
27
+ La librería utiliza **Commitizen** para automatizar y estandarizar los commits siguiendo la convención **Conventional Commits**.
28
+ Esto permite que **Semantic Release** pueda generar automáticamente la versión correcta y actualizar el `CHANGELOG.md`.
29
+
30
+ ### Script para commits
41
31
 
42
- You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
43
-
44
- ```js
45
- // eslint.config.js
46
- import reactX from 'eslint-plugin-react-x';
47
- import reactDom from 'eslint-plugin-react-dom';
48
-
49
- export default tseslint.config([
50
- globalIgnores(['dist']),
51
- {
52
- files: ['**/*.{ts,tsx}'],
53
- extends: [
54
- // Other configs...
55
- // Enable lint rules for React
56
- reactX.configs['recommended-typescript'],
57
- // Enable lint rules for React DOM
58
- reactDom.configs.recommended,
59
- ],
60
- languageOptions: {
61
- parserOptions: {
62
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
63
- tsconfigRootDir: import.meta.dirname,
64
- },
65
- // other options...
66
- },
67
- },
68
- ]);
32
+ ```bash
33
+ npm run commit
69
34
  ```
35
+
36
+ ---
37
+
38
+ ## Scripts disponibles de desarrollo
39
+
40
+ Levanta Storybook para visualizar los componentes en desarrollo_
41
+ - `npm run storybook`
42
+
43
+ Inicia el entorno de desarrollo de la librería_
44
+ - `npm run dev`
45
+
46
+ Construye la librería para producción_
47
+ - `npm run build`
48
+
49
+ Utiliza Commitizen para generar commits estandarizados.
50
+ - `npm run commit`
51
+
52
+ ---
53
+
54
+ ## Instalación
55
+
56
+ Puedes instalar la librería desde npm:
57
+
58
+ ```bash
59
+ npm install carconnect-gatherleads-ui-lib
60
+ # o con yarn
61
+ yarn add carconnect-gatherleads-ui-lib
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "carconnect-gatherleads-ui-lib",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "type": "module",
5
5
  "files": [
6
6
  "dist"
@@ -25,8 +25,8 @@
25
25
  "format": "prettier --write ."
26
26
  },
27
27
  "peerDependencies": {
28
- "react": "^19.1.1",
29
- "react-dom": "^19.1.1"
28
+ "react": ">=18 <20",
29
+ "react-dom": ">=18 <20"
30
30
  },
31
31
  "devDependencies": {
32
32
  "@eslint/js": "^9.33.0",
@@ -91,13 +91,7 @@
91
91
  "changelogFile": "CHANGELOG.md"
92
92
  }
93
93
  ],
94
- [
95
- "@semantic-release/npm",
96
- {
97
- "npmPublish": true,
98
- "tarballDir": "dist"
99
- }
100
- ],
94
+ "@semantic-release/npm",
101
95
  "@semantic-release/github",
102
96
  [
103
97
  "@semantic-release/git",