Skip to content

AGENTS.md

Latest commit

 

History

History
26 lines (20 loc) · 1.34 KB

AGENTS.md

File metadata and controls

26 lines (20 loc) · 1.34 KB

Mainsail AI Guidelines

Mainsail is a Vue 2.7 + TypeScript web interface for Klipper 3D printer firmware, using Vuetify 2, Vuex 3, and Vite.

CRITICAL: Use Vue Class Components with decorators (@Component, @Prop, @Watch). Do NOT use Vue 3 <script setup> or Options API syntax.

Commands

  • npm run serve - Dev server (port 8080)
  • npm run build - Production build
  • npm run lint:fix - Fix linting
  • npm run format - Format code
  • npm run test:unit - Unit tests (Vitest)
  • npm run test:ui - E2E tests (Cypress)

Guidelines

Topic File
Project structure & store modules agent_docs/ARCHITECTURE.md
Vue Class Components & TypeScript agent_docs/VUE_TYPESCRIPT.md
Formatting, naming, patterns agent_docs/CODE_STYLE.md
Vuetify, icons, i18n agent_docs/UI_I18N.md
Code review checklist agent_docs/CODE_REVIEW.md
Git workflow & PRs agent_docs/CONTRIBUTING.md