-
Notifications
You must be signed in to change notification settings - Fork 5
feat: adding in Agents.md #324
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -110,7 +110,6 @@ yarn.lock | |
| package-lock.json | ||
| site/README.md | ||
| dist-site/ | ||
| pnpm-lock.yaml | ||
|
|
||
| # AI | ||
| .claude | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 22 | ||
| 24 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Agent Guidelines for Ecto | ||
|
|
||
| Ecto is a modern template consolidation engine that provides a unified interface for working with multiple popular template engines (EJS, Markdown, Pug, Nunjucks, Mustache, Handlebars, and Liquid). | ||
|
|
||
| ## Project Overview | ||
|
|
||
| - **Purpose**: Simplify template rendering by providing a single API for multiple template engines with automatic engine selection based on file extensions | ||
| - **Architecture**: TypeScript library with a plugin architecture - `Ecto` coordinates engines, `BaseEngine` provides common functionality, individual engine classes handle specific template formats | ||
| - **Key Dependencies**: `ejs`, `pug`, `nunjucks`, `liquidjs`, `@jaredwray/fumanchu` (Handlebars/Mustache), `writr` (Markdown), `cacheable` (caching), `hookified` (events/hooks) | ||
|
|
||
| ## Development Commands | ||
|
|
||
| - Use `pnpm` instead of `npm` for all package management commands | ||
| - `pnpm build` - Build TypeScript to ESM with type declarations | ||
| - `pnpm test` - Run linting and tests with coverage | ||
| - `pnpm lint` - Run Biome linter with auto-fix | ||
| - `pnpm clean` - Remove dist, coverage, node_modules, and lock files | ||
|
|
||
| ## Code Quality Requirements | ||
|
|
||
| - Always run `pnpm test` to verify tests pass before completing changes | ||
| - All new code must have corresponding tests | ||
| - Follow existing code patterns in `src/ecto.ts` for the main class | ||
| - Use Biome for linting and formatting (configured in the project) | ||
| - TypeScript strict mode is enabled | ||
|
|
||
| ## Project Structure | ||
|
|
||
| - `src/ecto.ts` - Main Ecto class (core engine coordinator) | ||
| - `src/base-engine.ts` - Base class for all engines | ||
| - `src/engine-interface.ts` - TypeScript interface for engine implementations | ||
| - `src/engine-map.ts` - Manages file extension to engine mappings | ||
| - `src/engines/` - Individual engine implementations (ejs, handlebars, liquid, markdown, nunjucks, pug) | ||
| - `test/` - Vitest test files | ||
|
|
||
| ## Engine Mapping | ||
|
|
||
| - `.ejs` → EJS | ||
| - `.md`, `.markdown` → Markdown | ||
| - `.pug`, `.jade` → Pug | ||
| - `.njk` → Nunjucks | ||
| - `.mustache` → Mustache | ||
| - `.handlebars`, `.hbs`, `.hjs` → Handlebars | ||
| - `.liquid` → Liquid | ||
|
|
||
| ## Key Considerations | ||
|
|
||
| - Async and sync rendering methods are available (`render`/`renderSync`, `renderFromFile`/`renderFromFileSync`) | ||
| - FrontMatter support is built-in for Markdown files | ||
| - Caching is available via the `cacheable` library for performance optimization | ||
| - Hooks system allows intercepting and modifying data during rendering | ||
| - Custom engines can be created by implementing the `EngineInterface` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| @AGENTS.md |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.