docs: update GRAPHILE.md with plugin architecture and current state#817
Merged
pyramation merged 2 commits intomainfrom Mar 15, 2026
Merged
docs: update GRAPHILE.md with plugin architecture and current state#817pyramation merged 2 commits intomainfrom
pyramation merged 2 commits intomainfrom
Conversation
Comprehensive documentation of the PostGraphile v5 plugin ecosystem: - Active packages with usage examples and key features - Legacy directories and what replaced them - How satellite plugins register filter operators - Key design decisions (condition disabled, unified search, etc.) - Testing matrix with commands and coverage areas - ConstructivePreset composition tree
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Updates the existing root-level GRAPHILE.md to include: - Plugin architecture overview with ConstructivePreset composition tree - Active package descriptions with usage examples - Legacy directory inventory - Declarative operator factory API docs - Key design decisions - Testing matrix - Updated package list (unified graphile-search, removed old separate plugins) - Removed postgraphile-plugin-connection-filter from pinned versions (replaced by v5-native)
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: update GRAPHILE.md with plugin architecture and current state
Summary
Updates the existing root-level
GRAPHILE.md(previously just RC dependency management docs) into a comprehensive reference for the PostGraphile v5 plugin ecosystem. This captures the architectural state after the recent v5 migration work (PRs #797–#815).New sections added:
graphile/directories are npm-installed v4 packages vs maintained sourceExisting content updated:
graphile-search, addedgraphile-postgis,graphile-misc-plugins, etc.)postgraphile-plugin-connection-filterfrom pinned versions table (replaced by v5-nativegraphile-connection-filter)No code changes — documentation only.
Updates since last revision
graphile/GRAPHILE.mdback to rootGRAPHILE.mdto update the existing file rather than creating a duplicateReview & Testing Checklist for Human
import { ConstructivePreset } from 'graphile-settings/presets'— confirm this is the actual public import path used by consumers (the preset source file importsmakePgServicefrompostgraphile/adaptors/pg, not fromgraphile-settings).whereas the filter argument name — verify this matches what the GraphQL schema actually exposes after the recentfilter→whererename work.graphile-searchsection describes the{column}{Algorithm}{Metric}pattern (e.g.bodyBm25Score,titleTrgmSimilarity) — verify against actual generated schema output.package.jsonfiles after the v5 migration work.Notes
No functional testing needed — this is a markdown-only change with no code impact. CI passing confirms no build regressions.
Requested by: @pyramation
Link to Devin Session