Files
quasar/AGENTS.md
Benito Rodríguez 0c9c408564
Some checks failed
CI / lint (push) Failing after 1m4s
CI / test-backend (push) Has been skipped
CI / test-frontend (push) Has been skipped
CI / test-e2e (push) Has been skipped
Refactor code structure for improved readability and maintainability
2026-02-22 18:18:46 +01:00

3.3 KiB

Instrucciones para GitHub Copilot 🔧

Resumen breve Quasar es una aplicación web para gestionar una biblioteca personal de videojuegos. Este repositorio está en estado inicial: contiene package.json y README.md pero no hay código fuente ni tests aún. Prioridad: configurar pruebas (Playwright), scripts útiles y prácticas de seguridad para manejar claves/API.

Importante: Este proyecto usa Yarn (no npm). Usa yarn para instalar dependencias y ejecutar scripts.

Estilo de código

  • Mantener CommonJS (type: commonjs en package.json).
  • Añadir ESLint + Prettier para consistencia (recomendado si se añade código).

Build y Test 🧪

  • Instalación: yarn install (usar Yarn/local; packageManager se indica en package.json).
  • package.json actual tiene un test placeholder. Reemplazar por un runner real tras inicializar Playwright. (recomendado)
  • Inicializar Playwright: npx playwright test --init. (recomendado)
  • Instalar dependencias de navegadores: yarn test:install (sugerido script abajo).
  • En CI: yarn install && yarn test:install && yarn test.

Convenciones 🔁

  • Código fuente: src/ (recomendado).
  • Tests: tests/*.spec.(js|ts) (recomendado).
  • Preferir tests reproducibles y ejemplo básico al iniciar el proyecto. (recomendado)

Puntos de integración 🔗

  • README.md menciona fuentes de metadatos: IGDB, Screenscraper, MobyGames. Documentar qué APIs se usarán y dónde se guardan claves. (recomendado)
  • Guardar tokens en variables de entorno y no en el repositorio.

Seguridad 🔒

  • .gitignore ya incluye .envno commitear archivos con secretos.
  • Usar GitHub Secrets para credenciales en workflows. (recomendado)

Scripts sugeridos para package.json (ejemplo)

"scripts": {
  "test": "playwright test",
  "test:install": "playwright install --with-deps",
  "test:ci": "playwright test --reporter=github",
  "lint": "eslint . --ext .js,.ts",
  "format": "prettier --write .",
  "start": "node src/index.js"
}

Nota: el test actual es echo "Error: no test specified" && exit 1. Reemplazarlo por playwright test tras inicializar tests. (recomendado)

Pasos rápidos iniciales ▶️

  1. yarn install
  2. node -v (asegurar Node >= 18)
  3. npx playwright test --init
  4. yarn test:install
  5. yarn test (validar que al menos un test ejemplo pase)

Estado actual (modificaciones aplicadas)

  • Añadidos: .eslintrc.cjs, .prettierrc, tsconfig.json, .eslintignore, .prettierignore.
  • Inicializado Playwright: playwright.config.ts y tests/example.spec.ts (TypeScript).
  • Actualizados: package.json — scripts (test, test:install, lint, format, start) y packageManager (ahora yarn@4.12.0).
  • Dependencias dev instaladas con Yarn: ESLint, Prettier, TypeScript, @typescript-eslint/* y Playwright.
  • Resultado: yarn test pasó (3 tests) en Chromium, Firefox y WebKit.

¿Feedback rápido? Si quieres, puedo:

  • Scaffold inicial (crear src/, tests/example.spec.js, actualizar package.json con scripts).
  • Añadir ESLint + Prettier y sus scripts.
  • Proponer un workflow de GitHub Actions para ejecutar tests en PRs.

Por favor indica si prefieres JavaScript o TypeScript para el scaffold (recomendado: JavaScript si no quieres migrar a TS ahora).