Document complete Lua API programs - #78
Merged
Merged
Conversation
why: Complete Lua and Ruby programs cite their own source files and carry exact clipboard hashes alongside canonical source bytes. what: - Check each repository and per-file source citation in rendered HTML - Compare copied setup commands and explicit clipboard hashes - Expose Ruby reference routes in the isolated browser test server - Keep the Go fixture test scoped to its own model Validation: independent helper review and focused 53 site tests pass. The required outer attempt passed its completed unit suites but hit its 60-second budget before browser and type checks finished. Standalone checks and the Lua render remain in progress for the complete branch.
why: Valid multiline console commands ending in shell operators copied only their first line, leaving the Lua setup and run recipes incomplete. what: - Continue unquoted AND, OR and pipeline commands across subsequent lines - Keep the operand pending across comments and blank lines - Preserve quoted, escaped, output and existing backslash boundaries - Check the actual Expressive Code clipboard payload Validation: 19 focused tests and focused TypeScript checks pass. A fresh Lua build passes all 44 real copy clicks across 11 API pages, preserving the already executed source recipes. Independent review found no blocker. The required outer attempts hit the unchanged 60-second limit after completed unit suites passed; unfinished checks remain unverified.
why: Core Lua API pages lacked complete programs that a reader could copy and run with visible dependencies, input and cleanup. what: - Import seven opt-in source programs and their full private launcher - Attach them to eleven native connection, listing and operation APIs - Pin the merged and publicly tested source revision 0395620 - Record exact source, clipboard, command and Markdown byte contracts - Preserve existing signatures, identities and other-port fixtures Validation: exact public setup and seven programs pass on tmux 3.2a and 3.7c, with four failure cleanup controls. Source PR13 passed 24 hosted checks before merge. A fresh 836-page Lua build passes 44 real copy clicks, source links and Markdown hashes. Independent final review is clear. Focused 53 site and 11 adapter tests pass. Required outer attempts reached the unchanged 60-second deadline after completed suites passed; unfinished checks and the unrelated standalone browser navigation timeout remain explicit limitations in the PR. Native receipts were not rewritten.
Regenerate the Lua guide cache at the API model source revision so publication preflight reaches the version guards. Preserve the native guide bytes and source README wrapper; staging already strips the wrapper. The native exporter and committed-source comparison agree on all 16 guide files. The six version controls, 31 focused staging and Lua tests, and model/cache freshness checks pass. Independent exact-patch review accepted18788053; prior full outer timing failures remain disclosed.
Retain the responsive signature probe from main and the existing Ruby test routes in the complete API example checker. All Lua model, native program, recipe, source cache and fixture bytes remain identical to the reviewed b88d669 head. Focused validation passes 11 adapter tests and 142 site tests, with 13 assembled-output cases skipped. Lua model, cached guide and mention freshness checks pass. No derived data was regenerated and no full local build was run during the concurrent outer gate.
This branch was successfully deployed
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.
Lua API pages now show complete programs for connection, session/window/pane snapshots, session and window creation, queries, input, and capture. Eleven native API targets receive seven source-owned programs, each with the exact dependency setup, a complete launcher for a private daemon, error handling, cleanup, and pinned source links.
The Lua adapter reads the opt-in manifest and full files from the native artifact at 0395620d362ef75c74cd488f9577afda68922586, which is reachable from merged libtmux/libtmux-lua#13. The 773 existing symbol contracts and ordering are unchanged; the model changes only source provenance and the eleven example arrays. Existing guide example bytes are unchanged at the new revision.
The committed Lua guide cache uses the same 0395620 source revision as the API model. A fresh native export and committed-source comparison verify all 16 full guide files. The source README adds its logo wrapper; staging removes that wrapper, leaving only one additional blank line in the overview besides refreshed citations. This repairs the initial hosted failure: the stale guide cache had stopped publication before the version-slug rejection checks ran. The exact six version controls and 31 focused staging/Lua tests now pass; model and cached-guide freshness checks pass. Independent exact-patch review found no blocker. The initial hosted failure and prior local timing limits remain recorded; the next hosted run will validate the complete publication pipeline.
The console copy classifier also recognizes unquoted trailing
&&,||, and|. The actual Lua page copy check exposed that these valid command continuations had been copied as only the first line. Quote, escape, comment, and output controls preserve the existing session behavior without changing the verified native recipes.Validation: a fresh Lua build emits 836 pages in 34.61 seconds. All 44 actual clipboard clicks on the eleven example pages, all 22 source links, and all Markdown fences match the recorded files and commands. The shared checker also accepts the twenty existing Go and new Lua pages and rejects wrong-citation and corrupted-launcher controls. The focused site/Markdown suite passes 53 tests; adapter tests pass 11 tests; the shell parser passes 19 tests, including a real renderer case. Source proof includes a clean public HTTPS checkout with Git URL rewrites disabled, the displayed Lua 5.5.1/LuaRocks 3.13.0/luv 1.52.1-0 setup, all seven exact program files and launcher on tmux 3.2a and 3.7c (14 successful runs), and four import/runtime failure-and-cleanup controls. All 24 hosted checks passed before source PR13 merged. The native receipt binds full source file hashes and commands; generated-model mapping proves those same bytes on all eleven pages, rather than claiming a new native run of a different model hash.
Source files and Markdown fences retain LF and one final newline. HTML clipboard payloads omit that final newline, and console payloads also omit
$prompts; fixtures record source and clipboard hashes separately.Local timing limits remain explicit: the Lua source medium/outer attempts exceeded an existing five-second tooling-test subprocess limit; both docs outer attempts reached the unchanged 60-second budget after completed unit suites passed. A standalone docs browser attempt reached an unrelated ten-second root-page navigation timeout in the clipboard widget check. No deadline was raised. The full docs type check passed before the isolated shell-parser change, and the final parser TypeScript check passes. The final outer attempt completed 328 API-model, 36 theme, and 1,794 site tests; its unfinished browser and full type checks remain unverified locally. Fresh independent parser, generated-model, HTML, Markdown, and mobile clipboard review found no correctness blocker on the exact final diff.
The generated Lua model SHA-256 is
965fb2fddfd320ac4ebd792a93349b5614776aa94b1b03f8089160b9cfffad73; its code/setup mapping is checked against native receipt SHA-256d918c604660888ae5a4d6abe1b40ba13e90140bed884a1e5dc3d2651a840f3b9. The fixture records each source revision, file hash, clipboard hash, recipe, expected output, and both tested tmux releases.The branch now includes main 9e6cfe3 at integration head 4433c88. The only conflict combined main's responsive signature probe with the complete-example checker's Ruby routes; all 13 Lua/shared example files are byte-identical to the reviewed b88d669 head and no derived data was regenerated. Fresh focused validation passes 11 adapter tests and 142 site tests, with 13 assembled-output tests skipped; model, guide, mention and checker-syntax checks pass. The prior public-preview proof covers b88d669 and remains separate from the required new-head hosted checks and independent integration review. No full local build was repeated during the active outer gate.