Base Package

packages/01-base-package/README.md

@repo/01-base-package

Plantilla base para crear nuevos packages reutilizables dentro del monorepo.

1. Que resuelve

Este package define una estructura minima estandar:

  • TypeScript configurado con @repo/tsconfig
  • ESLint compartido con @repo/eslint
  • Scripts base de lint, build y check-types
  • Punto de entrada en src/index.ts

2. Estructura recomendada

txt
01-base-package/
├── package.json
├── tsconfig.json
├── src/
│   └── index.ts
└── README.md

3. Lineamientos de desarrollo

  1. Definir API publica en src/index.ts.
  2. Evitar exportar archivos internos directamente.
  3. Mantener compatibilidad hacia atras cuando el package ya se consume.
  4. Agregar ejemplos de uso en README al crear nuevos exports.

4. Como usarlo para crear un package nuevo

bash
cp -r packages/01-base-package packages/mi-package

Luego:

  1. Cambiar nombre en package.json a @repo/mi-package.
  2. Implementar codigo en src/.
  3. Ajustar exports segun modulos publicos.

5. Contribucion y validacion

bash
pnpm lint --filter @repo/01-base-package
pnpm build --filter @repo/01-base-package
pnpm check-types --filter @repo/01-base-package

6. Buenas practicas

  • API chica y coherente.
  • Tipos explicitos para todos los contratos.
  • README actualizado por cada cambio de API.