1.1.1 • Published 1 year ago

chasis-utils v1.1.1

Weekly downloads
-
License
Karvi™
Repository
-
Last release
1 year ago

React Utility Library

Biblioteca de utilidades de React para proyectos frontend en la empresa.

Comenzando 🚀

Pre-requisitos 📋

  • Node.js > 16.9.0.
  • Ejecutar:

    corepack enable

    Esto habilita el gestor de paquetes pnpm.

Instalación 🔧

  • Clona el repositorio y navega a la carpeta del proyecto:

    git clone <url-del-repositorio>
    cd <nombre-del-repositorio>
  • Crear el archivo .npmrc y ejecutar:

    pnpm install
  • Ahora tenemos los siguientes scripts para construir y probar la biblioteca:

    pnpm build         # Construye la biblioteca
    pnpm dev           # Ejecuta en modo desarrollo
    pnpm lint          # Verifica el estilo del código con ESLint
    pnpm test          # Ejecuta las pruebas
    pnpm test:watch    # Ejecuta las pruebas en modo observación

Estructura 🛠️

src/
├── hooks/            # Hooks personalizados de React
│   ├── useAuth.ts
│   ├── useFetch.ts
│   └── index.ts       # Exportaciones de hooks
├── utils/            # Utilidades generales (funciones helper, etc.)
│   ├── format.ts
│   ├── validators.ts
│   └── index.ts       # Exportaciones de utilidades
├── types/            # Definiciones de tipos y interfaces
│   ├── index.d.ts
│   └── theme.d.ts
├── index.ts          # Archivo principal de exportación de la biblioteca
├── tsconfig.json     # Configuración de TypeScript
└── package.json      # Archivo de configuración del proyecto

Uso 📦

Para usar la biblioteca en tus proyectos, instala el paquete desde el registro privado de la empresa y luego impórtalo en tu aplicación:

pnpm add @karvi-utils


```jsx
import {  formatPrice } from '@karvi-utils';

const priceFormatted = formatPrice(4000)
```