mirror of
https://github.com/usetrmnl/trmnl-form-builder.git
synced 2026-04-29 13:43:54 -07:00
Create Agents.MD for LLMs
This commit is contained in:
@@ -0,0 +1,63 @@
|
||||
# AGENTS.md
|
||||
|
||||
## Build/Lint/Test Commands
|
||||
|
||||
### Running Tests
|
||||
- `pnpm test` - Run all tests once
|
||||
- `pnpm run test:watch` - Run tests in watch mode
|
||||
- `pnpm run test:ui` - Run tests with Vitest UI
|
||||
- `pnpm run test:coverage` - Run tests with coverage report
|
||||
- `pnpm test -- --reporter=verbose` - Run single test with verbose output
|
||||
|
||||
### Build Commands
|
||||
- `pnpm run build` - No explicit build command found, project is a single JS file
|
||||
- The main output file is `trmnl-form-builder.js`
|
||||
|
||||
### Linting
|
||||
No explicit linting commands found. Project appears to use standard JavaScript without linter configuration.
|
||||
|
||||
## Code Style Guidelines
|
||||
|
||||
### Imports
|
||||
- Uses ES modules with `import` statements
|
||||
- No specific import ordering requirements identified
|
||||
- Component is registered as a custom element using `customElements.define()`
|
||||
|
||||
### Formatting
|
||||
- Uses standard JavaScript formatting conventions
|
||||
- Indentation appears to be 2 spaces (based on code review)
|
||||
- No specific formatter configured (prettier, eslint, etc.)
|
||||
|
||||
### Types
|
||||
- No explicit type definitions found
|
||||
- Uses vanilla JavaScript without TypeScript
|
||||
- Properties are set directly on elements
|
||||
|
||||
### Naming Conventions
|
||||
- Component name: `trmnl-form-builder`
|
||||
- Method names follow camelCase convention
|
||||
- Property names follow camelCase convention
|
||||
- Constants are uppercase with underscores when appropriate
|
||||
|
||||
### Error Handling
|
||||
- Basic error handling through try/catch blocks where needed
|
||||
- Validation of inputs and edge cases in functions like escapeYaml
|
||||
- No comprehensive error logging or centralized error handling pattern
|
||||
|
||||
### Code Structure
|
||||
- Single JavaScript file implementation
|
||||
- Uses class-based component structure for custom element
|
||||
- Modular approach with separate methods for different functionality
|
||||
- Self-contained component with no external dependencies beyond browser APIs
|
||||
|
||||
### Testing
|
||||
- Unit tests using Vitest framework
|
||||
- Tests cover core functionality like YAML escaping/unescaping
|
||||
- Tests use `describe`, `it`, and `expect` patterns
|
||||
- Tests run in jsdom environment to simulate browser context
|
||||
|
||||
### Additional Notes
|
||||
- Component uses custom element API (`customElements.define`)
|
||||
- Implements shadow DOM for encapsulation
|
||||
- Follows web standards for component development
|
||||
- No build tools or transpilation steps identified
|
||||
Reference in New Issue
Block a user