Enhance documentation and refactor agent handling and interfaces#27
Merged
Conversation
…n `AGENTS.md` and `CLAUDE.md`.
…unused methods in `ModInterface` and `QueryHelperTrait`.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Docs & agents update, list-view cleanup,
AsFilterInvokerdeprecationSummary
Documentation-focused PR with a few small API cleanups. Adds comprehensive AI-agent guidance via
AGENTS.md(withCLAUDE.mdas a symlink), refactors the list-only Twig template to use the engine's view API, deprecates#[AsFilterInvoker], and removes unused methods fromModInterfaceandQueryHelperTrait.Changes
Documentation
AGENTS.md— substantially expanded guidance for AI coding agents:ListSpecification,Loader,Mods; clarifies that Contexts and Projectors/Views are separate axes and that the Export context/projector/view are not yet implemented)src/Specification/,src/Filter*/,src/Form/,src/Reader/,src/InferPtable/,src/Integration/,src/EventListener/NamedDispatch/)#[AsListCallback]and the@internalAsFlareCallbackbase attributeFilterCollectorRegistry,FlareCallbackRegistry,EngineModRegistryadded)make phpstan-pro,make semgrep-sec; note that Mago runs in CI only) and updated PHPStan excludes^7.0CLAUDE.md— added as a symlink toAGENTS.mdso Claude Code picks up the same instructions (editAGENTS.mdonly)List handling / templates
list_only.html.twig— now creates the view explicitly via{% set flare_list = flare.createView %}and iteratesflare_list.entriesinstead offlare.entriesDeprecations & API cleanup
#[AsFilterInvoker]— deprecated; filter invocation should be defined via the filter element's__invokemethod instead. Removal planned for v0.2.Engine::addMod()—$configparameter now defaults to[]ModInterface— removed the unusedconfigureOptions(OptionsResolver $resolver)method (and the OptionsResolver dependency from the interface)QueryHelperTrait— removed the unusedcolumn()helperBreaking changes
ModInterface::configureOptions()breaks custom engine mods that implement it (mods should drop the method).flare.entriesinlist_only.html.twigfollow a new pattern; custom templates are unaffected but should adoptflare.createViewgoing forward.Notes