Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .atl/.skill-registry.cache.json

This file was deleted.

58 changes: 0 additions & 58 deletions .atl/skill-registry.md

This file was deleted.

79 changes: 79 additions & 0 deletions .claude/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# CLAUDE.md — ui-kit (librería de componentes eClass)

Librería `@eclass/ui-kit` en React + TypeScript + Chakra UI 1.8, publicada en npm y consumida
por los fronts de eClass (por ejemplo v8, en React 16.14). Incluye un sitio de documentación
en `src/documentation`. Todo en español: código comentado, JSDoc, títulos de pruebas y commits.
El detalle del proyecto está en `.claude/rules/` (algunas reglas se cargan solo al tocar ciertas
carpetas).

Antes de cualquier comando: Node 24.22.0 (`.nvmrc`) y npm 11.13.0. Ver `.claude/rules/commands.md`.

## 1. Piensa antes de codificar

**No asumas. No ocultes la confusión. Expón las compensaciones.**

- Declara tus suposiciones. Si tienes dudas, pregunta.
- Si hay varias interpretaciones, preséntalas; no elijas en silencio.
- Si existe un enfoque más simple, dilo.
- Lo que hoy se ve en el componente es la especificación: no "alinees" un componente con otro sin confirmar.

## 2. Simplicidad primero

**El código mínimo que resuelve el problema. Nada especulativo.**

- Sin características ni "flexibilidad" que no se pidieron.
- Sin abstracciones para código de un solo uso.
- Sin manejo de errores para escenarios imposibles.
- Pregúntate: "¿un ingeniero senior diría que esto está sobre-complicado?". Si es sí, simplifica.

## 3. Cambios quirúrgicos

**Toca solo lo que debes. Limpia solo tu propio desorden.**

- No "mejores" código, comentarios ni formato vecinos; respeta el estilo existente.
- No refactorices lo que no está roto. Si ves código muerto ajeno, menciónalo, no lo borres.
- Elimina solo los imports/variables/funciones que TUS cambios dejaron sin uso.
- Cada línea cambiada debe rastrearse a la solicitud del usuario.
- No cambies la API pública (exports de `src/index.ts`, props existentes) sin avisar: los
consumidores se rompen. Ver `.claude/rules/conventions.md`.
- Mejoras grandes: de a una funcionalidad, sin commitear, para que el usuario revise cada paso.
- Nunca hagas squash ni amend de tus cambios sobre commits existentes del usuario.

## 4. Ejecución dirigida por objetivos

**Define criterios de éxito. Itera hasta verificar.**

- "Agregar validación" → escribir pruebas para entradas inválidas y hacerlas pasar.
- "Arreglar el bug" → escribir una prueba que lo reproduzca y hacerla pasar.
- "Refactorizar X" → las pruebas pasan antes y después.
- Para tareas de varios pasos, declara un plan breve: `1. [Paso] → verificar: [comprobación]`.

## 5. Auto-mejora continua

Cuando el usuario corrija un enfoque, un error o una suposición:
- Antes de cerrar el tema, pregunta: "¿Agrego esto a CLAUDE.md para no repetir el error?".
- Si acepta, agrega la regla en "Reglas añadidas" (o en el archivo de `.claude/rules/` que
corresponda si es de una carpeta o tema).
- Si una regla quedó obsoleta, elimínala en vez de acumular.

## 6. Flujo de trabajo

Clasifica cada pedido antes de editar:

- **Tarea chica** (se entiende completa y se podría retomar solo mirando el diff): implementar
directo.
- **Tarea grande** (varias partes, decisiones abiertas o no se podría retomar desde el diff):
1. Entrar en modo plan: explorar, preguntar lo que no esté claro y proponer el plan.
2. Con el plan aprobado, crear `odd/tasks/<feature>.md` (ignorado por git) con objetivo,
alcance, checklist, criterios de aceptación y progreso. Mantenerlo al día en cada paso.
3. Implementar de a un paso, deteniéndose para que el usuario revise.
- **Todo componente o funcionalidad nueva** lleva sus pruebas y la actualización de su página
en `src/documentation` en el mismo cambio.
- **Al terminar y validar a mano**: el usuario corre `/revisar-desarrollo`, que ajusta la
profundidad de la revisión según el riesgo.
- Al retomar una tarea grande, leer primero su `odd/tasks/<feature>.md`.

## 7. Reglas añadidas

- Pedir "juntar los commits" significa solo hacer squash de los commits del usuario; los cambios
propios quedan aparte para revisión.
42 changes: 42 additions & 0 deletions .claude/rules/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Arquitectura

## Carpetas

- `src/atoms/`, `src/molecules/`, `src/organisms/`: componentes de la librería según diseño
atómico. Una carpeta por componente (`Label/Label.tsx`); los organismos grandes agrupan dentro
`components/`, `utils/`, `services/` y `types.d.ts` (ver `organisms/CourseList`).
- Cada nivel tiene su barrel `index.ts` (`src/atoms/index.ts`, ...).
- `src/theme/`: tema de Chakra (`extendTheme` con `colors`, `typography`, `utils`, `styles`) y
`vars()`, que devuelve la variable CSS de Chakra (`vars('colors-main-deepSkyBlue')` →
`var(--chakra-colors-main-deepSkyBlue)`). Los colores siguen el sistema de diseño.
- `src/services/`: utilidades sin UI (`uniqueId`).
- `src/test/jest-setup.ts`: configuración global de Jest (ver `.claude/rules/testing/testing.md`).
- `src/documentation/`: sitio de documentación (ver `.claude/rules/documentation/documentation.md`).
- `src/Playground.tsx`: página vacía para probar componentes en local; no se publica.
- `src/main.tsx`: entrada de Vite. Con `VITE_REACT_DEPLOY_DOCUMENTATION=DOCUMENTATION` (en `.env`)
monta la documentación o el Playground; si no, solo importa `src/index.ts`.

## Imports

- Alias de `tsconfig.json`: `@/*` → `src/*`, `@atoms`, `@molecules`, `@organisms`, `@theme`,
`@theme/*`, `@icons` (→ `src/atoms/Icons`). En el código existente conviven alias y rutas
relativas; respetar lo que use el archivo.
- `typescript-transform-paths` reescribe los alias en los `.d.ts` generados.

## API pública

- `src/index.ts` es la entrada de la librería: lo que no se exporta ahí no existe para el
consumidor.
- Componente nuevo: exportarlo en el barrel de su nivel **y** en `src/index.ts`, en la sección
de su nivel (Átomos, Moléculas, Organismos). Exportar también sus tipos de props si el
consumidor los necesita (`export type { ... }`).
- Quitar o renombrar un export, o una prop, o cambiar su tipo o comportamiento por defecto, es un
cambio incompatible (ver `.claude/rules/git-workflow.md`).

## Build

- `npm run build`: `tsc` + `vite build` en modo librería (`dist/eclass-ui-kit.es.js` y `.umd.js`)
+ tipos (`tsconfig.types.json`) + copia de los `.d.ts` de `src`.
- `react`, `react-dom`, `@chakra-ui/react`, `@emotion/*` y `framer-motion` son `external`:
no se empaquetan, los pone el consumidor. Cualquier otra dependencia nueva sí entra al bundle
de todos los consumidores: evaluar su peso antes de agregarla.
38 changes: 38 additions & 0 deletions .claude/rules/commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Comandos

## Entorno

- Node 24.22.0 (`.nvmrc`) y npm 11.13.0 (`packageManager`), los mismos que usa CI.
- Instalar con `npm ci` (CI no regenera el lockfile). Requiere acceso SSH a gitlab.com por los
paquetes de tipos `@types/eclass__*`.

## Desarrollo

```bash
npm run dev # Playground (src/Playground.tsx) para probar componentes en local
npm run docu # sitio de documentación en local
npm run build # build de la librería en dist/ (lo corre CI al publicar)
```

- `npm run storybook`, que menciona el README, no existe.

## Tests

```bash
npx jest <rutas de .test.tsx>
```

- `npm run test` corre la suite completa con coverage: en local no usarlo, ni
`--findRelatedTests`, porque es muy pesado para el equipo de desarrollo. La suite completa corre
en CI (GitHub Actions).
- En local, correr solo los `.test.ts(x)` de los archivos tocados, pasando sus rutas, y solo
cuando la tarea lo requiera.

## Formato, lint y tipos

- Revisar solo los archivos tocados:
`npx prettier --write <archivos>` y `npx eslint <archivos>`.
- `npm run lint` formatea y corrige todo `src` (prettier + `eslint --fix`); `npm run lint:check`
revisa todo `src` sin corregir (es lo que corre CI).
- Tipos: `npm run ts-compile-check` (`tsc` de todo el proyecto). Lo corre el pre-commit de husky,
así que un error de tipos bloquea el commit.
Loading
Loading