Poly-Editor: Instructions file for Codex

AGENTS.md

This file provides coding guidelines and commands for agentic coding assistants working in this repository.

Build & Quality Commands

# Development
npm run dev        # Start dev server on port 8081
npm run debug      # Start dev server with debug mode

# Build
npm run build      # Production build to /main directory
npm run preview    # Preview production build

# Type Checking
npx vue-tsc --noEmit    # TypeScript type checking

# Linting (via Vite plugin)
# ESLint runs automatically via vite-plugin-eslint during dev/build
# Manual linting: npx eslint . --ext .ts,.tsx,.vue

Note: No test framework is currently configured. Add test setup if implementing tests.

Project Overview

• Stack: Vue 3 + TypeScript + Vite
• UI Framework: PrimeVue 4 + Tailwind CSS 4
• State Management: Pinia (composition API style)
• HTTP Client: Axios with custom interceptors
• Node Version: 22.14.0 (managed by Volta)

Code Style Guidelines

Imports

• Use @/ alias for src directory imports (configured in vite.config.ts)
• Named imports preferred: import {ref, computed} from 'vue'
• Vue composition imports: import {onMounted, onUnmounted} from 'vue'
• PrimeVue components are auto-imported via unplugin-vue-components

Formatting (Prettier)

{
  "semi": false, // No semicolons
  "singleQuote": true, // Single quotes
  "tabWidth": 2, // 2-space indentation
  "printWidth": 240, // Long lines allowed
  "arrowParens": "always", // Always wrap arrow function params
  "bracketSpacing": false // No spaces in object literals
}

TypeScript

• Strict mode enabled in tsconfig.json
• Use interface for object shapes, type for unions/primitives
• Generic types with angle brackets: Promise<AxiosResponse<T>>
• Any types allowed with @typescript-eslint/no-explicit-any: 'off'
• Type imports: import type {AxiosResponse} from 'axios'

Naming Conventions

• Components: PascalCase (e.g., EditorComponent, SketchRulerProps)
• Variables/Functions: camelCase (e.g., currentPage, addComponentAction)
• Constants: UPPER_SNAKE_CASE (e.g., EComponentType, defaultSketchRulerWidth)
• Event Emitters: Prefix with on (e.g., onDotMousedown, handleRotateEnd)
• Type definitions: PascalCase with I prefix (e.g., IComponentInfo, IEditorInfo)