Poly-Editor AGENTS.md

A repository guide for Poly-Editor, a web application built with Vue, TypeScript, and Vite. It records the commands and coding rules that contributors should follow.

In plain words
What is it for?
Use it when developing Poly-Editor, including starting its development server, creating a production build, checking TypeScript, and running ESLint.
Why use it?
It gives a coding agent the project's expected checks and conventions, reducing avoidable build, type-checking, and style mistakes.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/garlicwu/poly-editor/agents-md
Clone the repo
git clone --depth 1 https://github.com/garlicwu/Poly-Editor

Made for: Codex, OpenCode.

Per session 1,474 This file is loaded in full into every session.
When invoked 1,474 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01474 $0.01474
Opus 5 $0.00737 $0.00737
Sonnet 5 $0.00295 $0.00295
Haiku 4.5 $0.00147 $0.00147

Measured yesterday against content hash 8c29b288d824, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Poly-Editor AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 158 lines

How it starts

The opening of the file, as written. The whole thing — 158 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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)

Read the full file on GitHub · 158 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 158 lines · 1,474 tokens per session scan A 8c29b288d824

Subscribe to this mod's changes

Poly-Editor AGENTS.md is an instructions file published in the GitHub repository garlicwu/Poly-Editor (11 stars, last pushed 5mo ago), licensed MIT. It adds 1,474 tokens to every session, about $0.0074 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

vscode copilot-instructions.md

Instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,494 tokens

vscode design-tokens.instructions.md

Design-system size tokens (spacing, corner radius, font size, codicon size, stroke). Use when writing or editing CSS to size, space, or round UI — prefer the --vscode- token vars over hardcoded px values.

microsoft/vscode · 2,627 tokens

vscode tree-widgets.instructions.md

Use when asked to consume workbench tree widgets in VS Code.

microsoft/vscode · 1,456 tokens

vscode accessibility.instructions.md

Use when implementing accessibility features, ARIA labels, screen reader support, accessible help dialogs, or keybinding scoping for accessibility. Covers AccessibleContentProvider, CONTEXTACCESSIBILITYMODEENABLED, verbosity settings, and announcement patterns.

microsoft/vscode · 611 tokens

vscode source-code-organization.instructions.md

VS Code source code organization — layers, target environments, dependency injection, and folder structure conventions. Reference when adding new modules, services, or contributions.

microsoft/vscode · 662 tokens