@carlesandres/house 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-All notable changes to house (renamed from `openmdr` in 0.3.0) land here. Format follows
+All notable changes to house land here. Format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project
 follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) from
 v0.1.0 onward.
@@ -12,6 +12,57 @@ file is the curated, narrative version.
 
 ## [Unreleased]
 
+## [0.4.0] — 2026-05-21
+
+### Added
+
+- Command palette v1: `ctrl+p` opens a modal palette with visible browser
+  commands derived from the keymap, including quit, sidebar toggle, help,
+  filter, open-in-browser, and theme controls.
+- Palette search uses a small tiered scorer so empty queries stay in keymap
+  order while typed queries rank stronger title and word-boundary matches.
+
+### Fixed
+
+- Reader scroll focus is suspended while overlays are open, preventing palette
+  arrow navigation from scrolling the markdown pane behind the modal.
+
+### Tests
+
+- Added command-palette interaction coverage plus scroll regression checks.
+
+## [0.3.1] — 2026-05-17
+
+Beta release gates (DESIGN §10.2) closed.
+
+### Fixed
+
+- Language-tagged fenced code blocks no longer disappear while markdown
+  highlighting settles. `house` now uses opentui `0.2.12`, which includes
+  markdown/code-block rendering fixes, and the browser pane no longer
+  remounts markdown for one file while still holding another file's loaded
+  content.
+- Strikethrough text (`~~strike~~`) now renders distinctly (dim + muted
+  foreground) instead of as plain body text. opentui's syntax-style API
+  has no true strikethrough attribute; this is the closest visual we can
+  produce, documented in DESIGN §5.1.
+
+### Changed
+
+- Reduced re-renders and allocations in `Browser` / `Footer` hot paths.
+- DESIGN §10.2 test gate rephrased to target the integration surface
+  house owns (the tree-sitter scope map) rather than re-testing opentui's
+  renderer; `test/theme-syntax-map.test.ts` enforces scope coverage for
+  every node type §5.1.3 promises.
+
+### Docs
+
+- README embeds a VHS-generated demo gif; `tape/` holds the source
+  scripts.
+- `CONTRIBUTING.md` documents the `captureSpans()` / `MockTreeSitterClient`
+  / `TestRecorder` testing patterns and the "before blaming `<markdown>`"
+  stale-watcher debugging checklist.
+
 ## [0.3.0] — 2026-05-16
 
 ### Changed
@@ -172,7 +223,9 @@ auto-detect, single-binary distribution (issue
 [#2](https://github.com/carlesandres/openmdr/issues/2)),
 Homebrew tap. All tracked.
 
-[Unreleased]: https://github.com/carlesandres/house/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/carlesandres/house/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/carlesandres/house/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/carlesandres/house/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/carlesandres/house/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/carlesandres/house/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/carlesandres/house/compare/v0.1.0...v0.2.0

package/README.md

@@ -1,15 +1,9 @@
 # house
 
-> **Renamed from `openmdr`.** The old npm package `@carlesandres/openmdr`
-> is deprecated; install `@carlesandres/house` instead. The CLI binary is
-> now `house` (was `openmdr`).
-
-A terminal markdown reader built on [opentui](https://github.com/nicholasgasior/opentui).
+A terminal markdown reader built on [opentui](https://github.com/anomalyco/opentui).
 Point it at a directory and navigate its `.md` files without leaving the terminal.
 
-```
-npx @carlesandres/house docs/
-```
+![house demo](tape/house.gif)
 
 Requires [Bun](https://bun.sh) on `PATH`.
 
@@ -43,6 +37,34 @@ house [options] <path>
 |------|---------|-------------|
 | `--theme <name>` | `opencode` | Starting theme (see list below) |
 | `--tone dark\|light` | `dark` | Starting tone |
+| `--config-path` | — | Print the resolved config-file path and exit |
+
+## Configuration
+
+house reads optional defaults from a TOML file:
+
+```
+$XDG_CONFIG_HOME/house/config.toml   (defaults to ~/.config/house/config.toml)
+```
+
+Run `house --config-path` to print the exact location.
+
+```toml
+# ~/.config/house/config.toml
+theme = "tokyonight"
+tone  = "dark"
+```
+
+Precedence, highest to lowest:
+
+1. CLI flags (`--theme`, `--tone`)
+2. Env vars (`HOUSE_THEME`, `HOUSE_TONE`)
+3. Config file
+4. Built-in defaults (`opencode` / `dark`)
+
+The file is optional — a missing file is fine. Invalid keys, unknown themes,
+or malformed TOML fail loudly with a one-line error. Per-project config
+(`.house/config.toml`) and additional keys are deferred.
 
 ## Keys
 
@@ -52,8 +74,9 @@ house [options] <path>
 |-----|--------|
 | `q` / `ctrl+c` | Quit |
 | `tab` | Toggle focus (sidebar ↔ reader) |
-| `\` | Toggle sidebar visibility |
+| `s` | Toggle sidebar visibility |
 | `?` | Show / dismiss help overlay |
+| `o` | Open current file in browser as HTML |
 | `t` | Next theme |
 | `T` | Previous theme |
 | `L` | Toggle dark / light tone |
@@ -64,12 +87,13 @@ house [options] <path>
 |-----|--------|
 | `j` / `↓` | Move selection down |
 | `k` / `↑` | Move selection up |
-| `J` | Jump down 10 |
-| `K` | Jump up 10 |
-| `space` / `ctrl+d` | Page down |
-| `b` / `ctrl+u` | Page up |
+| `J` | Jump down 8 |
+| `K` | Jump up 8 |
+| `space` / `pagedown` / `ctrl+d` | Page down |
+| `b` / `pageup` / `ctrl+u` | Page up |
 | `g` | First file |
 | `G` | Last file |
+| `/` | Filter files (fuzzy match on path) |
 | `↵` / `→` / `l` | Open file (focus reader) |
 
 ### Reader
@@ -94,6 +118,12 @@ house [options] <path>
 
 Each theme supports dark and light tones. Cycle with `t` / `T`; toggle tone with `L`.
 
+## Inspiration
+
+- [glow](https://github.com/charmbracelet/glow) — render markdown on the CLI, with pizzazz
+- [ghui](https://github.com/kitlangton/ghui) — keyboard-driven terminal UI for GitHub pull requests
+- [hunk](https://github.com/modem-dev/hunk) — review-first terminal diff viewer for agent-authored changesets
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@carlesandres/house",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"description": "TUI-first markdown reader on opentui",
 	"type": "module",
 	"license": "MIT",
@@ -44,12 +44,14 @@
 		"format": "oxfmt src/",
 		"format:check": "oxfmt --check src/",
 		"test": "bun test",
-		"build:themes": "bun run dev/build-themes.ts"
+		"build:themes": "bun run dev/build-themes.ts",
+		"repro:pty-codeblocks": "bun run dev/repro-pty-codeblocks.ts",
+		"prepare": "git config core.hooksPath .githooks 2>/dev/null || true"
 	},
 	"dependencies": {
 		"@effect/atom-react": "4.0.0-beta.59",
-		"@opentui/core": "0.2.1",
-		"@opentui/react": "0.2.1",
+		"@opentui/core": "0.2.12",
+		"@opentui/react": "0.2.12",
 		"effect": "4.0.0-beta.59",
 		"ignore": "^7.0.5",
 		"marked": "^18.0.3",