docs(epic-14): reconcile architecture + roadmap for E14B (text-filter commands) - #55
Merged
Merged
Conversation
PR #54 shipped Slices 1-4 (contribution SPI, TOCContribution, Preview/ Export integration) with a 10-finding remediation not anticipated when epic-14-implementation.md was first drafted. Adds an as-built note pointing §6.6/§7.1/§16's now-stale merged(...)/exportContributions( from:) references to §19's authoritative final shape, and marks Slices 1-4 done / Slices 5-8 (text filters) not started in the slice headers. Slices 5-8 themselves are unchanged — they already specify command discovery, a typed command model, structured (no-shell) process execution, explicit working directory/environment, timeout + cancellation, bounded stdout/stderr, fail-closed error handling that preserves the original selection, one undoable editor mutation, Commands-menu + palette integration with built-in/user-installed visual distinction, and the post-1.0 extension-API design doc — this is the exact, still-current scope for the next PR ("E14B"). Also updates planning/epics/README.md's E14 row from "open" to reflect the partial shipment (E13's row was already corrected on the epic/14 branch and is unaffected here). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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
1 participant
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.
What this changes
Prepares the next PR for issue #15 (E14's remaining scope): user local text-filter commands + command-palette integration ("E14B"). This PR is documentation-only — it reconciles
planning/epic-14-implementation.mdagainst what PR #54 actually shipped, and updatesplanning/epics/README.md's E14 row. No production code changes.Why
PR #54 shipped E14's first half (contribution SPI,
TOCContribution, Preview/Export integration) with a 10-finding adversarial-review remediation that changed the Preview/Export adapter shapes from whatepic-14-implementation.mdoriginally specified (§6.6/§7.1). Perplanning/epics/README.md's own working rule — "Older architecture work is not automatically binding after its product/release contract changes; it must be refreshed before implementation" — the text-filter half's architecture (§6.5, §7.2, §9, §10, §11, §14, §16, Slices 5-8) needs this baseline confirmed accurate before anyone starts implementing it.How it works
planning/epics/README.md's E02/E03 note) pointing §6.6/§7.1/§16's now-stalePreviewContributionAdapter.merged(...)/ExportContributionAdapter.exportContributions(from:)references to §19 (added by EPIC-14: Extension points — first-party contributions + text filters #54), which records the actual finalcompose(...)/adapt(...)shapes.~/Library/Application Support/MacDown 2/Commands; a typedTextFilterCommand(not arbitrary shell snippets); structuredProcesslaunch witharguments: [](stdin only, never shell interpolation); an explicit, bounded working directory and environment (§10); a hard timeout + cooperative cancellation; bounded stdout/stderr with a documented byte cap; aTextFilterErrorcase per failure mode (launch/non-zero/timeout/cancel/oversize), every one of which preserves the original selection; a single undoable editor mutation on success only, reusing the existingapplyAssistOutcomeidiom; Commands-menu + command-palette integration with discovered commands visibly distinguished from built-in app commands (§10); a full failure-mode test matrix (§9/§14) plus an end-to-end uppercase-selection journey (J4); and the post-1.0 JavaScriptCore extension-API design document (Slice 8) issue [EPIC-14] Extension points: first-party contribution seam + user text-filter commands #15 promises.planning/epics/README.md's E14 row fromopento reflect the partial shipment, naming what's done and what's deferred.Out of scope
Implementing Slices 5-8 themselves — this PR is the architecture-reconciliation step before that work starts, matching this repo's established pattern of a dedicated architecture pass before implementation begins.
Verification
Documentation-only change; no build/test impact. Reviewed by re-reading §6.5/§7.2/§9/§10/§11/§14/§16/§17 (Slices 5-8) against issue #15's live scope and confirming no further architecture changes are needed before implementation begins.
Links
planning/epic-14-implementation.md§19 (final shipped shape), Slices 5-8 (this PR's confirmed scope)🤖 Generated with Claude Code