From ca605199753d3b3a1f6dc46ea89391c46ad7b900 Mon Sep 17 00:00:00 2001 From: sedax90 <5001801+sedax90@users.noreply.github.com> Date: Sun, 8 Nov 2026 13:46:59 +0100 Subject: [PATCH 1/7] docs(parity): track each feature across macOS, Linux and Windows --- AGENTS.md | 1 + docs/feature-parity/README.md | 109 +++++++++++++ docs/feature-parity/features.yml | 262 +++++++++++++++++++++++++++++++ scripts/ci/test_parity.py | 90 +++++++++++ scripts/parity/render.py | 162 +++++++++++++++++++ 5 files changed, 624 insertions(+) create mode 100644 docs/feature-parity/README.md create mode 100644 docs/feature-parity/features.yml create mode 100644 scripts/ci/test_parity.py create mode 100644 scripts/parity/render.py diff --git a/AGENTS.md b/AGENTS.md index 587a6f4fb5..82ce91de98 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -9,6 +9,7 @@ Native database clients with a native UI per platform: `apple/` holds the macOS - `core/`: the shared Rust core's crates, its architecture and its cross-platform decisions. `Cargo.toml`, `Cargo.lock`, `rust-toolchain.toml`, `rustfmt.toml`, `clippy.toml`, `deny.toml` and `.config/nextest.toml` at the top are its Cargo workspace, which also holds the Linux app's crates. - `.github/`: workflows, actions, the PR template and `plugin-registry.json`. - `.claude/`: the path-scoped rules and the `fix-issue` and `release` skills, which Codex sees through `.agents/skills/`. +- `docs/feature-parity/`: which user-visible features each app has, in `features.yml` with the table generated from it by `scripts/parity/render.py`. A pull request that adds or finishes a feature updates its row. - `scripts/`: `banned-words.txt` with `check-banned-words.sh`, the PR title and changed-path checks in `scripts/ci`, and the towncrier pin in `scripts/release`. - `appcast.xml`: the legacy feed apps up to 0.81 read from `main` (`apple/RELEASING.md`, Channels). - `.oss-scanner/`: the build image and threat model for Anthropic's OSS Scanner. Renaming a TableProCore target that `.oss-scanner/swift/Package.swift` lists updates it there too. diff --git a/docs/feature-parity/README.md b/docs/feature-parity/README.md new file mode 100644 index 0000000000..b856abc89d --- /dev/null +++ b/docs/feature-parity/README.md @@ -0,0 +1,109 @@ +# Feature parity + +Which user-visible features each app has. The macOS app is the reference, and the Linux and Windows apps +follow its behavior. This file is generated: edit [`features.yml`](features.yml), then run +`python3 scripts/parity/render.py`. A pull request that adds or finishes a feature updates its row. + +Status: Yes is shipped. In PR is built in an open pull request. Partial says what ships. No is not built. +n/a does not apply. Unknown has not been checked. + +## Totals + +| | macOS | Linux | Windows | +|---|---|---|---| +| Yes | 44 | 25 | 0 | +| In a PR | 0 | 13 | 0 | +| Partial | 0 | 2 | 0 | +| No | 0 | 4 | 0 | +| Unknown | 0 | 0 | 44 | + +44 features. + +## Connections + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Saved connections, groups, favourites and tags | Yes | Yes | Unknown | | +| SSH tunnels with jump hosts | Yes | Yes | Unknown | | +| Safe Mode per connection (off, confirm writes, read only) | Yes | Yes | Unknown | | +| Import connections from other apps | Yes | Yes | Unknown | | +| Open another database of a server beside the connection | Yes | Yes | Unknown | | + +## Sidebar + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Schemas and tables, with search | Yes | Yes | Unknown | | +| Tables and Favorites scope switch | Yes | In PR [#4114](https://github.com/TableProApp/TablePro/pull/4114) | Unknown | Linux lists the saved queries of the front connection, and renames and deletes them (4115). | +| Favorite folders and keywords | Yes | In PR [#4116](https://github.com/TableProApp/TablePro/pull/4116): storage only; the sidebar does not use it yet | Unknown | Shared storage and the decision are core ADR 0017. | +| Favorite tables and databases, with environments | Yes | In PR [#4116](https://github.com/TableProApp/TablePro/pull/4116): storage only; no UI yet | Unknown | | +| Open Quickly (find a table by name) | Yes | In PR [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views; not databases, routines or queries | Unknown | | +| Sidebar toggle in the window header | Yes | In PR [#4117](https://github.com/TableProApp/TablePro/pull/4117) | Unknown | | + +## Data grid + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Virtualized grid with paging and an exact or estimated count | Yes | Yes | Unknown | | +| Alternate row shading | Yes | Yes | Unknown | | +| Values in the monospace font | Yes | Yes | Unknown | | +| Row numbers stay in view while scrolling sideways | Yes | In PR [#4110](https://github.com/TableProApp/TablePro/pull/4110) | Unknown | | +| Inline cell editing with pending changes, undo and redo | Yes | Yes | Unknown | | +| Filters per column and as a WHERE fragment | Yes | Yes | Unknown | | +| Open a referenced row and the rows that reference one | Yes | Yes | Unknown | | +| Highlight rules (colour rows by a condition) | Yes | No | Unknown | | + +## Bottom bar + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Columns button | Yes | In PR [#4118](https://github.com/TableProApp/TablePro/pull/4118) | Unknown | | +| Time a page or a query took | Yes | Partial ([#4119](https://github.com/TableProApp/TablePro/pull/4119)): query results show it; table pages in the pull request | Unknown | | +| Data and Structure in one tab | Yes | In PR [#4108](https://github.com/TableProApp/TablePro/pull/4108): one bar for it in 4111 | Unknown | | +| JSON view of the rows | Yes | In PR [#4122](https://github.com/TableProApp/TablePro/pull/4122): table tabs; not query results | Unknown | | +| Chart view of a result | Yes | No | Unknown | | +| Map view of a result | Yes | No | Unknown | | + +## Row details + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Row details pane with an editor for the focused field | Yes | Yes | Unknown | | +| Field rows with type badge, key and edit marks | Yes | In PR [#4112](https://github.com/TableProApp/TablePro/pull/4112) | Unknown | | +| Field search and edited-only filter | Yes | In PR [#4113](https://github.com/TableProApp/TablePro/pull/4113) | Unknown | | +| An editor inside each field row | Yes | No | Unknown | | +| A row as JSON | Yes | Partial: a dialog from the grid menu, not a pane view | Unknown | | + +## SQL editor + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Highlighting, completion, snippets and formatting | Yes | Yes | Unknown | | +| Move a query tab to another database | Yes | Yes | Unknown | | +| The chosen colour scheme is drawn as chosen | Yes | In PR [#4109](https://github.com/TableProApp/TablePro/pull/4109) | Unknown | | +| Dragging the results up keeps the query in view | Yes | In PR [#4120](https://github.com/TableProApp/TablePro/pull/4120) | Unknown | | +| Vim keybindings | Yes | Yes | Unknown | | + +## Structure and schema + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Structure editor with a reviewed ALTER | Yes | Yes | Unknown | | +| ER diagram | Yes | Yes | Unknown | | + +## History, import and export + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Query history with search, pins and export | Yes | Yes | Unknown | | +| Saved queries | Yes | Yes | Unknown | | +| Export results (CSV, JSON, Markdown, HTML, XML, Excel, SQL) | Yes | Yes | Unknown | | +| Export a database as SQL and import a SQL file | Yes | Yes | Unknown | | + +## Assistant, MCP and account + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| AI assistant | Yes | Yes | Unknown | | +| MCP server for outside clients | Yes | Yes | Unknown | | +| TablePro account and entitlement | Yes | Yes | Unknown | | diff --git a/docs/feature-parity/features.yml b/docs/feature-parity/features.yml new file mode 100644 index 0000000000..372429188b --- /dev/null +++ b/docs/feature-parity/features.yml @@ -0,0 +1,262 @@ +# The one home of which user-visible features each app has. README.md in this +# folder is generated from it: python3 scripts/parity/render.py +# +# A platform's value is a status, or a mapping with `status` and optionally +# `pr` (a pull request number) and `note`. +# yes shipped +# pending built and in an open pull request, not shipped yet (give `pr`) +# partial some of it ships (say what in `note`) +# no not built +# na does not apply to this platform +# unknown nobody has checked +# macOS is the reference: the other two follow its behavior (see each app's AGENTS.md). + +areas: + - name: Connections + features: + - id: saved-connections + name: Saved connections, groups, favourites and tags + macos: yes + linux: yes + windows: unknown + - id: ssh-tunnel + name: SSH tunnels with jump hosts + macos: yes + linux: yes + windows: unknown + - id: safe-mode + name: Safe Mode per connection (off, confirm writes, read only) + macos: yes + linux: yes + windows: unknown + - id: import-from-apps + name: Import connections from other apps + macos: yes + linux: yes + windows: unknown + - id: open-database-beside + name: Open another database of a server beside the connection + macos: yes + linux: yes + windows: unknown + + - name: Sidebar + features: + - id: tables-tree + name: Schemas and tables, with search + macos: yes + linux: yes + windows: unknown + - id: favorites-scope + name: Tables and Favorites scope switch + macos: yes + linux: {status: pending, pr: 4114} + windows: unknown + notes: Linux lists the saved queries of the front connection, and renames and deletes them (4115). + - id: favorites-folders + name: Favorite folders and keywords + macos: yes + linux: {status: pending, pr: 4116, note: "storage only; the sidebar does not use it yet"} + windows: unknown + notes: "Shared storage and the decision are core ADR 0017." + - id: favorite-tables-databases + name: Favorite tables and databases, with environments + macos: yes + linux: {status: pending, pr: 4116, note: "storage only; no UI yet"} + windows: unknown + - id: quick-switcher + name: Open Quickly (find a table by name) + macos: yes + linux: {status: pending, pr: 4121, note: "tables and views; not databases, routines or queries"} + windows: unknown + - id: sidebar-toggle + name: Sidebar toggle in the window header + macos: yes + linux: {status: pending, pr: 4117} + windows: unknown + + - name: Data grid + features: + - id: virtual-grid + name: Virtualized grid with paging and an exact or estimated count + macos: yes + linux: yes + windows: unknown + - id: grid-alternate-rows + name: Alternate row shading + macos: yes + linux: yes + windows: unknown + - id: grid-monospace + name: Values in the monospace font + macos: yes + linux: yes + windows: unknown + - id: pinned-row-numbers + name: Row numbers stay in view while scrolling sideways + macos: yes + linux: {status: pending, pr: 4110} + windows: unknown + - id: cell-editing + name: Inline cell editing with pending changes, undo and redo + macos: yes + linux: yes + windows: unknown + - id: filters + name: Filters per column and as a WHERE fragment + macos: yes + linux: yes + windows: unknown + - id: foreign-key-navigation + name: Open a referenced row and the rows that reference one + macos: yes + linux: yes + windows: unknown + - id: highlight-rules + name: Highlight rules (colour rows by a condition) + macos: yes + linux: no + windows: unknown + + - name: Bottom bar + features: + - id: bar-columns + name: Columns button + macos: yes + linux: {status: pending, pr: 4118} + windows: unknown + - id: bar-timing + name: Time a page or a query took + macos: yes + linux: {status: partial, pr: 4119, note: "query results show it; table pages in the pull request"} + windows: unknown + - id: bar-structure + name: Data and Structure in one tab + macos: yes + linux: {status: pending, pr: 4108, note: "one bar for it in 4111"} + windows: unknown + - id: bar-json + name: JSON view of the rows + macos: yes + linux: {status: pending, pr: 4122, note: "table tabs; not query results"} + windows: unknown + - id: bar-chart + name: Chart view of a result + macos: yes + linux: no + windows: unknown + - id: bar-map + name: Map view of a result + macos: yes + linux: no + windows: unknown + + - name: Row details + features: + - id: row-details-pane + name: Row details pane with an editor for the focused field + macos: yes + linux: yes + windows: unknown + - id: row-details-look + name: Field rows with type badge, key and edit marks + macos: yes + linux: {status: pending, pr: 4112} + windows: unknown + - id: row-details-search + name: Field search and edited-only filter + macos: yes + linux: {status: pending, pr: 4113} + windows: unknown + - id: row-details-inline + name: An editor inside each field row + macos: yes + linux: no + windows: unknown + - id: row-json + name: A row as JSON + macos: yes + linux: {status: partial, note: "a dialog from the grid menu, not a pane view"} + windows: unknown + + - name: SQL editor + features: + - id: editor-basics + name: Highlighting, completion, snippets and formatting + macos: yes + linux: yes + windows: unknown + - id: editor-database-switch + name: Move a query tab to another database + macos: yes + linux: yes + windows: unknown + - id: editor-scheme + name: The chosen colour scheme is drawn as chosen + macos: yes + linux: {status: pending, pr: 4109} + windows: unknown + - id: editor-divider + name: Dragging the results up keeps the query in view + macos: yes + linux: {status: pending, pr: 4120} + windows: unknown + - id: vim-mode + name: Vim keybindings + macos: yes + linux: yes + windows: unknown + + - name: Structure and schema + features: + - id: structure-editor + name: Structure editor with a reviewed ALTER + macos: yes + linux: yes + windows: unknown + - id: er-diagram + name: ER diagram + macos: yes + linux: yes + windows: unknown + + - name: History, import and export + features: + - id: query-history + name: Query history with search, pins and export + macos: yes + linux: yes + windows: unknown + - id: saved-queries + name: Saved queries + macos: yes + linux: yes + windows: unknown + - id: export-results + name: Export results (CSV, JSON, Markdown, HTML, XML, Excel, SQL) + macos: yes + linux: yes + windows: unknown + - id: sql-dump + name: Export a database as SQL and import a SQL file + macos: yes + linux: yes + windows: unknown + + - name: Assistant, MCP and account + features: + - id: ai-assistant + name: AI assistant + macos: yes + linux: yes + windows: unknown + - id: mcp-server + name: MCP server for outside clients + macos: yes + linux: yes + windows: unknown + - id: account + name: TablePro account and entitlement + macos: yes + linux: yes + windows: unknown diff --git a/scripts/ci/test_parity.py b/scripts/ci/test_parity.py new file mode 100644 index 0000000000..0013e6639c --- /dev/null +++ b/scripts/ci/test_parity.py @@ -0,0 +1,90 @@ +#!/usr/bin/env python3 +"""Tests the feature parity registry and the README rendered from it.""" + +import importlib.util +import tempfile +import unittest +from pathlib import Path + +RENDER = Path(__file__).resolve().parents[1] / "parity" / "render.py" +spec = importlib.util.spec_from_file_location("parity_render", RENDER) +render = importlib.util.module_from_spec(spec) +spec.loader.exec_module(render) + + +def areas_of(text): + with tempfile.TemporaryDirectory() as folder: + path = Path(folder) / "features.yml" + path.write_text(text, encoding="utf-8") + return render.load(path) + + +def feature(extra="", ident="a", macos="yes", linux="yes", windows="unknown"): + return f""" +areas: + - name: Area + features: + - id: {ident} + name: A feature + macos: {macos} + linux: {linux} + windows: {windows} +{extra}""" + + +class ParityTests(unittest.TestCase): + def test_the_committed_registry_is_valid_and_its_readme_is_current(self): + areas = render.load() + self.assertTrue(areas) + self.assertEqual(render.TARGET.read_text(encoding="utf-8"), render.render(areas)) + + def test_a_bare_yes_and_no_are_read_as_statuses(self): + areas = areas_of(feature(linux="no")) + cells = areas[0]["features"][0]["cells"] + self.assertEqual(cells["macos"][0], "yes") + self.assertEqual(cells["linux"][0], "no") + + def test_a_pending_feature_links_its_pull_request(self): + text = feature(linux="{status: pending, pr: 4114}") + rendered = render.render(areas_of(text)) + self.assertIn("In PR [#4114](https://github.com/TableProApp/TablePro/pull/4114)", rendered) + + def test_a_pending_feature_without_a_pull_request_is_refused(self): + with self.assertRaisesRegex(render.ParityError, "pull request"): + areas_of(feature(linux="{status: pending}")) + + def test_an_unknown_status_is_refused(self): + with self.assertRaisesRegex(render.ParityError, "status"): + areas_of(feature(linux="done")) + + def test_a_missing_platform_is_refused(self): + text = """ +areas: + - name: Area + features: + - id: a + name: A feature + macos: yes + linux: yes +""" + with self.assertRaisesRegex(render.ParityError, "windows"): + areas_of(text) + + def test_an_id_is_used_once(self): + text = feature() + """ + - id: a + name: Again + macos: yes + linux: yes + windows: yes +""" + with self.assertRaisesRegex(render.ParityError, "twice"): + areas_of(text) + + def test_a_pipe_in_a_note_does_not_break_the_table(self): + rendered = render.render(areas_of(feature(linux="{status: partial, note: 'a | b'}"))) + self.assertIn("Partial: a \\| b", rendered) + + +if __name__ == "__main__": + unittest.main() diff --git a/scripts/parity/render.py b/scripts/parity/render.py new file mode 100644 index 0000000000..ffc72e0ea8 --- /dev/null +++ b/scripts/parity/render.py @@ -0,0 +1,162 @@ +#!/usr/bin/env python3 +"""Check docs/feature-parity/features.yml and write the table in README.md from it. + + python3 scripts/parity/render.py write README.md + python3 scripts/parity/render.py --check fail when README.md is not what features.yml renders +""" + +import argparse +import sys +from pathlib import Path + +import yaml + +ROOT = Path(__file__).resolve().parents[2] +FOLDER = ROOT / "docs" / "feature-parity" +SOURCE = FOLDER / "features.yml" +TARGET = FOLDER / "README.md" +REPOSITORY = "https://github.com/TableProApp/TablePro" + +PLATFORMS = (("macos", "macOS"), ("linux", "Linux"), ("windows", "Windows")) +STATUSES = { + "yes": "Yes", + "pending": "In a PR", + "partial": "Partial", + "no": "No", + "na": "n/a", + "unknown": "Unknown", +} + + +class ParityError(ValueError): + pass + + +def cell_of(value, where): + """The status, pull request and note a platform's value stands for.""" + # YAML 1.1 reads a bare yes and no as booleans. + if isinstance(value, bool): + value = "yes" if value else "no" + if isinstance(value, str): + value = {"status": value} + if not isinstance(value, dict): + raise ParityError(f"{where}: a platform is a status or a mapping") + unknown = set(value) - {"status", "pr", "note"} + if unknown: + raise ParityError(f"{where}: unknown keys {sorted(unknown)}") + status = value.get("status") + if isinstance(status, bool): + status = "yes" if status else "no" + if status not in STATUSES: + raise ParityError(f"{where}: status {status!r} is not one of {sorted(STATUSES)}") + pr = value.get("pr") + if pr is not None and (not isinstance(pr, int) or isinstance(pr, bool) or pr <= 0): + raise ParityError(f"{where}: pr is a pull request number") + if status == "pending" and pr is None: + raise ParityError(f"{where}: a pending feature names its pull request") + note = value.get("note") + if note is not None and not isinstance(note, str): + raise ParityError(f"{where}: note is text") + return status, pr, note + + +def load(path=SOURCE): + """The areas of `path`, each feature with its three cells checked.""" + document = yaml.safe_load(Path(path).read_text(encoding="utf-8")) + if not isinstance(document, dict) or not isinstance(document.get("areas"), list): + raise ParityError("features.yml holds a list of areas") + seen = set() + areas = [] + for area in document["areas"]: + features = [] + for feature in area.get("features", []): + name = feature.get("name") + ident = feature.get("id") + if not name or not ident: + raise ParityError(f"{area.get('name')}: a feature needs an id and a name") + if ident in seen: + raise ParityError(f"{ident}: the id is used twice") + seen.add(ident) + cells = {} + for key, _ in PLATFORMS: + if key not in feature: + raise ParityError(f"{ident}: no value for {key}") + cells[key] = cell_of(feature[key], f"{ident}.{key}") + features.append({"id": ident, "name": name, "cells": cells, "notes": feature.get("notes", "")}) + if not area.get("name") or not features: + raise ParityError("an area needs a name and features") + areas.append({"name": area["name"], "features": features}) + return areas + + +def shown(cell): + status, pr, note = cell + text = STATUSES[status] + if status == "pending": + text = f"In PR [#{pr}]({REPOSITORY}/pull/{pr})" + elif pr is not None: + text = f"{text} ([#{pr}]({REPOSITORY}/pull/{pr}))" + if note: + text = f"{text}: {note}" + return text.replace("|", "\\|") + + +def render(areas): + lines = [ + "# Feature parity", + "", + "Which user-visible features each app has. The macOS app is the reference, and the Linux and Windows apps", + "follow its behavior. This file is generated: edit [`features.yml`](features.yml), then run", + "`python3 scripts/parity/render.py`. A pull request that adds or finishes a feature updates its row.", + "", + "Status: Yes is shipped. In PR is built in an open pull request. Partial says what ships. No is not built.", + "n/a does not apply. Unknown has not been checked.", + "", + "## Totals", + "", + "| | " + " | ".join(label for _, label in PLATFORMS) + " |", + "|---|" + "---|" * len(PLATFORMS), + ] + total = sum(len(area["features"]) for area in areas) + for status, label in STATUSES.items(): + counts = [ + sum(1 for area in areas for f in area["features"] if f["cells"][key][0] == status) + for key, _ in PLATFORMS + ] + if any(counts): + lines.append(f"| {label} | " + " | ".join(str(count) for count in counts) + " |") + lines += ["", f"{total} features.", ""] + for area in areas: + lines += [ + f"## {area['name']}", + "", + "| Feature | " + " | ".join(label for _, label in PLATFORMS) + " | Notes |", + "|---|" + "---|" * (len(PLATFORMS) + 1), + ] + for feature in area["features"]: + row = " | ".join(shown(feature["cells"][key]) for key, _ in PLATFORMS) + lines.append(f"| {feature['name']} | {row} | {feature['notes'].replace('|', chr(92) + '|')} |") + lines.append("") + return "\n".join(lines) + + +def main(argv=None): + parser = argparse.ArgumentParser(description=__doc__.splitlines()[0]) + parser.add_argument("--check", action="store_true", help="fail when README.md is out of date") + arguments = parser.parse_args(argv) + try: + text = render(load()) + except ParityError as error: + print(f"features.yml: {error}", file=sys.stderr) + return 1 + if arguments.check: + if not TARGET.exists() or TARGET.read_text(encoding="utf-8") != text: + print("docs/feature-parity/README.md is out of date: run python3 scripts/parity/render.py", file=sys.stderr) + return 1 + return 0 + TARGET.write_text(text, encoding="utf-8") + return 0 + + +if __name__ == "__main__": + sys.exit(main()) From fd6ba4e89aadf3eb8fa883ab23743222d9e1afb2 Mon Sep 17 00:00:00 2001 From: sedax90 <5001801+sedax90@users.noreply.github.com> Date: Sun, 8 Nov 2026 14:31:22 +0100 Subject: [PATCH 2/7] docs(parity): record the toolbar, favorites and grid pull requests --- docs/feature-parity/README.md | 31 +++++++++++++----- docs/feature-parity/features.yml | 55 ++++++++++++++++++++++++++++++-- 2 files changed, 75 insertions(+), 11 deletions(-) diff --git a/docs/feature-parity/README.md b/docs/feature-parity/README.md index b856abc89d..b044bb2709 100644 --- a/docs/feature-parity/README.md +++ b/docs/feature-parity/README.md @@ -11,13 +11,14 @@ n/a does not apply. Unknown has not been checked. | | macOS | Linux | Windows | |---|---|---|---| -| Yes | 44 | 25 | 0 | -| In a PR | 0 | 13 | 0 | -| Partial | 0 | 2 | 0 | -| No | 0 | 4 | 0 | -| Unknown | 0 | 0 | 44 | +| Yes | 53 | 26 | 0 | +| In a PR | 0 | 18 | 0 | +| Partial | 0 | 5 | 0 | +| No | 0 | 3 | 0 | +| n/a | 0 | 1 | 0 | +| Unknown | 0 | 0 | 53 | -44 features. +53 features. ## Connections @@ -35,7 +36,8 @@ n/a does not apply. Unknown has not been checked. |---|---|---|---|---| | Schemas and tables, with search | Yes | Yes | Unknown | | | Tables and Favorites scope switch | Yes | In PR [#4114](https://github.com/TableProApp/TablePro/pull/4114) | Unknown | Linux lists the saved queries of the front connection, and renames and deletes them (4115). | -| Favorite folders and keywords | Yes | In PR [#4116](https://github.com/TableProApp/TablePro/pull/4116): storage only; the sidebar does not use it yet | Unknown | Shared storage and the decision are core ADR 0017. | +| Favorite folders | Yes | In PR [#4130](https://github.com/TableProApp/TablePro/pull/4130): on the storage of 4116 | Unknown | | +| Favorite keywords that expand in the editor | Yes | Partial ([#4116](https://github.com/TableProApp/TablePro/pull/4116)): storage only; the editor does not expand them yet | Unknown | Shared storage and the decision are core ADR 0017. | | Favorite tables and databases, with environments | Yes | In PR [#4116](https://github.com/TableProApp/TablePro/pull/4116): storage only; no UI yet | Unknown | | | Open Quickly (find a table by name) | Yes | In PR [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views; not databases, routines or queries | Unknown | | | Sidebar toggle in the window header | Yes | In PR [#4117](https://github.com/TableProApp/TablePro/pull/4117) | Unknown | | @@ -51,7 +53,8 @@ n/a does not apply. Unknown has not been checked. | Inline cell editing with pending changes, undo and redo | Yes | Yes | Unknown | | | Filters per column and as a WHERE fragment | Yes | Yes | Unknown | | | Open a referenced row and the rows that reference one | Yes | Yes | Unknown | | -| Highlight rules (colour rows by a condition) | Yes | No | Unknown | | +| Highlight rules (colour rows by a condition) | Yes | In PR [#4127](https://github.com/TableProApp/TablePro/pull/4127): kept per table in 4129; not kept for a query result | Unknown | | +| The grid draws in the editor scheme's colours | Yes | In PR [#4128](https://github.com/TableProApp/TablePro/pull/4128) | Unknown | | ## Bottom bar @@ -107,3 +110,15 @@ n/a does not apply. Unknown has not been checked. | AI assistant | Yes | Yes | Unknown | | | MCP server for outside clients | Yes | Yes | Unknown | | | TablePro account and entitlement | Yes | Yes | Unknown | | + +## Window toolbar + +| Feature | macOS | Linux | Windows | Notes | +|---|---|---|---|---| +| Safe Mode lock in the toolbar | Yes | In PR [#4124](https://github.com/TableProApp/TablePro/pull/4124) | Unknown | | +| Refresh button | Yes | In PR [#4125](https://github.com/TableProApp/TablePro/pull/4125) | Unknown | | +| Save Changes check | Yes | In PR [#4126](https://github.com/TableProApp/TablePro/pull/4126) | Unknown | | +| Connection and database chips | Yes | Partial: the title names the connection and the sidebar holds every open connection and database; no chips | Unknown | | +| Back and Forward through a tab's browse history | Yes | n/a: a referenced row opens in a new tab here, where macOS retargets the tab | Unknown | | +| Actions menu (Preview SQL, Show and Copy DDL, Users and Roles, Query Insights, Server Dashboard) | Yes | Partial: Show CREATE TABLE is in the sidebar's menu; the rest is not built | Unknown | | +| Reconnect after a lost connection | Yes | Yes | Unknown | On Linux it is the health banner's button. | diff --git a/docs/feature-parity/features.yml b/docs/feature-parity/features.yml index 372429188b..ee168d940d 100644 --- a/docs/feature-parity/features.yml +++ b/docs/feature-parity/features.yml @@ -54,9 +54,14 @@ areas: windows: unknown notes: Linux lists the saved queries of the front connection, and renames and deletes them (4115). - id: favorites-folders - name: Favorite folders and keywords + name: Favorite folders macos: yes - linux: {status: pending, pr: 4116, note: "storage only; the sidebar does not use it yet"} + linux: {status: pending, pr: 4130, note: "on the storage of 4116"} + windows: unknown + - id: favorites-keywords + name: Favorite keywords that expand in the editor + macos: yes + linux: {status: partial, pr: 4116, note: "storage only; the editor does not expand them yet"} windows: unknown notes: "Shared storage and the decision are core ADR 0017." - id: favorite-tables-databases @@ -115,7 +120,12 @@ areas: - id: highlight-rules name: Highlight rules (colour rows by a condition) macos: yes - linux: no + linux: {status: pending, pr: 4127, note: "kept per table in 4129; not kept for a query result"} + windows: unknown + - id: grid-scheme-colors + name: The grid draws in the editor scheme's colours + macos: yes + linux: {status: pending, pr: 4128} windows: unknown - name: Bottom bar @@ -260,3 +270,42 @@ areas: macos: yes linux: yes windows: unknown + + - name: Window toolbar + features: + - id: toolbar-safe-mode + name: Safe Mode lock in the toolbar + macos: yes + linux: {status: pending, pr: 4124} + windows: unknown + - id: toolbar-refresh + name: Refresh button + macos: yes + linux: {status: pending, pr: 4125} + windows: unknown + - id: toolbar-save-changes + name: Save Changes check + macos: yes + linux: {status: pending, pr: 4126} + windows: unknown + - id: toolbar-chips + name: Connection and database chips + macos: yes + linux: {status: partial, note: "the title names the connection and the sidebar holds every open connection and database; no chips"} + windows: unknown + - id: toolbar-back-forward + name: Back and Forward through a tab's browse history + macos: yes + linux: {status: na, note: "a referenced row opens in a new tab here, where macOS retargets the tab"} + windows: unknown + - id: toolbar-actions-menu + name: Actions menu (Preview SQL, Show and Copy DDL, Users and Roles, Query Insights, Server Dashboard) + macos: yes + linux: {status: partial, note: "Show CREATE TABLE is in the sidebar's menu; the rest is not built"} + windows: unknown + - id: toolbar-reconnect + name: Reconnect after a lost connection + macos: yes + linux: yes + windows: unknown + notes: On Linux it is the health banner's button. From 5de515ef4ae00dd0a301bb0a7922849d1eec1a61 Mon Sep 17 00:00:00 2001 From: sedax90 <5001801+sedax90@users.noreply.github.com> Date: Sun, 8 Nov 2026 17:53:07 +0100 Subject: [PATCH 3/7] docs(parity): record the grid preferences, sidebar footer, DBX import and menus --- docs/feature-parity/README.md | 25 ++++++++++---- docs/feature-parity/features.yml | 59 +++++++++++++++++++++++++++++++- 2 files changed, 76 insertions(+), 8 deletions(-) diff --git a/docs/feature-parity/README.md b/docs/feature-parity/README.md index b044bb2709..2efa1b28d9 100644 --- a/docs/feature-parity/README.md +++ b/docs/feature-parity/README.md @@ -11,14 +11,14 @@ n/a does not apply. Unknown has not been checked. | | macOS | Linux | Windows | |---|---|---|---| -| Yes | 53 | 26 | 0 | -| In a PR | 0 | 18 | 0 | -| Partial | 0 | 5 | 0 | +| Yes | 64 | 26 | 0 | +| In a PR | 0 | 27 | 0 | +| Partial | 0 | 7 | 0 | | No | 0 | 3 | 0 | | n/a | 0 | 1 | 0 | -| Unknown | 0 | 0 | 53 | +| Unknown | 0 | 0 | 64 | -53 features. +64 features. ## Connections @@ -27,7 +27,8 @@ n/a does not apply. Unknown has not been checked. | Saved connections, groups, favourites and tags | Yes | Yes | Unknown | | | SSH tunnels with jump hosts | Yes | Yes | Unknown | | | Safe Mode per connection (off, confirm writes, read only) | Yes | Yes | Unknown | | -| Import connections from other apps | Yes | Yes | Unknown | | +| Import connections from other apps | Yes | Yes | Unknown | DBX is read on Linux and Windows through the shared core (4147); the macOS importers are Swift and do not list it. | +| Application menu bar (File, Edit, View, Help) with Quit | Yes | In PR [#4139](https://github.com/TableProApp/TablePro/pull/4139): read by a global menu and assistive technology; GNOME draws none | Unknown | | | Open another database of a server beside the connection | Yes | Yes | Unknown | | ## Sidebar @@ -39,7 +40,9 @@ n/a does not apply. Unknown has not been checked. | Favorite folders | Yes | In PR [#4130](https://github.com/TableProApp/TablePro/pull/4130): on the storage of 4116 | Unknown | | | Favorite keywords that expand in the editor | Yes | Partial ([#4116](https://github.com/TableProApp/TablePro/pull/4116)): storage only; the editor does not expand them yet | Unknown | Shared storage and the decision are core ADR 0017. | | Favorite tables and databases, with environments | Yes | In PR [#4116](https://github.com/TableProApp/TablePro/pull/4116): storage only; no UI yet | Unknown | | -| Open Quickly (find a table by name) | Yes | In PR [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views; not databases, routines or queries | Unknown | | +| Open Quickly (find a table by name) | Yes | In PR [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views, saved queries in 4133 and past queries in 4144; not databases, schemas, routines or other connections | Unknown | | +| Bottom bar with an Add menu and a schema picker | Yes | Partial ([#4146](https://github.com/TableProApp/TablePro/pull/4146)): the Add menu (table, schema, database); no schema picker | Unknown | | +| A row's menu is shown whole, not cut with a scrollbar | Yes | In PR [#4149](https://github.com/TableProApp/TablePro/pull/4149) | Unknown | | | Sidebar toggle in the window header | Yes | In PR [#4117](https://github.com/TableProApp/TablePro/pull/4117) | Unknown | | ## Data grid @@ -55,6 +58,14 @@ n/a does not apply. Unknown has not been checked. | Open a referenced row and the rows that reference one | Yes | Yes | Unknown | | | Highlight rules (colour rows by a condition) | Yes | In PR [#4127](https://github.com/TableProApp/TablePro/pull/4127): kept per table in 4129; not kept for a query result | Unknown | | | The grid draws in the editor scheme's colours | Yes | In PR [#4128](https://github.com/TableProApp/TablePro/pull/4128) | Unknown | | +| Show row numbers, row height and the text shown for NULL | Yes | In PR [#4134](https://github.com/TableProApp/TablePro/pull/4134) | Unknown | | +| Font of the grid's cells | Yes | Partial ([#4135](https://github.com/TableProApp/TablePro/pull/4135)): family and size; no zoom | Unknown | | +| Date format of the cells | Yes | In PR [#4142](https://github.com/TableProApp/TablePro/pull/4142): cells only; copy and export keep the database's text | Unknown | | +| Default sort of a table (none, primary key, first column) | Yes | In PR [#4140](https://github.com/TableProApp/TablePro/pull/4140): one column | Unknown | | +| The format Copy writes for several rows | Yes | In PR [#4137](https://github.com/TableProApp/TablePro/pull/4137) | Unknown | | +| Open the row details when a row is selected | Yes | In PR [#4138](https://github.com/TableProApp/TablePro/pull/4138) | Unknown | | +| Set Empty, NULL or DEFAULT on every selected row | Yes | In PR [#4136](https://github.com/TableProApp/TablePro/pull/4136): not yet for expressions and UUIDs | Unknown | | +| Mark spaces, tabs and line breaks in the value editor | Yes | In PR [#4141](https://github.com/TableProApp/TablePro/pull/4141) | Unknown | | ## Bottom bar diff --git a/docs/feature-parity/features.yml b/docs/feature-parity/features.yml index ee168d940d..a7c999fcd6 100644 --- a/docs/feature-parity/features.yml +++ b/docs/feature-parity/features.yml @@ -34,6 +34,12 @@ areas: macos: yes linux: yes windows: unknown + notes: DBX is read on Linux and Windows through the shared core (4147); the macOS importers are Swift and do not list it. + - id: app-menu-bar + name: Application menu bar (File, Edit, View, Help) with Quit + macos: yes + linux: {status: pending, pr: 4139, note: "read by a global menu and assistive technology; GNOME draws none"} + windows: unknown - id: open-database-beside name: Open another database of a server beside the connection macos: yes @@ -72,7 +78,17 @@ areas: - id: quick-switcher name: Open Quickly (find a table by name) macos: yes - linux: {status: pending, pr: 4121, note: "tables and views; not databases, routines or queries"} + linux: {status: pending, pr: 4121, note: "tables and views, saved queries in 4133 and past queries in 4144; not databases, schemas, routines or other connections"} + windows: unknown + - id: sidebar-footer + name: Bottom bar with an Add menu and a schema picker + macos: yes + linux: {status: partial, pr: 4146, note: "the Add menu (table, schema, database); no schema picker"} + windows: unknown + - id: sidebar-menu-size + name: A row's menu is shown whole, not cut with a scrollbar + macos: yes + linux: {status: pending, pr: 4149} windows: unknown - id: sidebar-toggle name: Sidebar toggle in the window header @@ -128,6 +144,47 @@ areas: linux: {status: pending, pr: 4128} windows: unknown + - id: grid-row-display + name: Show row numbers, row height and the text shown for NULL + macos: yes + linux: {status: pending, pr: 4134} + windows: unknown + - id: grid-cell-font + name: Font of the grid's cells + macos: yes + linux: {status: partial, pr: 4135, note: "family and size; no zoom"} + windows: unknown + - id: grid-date-format + name: Date format of the cells + macos: yes + linux: {status: pending, pr: 4142, note: "cells only; copy and export keep the database's text"} + windows: unknown + - id: grid-default-sort + name: Default sort of a table (none, primary key, first column) + macos: yes + linux: {status: pending, pr: 4140, note: "one column"} + windows: unknown + - id: grid-copy-format + name: The format Copy writes for several rows + macos: yes + linux: {status: pending, pr: 4137} + windows: unknown + - id: grid-auto-inspector + name: Open the row details when a row is selected + macos: yes + linux: {status: pending, pr: 4138} + windows: unknown + - id: grid-set-value + name: Set Empty, NULL or DEFAULT on every selected row + macos: yes + linux: {status: pending, pr: 4136, note: "not yet for expressions and UUIDs"} + windows: unknown + - id: grid-invisibles + name: Mark spaces, tabs and line breaks in the value editor + macos: yes + linux: {status: pending, pr: 4141} + windows: unknown + - name: Bottom bar features: - id: bar-columns From af176b7cd63c978c5d24a03c3e3a8b57cc5cd0b3 Mon Sep 17 00:00:00 2001 From: sedax90 <5001801+sedax90@users.noreply.github.com> Date: Sun, 8 Nov 2026 17:55:56 +0100 Subject: [PATCH 4/7] docs(parity): Set Value now reaches expressions too --- docs/feature-parity/README.md | 2 +- docs/feature-parity/features.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/feature-parity/README.md b/docs/feature-parity/README.md index 2efa1b28d9..277f7e04b6 100644 --- a/docs/feature-parity/README.md +++ b/docs/feature-parity/README.md @@ -64,7 +64,7 @@ n/a does not apply. Unknown has not been checked. | Default sort of a table (none, primary key, first column) | Yes | In PR [#4140](https://github.com/TableProApp/TablePro/pull/4140): one column | Unknown | | | The format Copy writes for several rows | Yes | In PR [#4137](https://github.com/TableProApp/TablePro/pull/4137) | Unknown | | | Open the row details when a row is selected | Yes | In PR [#4138](https://github.com/TableProApp/TablePro/pull/4138) | Unknown | | -| Set Empty, NULL or DEFAULT on every selected row | Yes | In PR [#4136](https://github.com/TableProApp/TablePro/pull/4136): not yet for expressions and UUIDs | Unknown | | +| Set Empty, NULL or DEFAULT on every selected row | Yes | In PR [#4136](https://github.com/TableProApp/TablePro/pull/4136): Empty, NULL, DEFAULT and expressions | Unknown | | | Mark spaces, tabs and line breaks in the value editor | Yes | In PR [#4141](https://github.com/TableProApp/TablePro/pull/4141) | Unknown | | ## Bottom bar diff --git a/docs/feature-parity/features.yml b/docs/feature-parity/features.yml index a7c999fcd6..78ce69291a 100644 --- a/docs/feature-parity/features.yml +++ b/docs/feature-parity/features.yml @@ -177,7 +177,7 @@ areas: - id: grid-set-value name: Set Empty, NULL or DEFAULT on every selected row macos: yes - linux: {status: pending, pr: 4136, note: "not yet for expressions and UUIDs"} + linux: {status: pending, pr: 4136, note: "Empty, NULL, DEFAULT and expressions"} windows: unknown - id: grid-invisibles name: Mark spaces, tabs and line breaks in the value editor From 9826a0012d7e4a8eeb705d68a82d1e143094656c Mon Sep 17 00:00:00 2001 From: sedax90 <5001801+sedax90@users.noreply.github.com> Date: Sun, 8 Nov 2026 19:21:27 +0100 Subject: [PATCH 5/7] docs: the schema filter in the parity registry --- docs/feature-parity/README.md | 2 +- docs/feature-parity/features.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/feature-parity/README.md b/docs/feature-parity/README.md index 277f7e04b6..44faebe121 100644 --- a/docs/feature-parity/README.md +++ b/docs/feature-parity/README.md @@ -41,7 +41,7 @@ n/a does not apply. Unknown has not been checked. | Favorite keywords that expand in the editor | Yes | Partial ([#4116](https://github.com/TableProApp/TablePro/pull/4116)): storage only; the editor does not expand them yet | Unknown | Shared storage and the decision are core ADR 0017. | | Favorite tables and databases, with environments | Yes | In PR [#4116](https://github.com/TableProApp/TablePro/pull/4116): storage only; no UI yet | Unknown | | | Open Quickly (find a table by name) | Yes | In PR [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views, saved queries in 4133 and past queries in 4144; not databases, schemas, routines or other connections | Unknown | | -| Bottom bar with an Add menu and a schema picker | Yes | Partial ([#4146](https://github.com/TableProApp/TablePro/pull/4146)): the Add menu (table, schema, database); no schema picker | Unknown | | +| Bottom bar with an Add menu and a schema picker | Yes | Partial ([#4146](https://github.com/TableProApp/TablePro/pull/4146)): the Add menu (table, schema, database); a Schemas menu filters the list (4150), with no active schema | Unknown | | | A row's menu is shown whole, not cut with a scrollbar | Yes | In PR [#4149](https://github.com/TableProApp/TablePro/pull/4149) | Unknown | | | Sidebar toggle in the window header | Yes | In PR [#4117](https://github.com/TableProApp/TablePro/pull/4117) | Unknown | | diff --git a/docs/feature-parity/features.yml b/docs/feature-parity/features.yml index 78ce69291a..1bed38e5e9 100644 --- a/docs/feature-parity/features.yml +++ b/docs/feature-parity/features.yml @@ -83,7 +83,7 @@ areas: - id: sidebar-footer name: Bottom bar with an Add menu and a schema picker macos: yes - linux: {status: partial, pr: 4146, note: "the Add menu (table, schema, database); no schema picker"} + linux: {status: partial, pr: 4146, note: "the Add menu (table, schema, database); a Schemas menu filters the list (4150), with no active schema"} windows: unknown - id: sidebar-menu-size name: A row's menu is shown whole, not cut with a scrollbar From dacfd1326916bc541700353ab511d0caed712c8b Mon Sep 17 00:00:00 2001 From: Ngo Quoc Dat Date: Tue, 10 Nov 2026 04:05:40 +0700 Subject: [PATCH 6/7] docs(parity): rebuild the parity table on the repo's tooling and refill it from main --- .gitattributes | 3 + .github/workflows/ci-lint.yml | 3 + AGENTS.md | 2 +- docs/feature-parity/README.md | 203 ++++++------ docs/feature-parity/features.yml | 518 +++++++++++------------------- linux/ROADMAP.md | 2 +- scripts/ci/test_feature_parity.py | 96 ++++++ scripts/ci/test_parity.py | 90 ------ scripts/feature-parity.py | 147 +++++++++ scripts/parity/render.py | 162 ---------- 10 files changed, 547 insertions(+), 679 deletions(-) create mode 100644 scripts/ci/test_feature_parity.py delete mode 100644 scripts/ci/test_parity.py create mode 100755 scripts/feature-parity.py delete mode 100644 scripts/parity/render.py diff --git a/.gitattributes b/.gitattributes index 556df6245a..516ccee298 100644 --- a/.gitattributes +++ b/.gitattributes @@ -57,6 +57,9 @@ apple/TablePro/Resources/ThirdPartyLicenses/texts/** linguist-vendored # Joins the SQLite copyright page and the source blessing with a sentence of its own. apple/TablePro/Resources/ThirdPartyLicenses/texts/sqlite.txt -linguist-vendored +# The feature parity table, written from features.yml beside it by scripts/feature-parity.py +docs/feature-parity/README.md linguist-generated + # Generated Rust and Linux files (Cargo, cargo-about, license_metadata.py) Cargo.lock linguist-generated linux/data/licenses/** linguist-generated diff --git a/.github/workflows/ci-lint.yml b/.github/workflows/ci-lint.yml index 0f97eac36d..1954252b46 100644 --- a/.github/workflows/ci-lint.yml +++ b/.github/workflows/ci-lint.yml @@ -139,6 +139,9 @@ jobs: title="$(gh api "repos/$REPOSITORY/pulls/$number" --jq .title)" scripts/ci/check-changelog-edits.sh "$base" "$title" + - name: Check docs/feature-parity/README.md matches features.yml + run: python3 scripts/feature-parity.py --check + # shellcheck cannot tell a library function from a command, so a missing source is exit 127 # at release time (v0.67.1). - name: Check every script sources the libraries it calls into diff --git a/AGENTS.md b/AGENTS.md index 82ce91de98..aae14f3845 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -9,7 +9,7 @@ Native database clients with a native UI per platform: `apple/` holds the macOS - `core/`: the shared Rust core's crates, its architecture and its cross-platform decisions. `Cargo.toml`, `Cargo.lock`, `rust-toolchain.toml`, `rustfmt.toml`, `clippy.toml`, `deny.toml` and `.config/nextest.toml` at the top are its Cargo workspace, which also holds the Linux app's crates. - `.github/`: workflows, actions, the PR template and `plugin-registry.json`. - `.claude/`: the path-scoped rules and the `fix-issue` and `release` skills, which Codex sees through `.agents/skills/`. -- `docs/feature-parity/`: which user-visible features each app has, in `features.yml` with the table generated from it by `scripts/parity/render.py`. A pull request that adds or finishes a feature updates its row. +- `docs/feature-parity/`: which of the macOS app's features the Linux and Windows apps have. `scripts/feature-parity.py` writes its `README.md` from `features.yml`. A pull request that brings a listed feature to Linux or Windows updates its row. - `scripts/`: `banned-words.txt` with `check-banned-words.sh`, the PR title and changed-path checks in `scripts/ci`, and the towncrier pin in `scripts/release`. - `appcast.xml`: the legacy feed apps up to 0.81 read from `main` (`apple/RELEASING.md`, Channels). - `.oss-scanner/`: the build image and threat model for Anthropic's OSS Scanner. Renaming a TableProCore target that `.oss-scanner/swift/Package.swift` lists updates it there too. diff --git a/docs/feature-parity/README.md b/docs/feature-parity/README.md index 44faebe121..beb7aaf7e9 100644 --- a/docs/feature-parity/README.md +++ b/docs/feature-parity/README.md @@ -1,135 +1,134 @@ # Feature parity -Which user-visible features each app has. The macOS app is the reference, and the Linux and Windows apps -follow its behavior. This file is generated: edit [`features.yml`](features.yml), then run -`python3 scripts/parity/render.py`. A pull request that adds or finishes a feature updates its row. +Which of the macOS app's features the Linux and Windows apps have. A feature with no row has not been compared yet. +What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ROADMAP.md#implemented). -Status: Yes is shipped. In PR is built in an open pull request. Partial says what ships. No is not built. -n/a does not apply. Unknown has not been checked. +`scripts/feature-parity.py` writes this file from [features.yml](features.yml). Edit that file, then run the script. -## Totals - -| | macOS | Linux | Windows | -|---|---|---|---| -| Yes | 64 | 26 | 0 | -| In a PR | 0 | 27 | 0 | -| Partial | 0 | 7 | 0 | -| No | 0 | 3 | 0 | -| n/a | 0 | 1 | 0 | -| Unknown | 0 | 0 | 64 | - -64 features. +| Status | Meaning | +|---|---| +| Yes | On `main`. | +| In #N | In that open pull request. | +| Partial | Part of it is on `main`. The note says which part. | +| No | Not built. | +| n/a | Does not apply to that app. The note says why. | +| Unknown | Not checked yet. | ## Connections -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Saved connections, groups, favourites and tags | Yes | Yes | Unknown | | -| SSH tunnels with jump hosts | Yes | Yes | Unknown | | -| Safe Mode per connection (off, confirm writes, read only) | Yes | Yes | Unknown | | -| Import connections from other apps | Yes | Yes | Unknown | DBX is read on Linux and Windows through the shared core (4147); the macOS importers are Swift and do not list it. | -| Application menu bar (File, Edit, View, Help) with Quit | Yes | In PR [#4139](https://github.com/TableProApp/TablePro/pull/4139): read by a global menu and assistive technology; GNOME draws none | Unknown | | -| Open another database of a server beside the connection | Yes | Yes | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Saved connections, groups, favorites and tags | Yes | Yes | +| SSH tunnels with jump hosts | Yes | Partial: no jump hosts | +| Safe Mode per connection (off, confirm writes, read only) | Yes | Partial: Confirm Writes does not ask before a write | +| Import connections from other apps | Yes | No: imports a TablePro JSON file only | +| Application menu with Quit | Yes: a main menu, since GNOME apps have no menu bar; [#4139](https://github.com/TableProApp/TablePro/pull/4139) splits the session's commands into a menu of their own | Yes | +| The server's other databases in the sidebar | Yes: each opened from the sidebar's menu | No | ## Sidebar -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Schemas and tables, with search | Yes | Yes | Unknown | | -| Tables and Favorites scope switch | Yes | In PR [#4114](https://github.com/TableProApp/TablePro/pull/4114) | Unknown | Linux lists the saved queries of the front connection, and renames and deletes them (4115). | -| Favorite folders | Yes | In PR [#4130](https://github.com/TableProApp/TablePro/pull/4130): on the storage of 4116 | Unknown | | -| Favorite keywords that expand in the editor | Yes | Partial ([#4116](https://github.com/TableProApp/TablePro/pull/4116)): storage only; the editor does not expand them yet | Unknown | Shared storage and the decision are core ADR 0017. | -| Favorite tables and databases, with environments | Yes | In PR [#4116](https://github.com/TableProApp/TablePro/pull/4116): storage only; no UI yet | Unknown | | -| Open Quickly (find a table by name) | Yes | In PR [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views, saved queries in 4133 and past queries in 4144; not databases, schemas, routines or other connections | Unknown | | -| Bottom bar with an Add menu and a schema picker | Yes | Partial ([#4146](https://github.com/TableProApp/TablePro/pull/4146)): the Add menu (table, schema, database); a Schemas menu filters the list (4150), with no active schema | Unknown | | -| A row's menu is shown whole, not cut with a scrollbar | Yes | In PR [#4149](https://github.com/TableProApp/TablePro/pull/4149) | Unknown | | -| Sidebar toggle in the window header | Yes | In PR [#4117](https://github.com/TableProApp/TablePro/pull/4117) | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Schemas and tables, with search | Yes | Yes | +| A schema's objects grouped by kind | In [#4159](https://github.com/TableProApp/TablePro/pull/4159) | Yes | +| Width set by dragging its edge | In [#4155](https://github.com/TableProApp/TablePro/pull/4155) | Yes | +| Toggle in the window header | Yes | Partial: View > Object Tree and Ctrl+B; no button in the title bar | +| Bottom bar with an Add menu | In [#4146](https://github.com/TableProApp/TablePro/pull/4146) | No | +| Choose which schemas the sidebar lists | In [#4150](https://github.com/TableProApp/TablePro/pull/4150) | No | +| Tables and Favorites scope switch | Yes | No | +| Favorite folders | In [#4130](https://github.com/TableProApp/TablePro/pull/4130) | No | +| Favorite keywords that expand in the editor | No | No | +| Favorite tables and databases, with environments | No | No | +| Open Quickly (find a table by name) | In [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views; saved queries in [#4133](https://github.com/TableProApp/TablePro/pull/4133), past queries in [#4144](https://github.com/TableProApp/TablePro/pull/4144) | Partial: Ctrl+P moves to the sidebar's filter | ## Data grid -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Virtualized grid with paging and an exact or estimated count | Yes | Yes | Unknown | | -| Alternate row shading | Yes | Yes | Unknown | | -| Values in the monospace font | Yes | Yes | Unknown | | -| Row numbers stay in view while scrolling sideways | Yes | In PR [#4110](https://github.com/TableProApp/TablePro/pull/4110) | Unknown | | -| Inline cell editing with pending changes, undo and redo | Yes | Yes | Unknown | | -| Filters per column and as a WHERE fragment | Yes | Yes | Unknown | | -| Open a referenced row and the rows that reference one | Yes | Yes | Unknown | | -| Highlight rules (colour rows by a condition) | Yes | In PR [#4127](https://github.com/TableProApp/TablePro/pull/4127): kept per table in 4129; not kept for a query result | Unknown | | -| The grid draws in the editor scheme's colours | Yes | In PR [#4128](https://github.com/TableProApp/TablePro/pull/4128) | Unknown | | -| Show row numbers, row height and the text shown for NULL | Yes | In PR [#4134](https://github.com/TableProApp/TablePro/pull/4134) | Unknown | | -| Font of the grid's cells | Yes | Partial ([#4135](https://github.com/TableProApp/TablePro/pull/4135)): family and size; no zoom | Unknown | | -| Date format of the cells | Yes | In PR [#4142](https://github.com/TableProApp/TablePro/pull/4142): cells only; copy and export keep the database's text | Unknown | | -| Default sort of a table (none, primary key, first column) | Yes | In PR [#4140](https://github.com/TableProApp/TablePro/pull/4140): one column | Unknown | | -| The format Copy writes for several rows | Yes | In PR [#4137](https://github.com/TableProApp/TablePro/pull/4137) | Unknown | | -| Open the row details when a row is selected | Yes | In PR [#4138](https://github.com/TableProApp/TablePro/pull/4138) | Unknown | | -| Set Empty, NULL or DEFAULT on every selected row | Yes | In PR [#4136](https://github.com/TableProApp/TablePro/pull/4136): Empty, NULL, DEFAULT and expressions | Unknown | | -| Mark spaces, tabs and line breaks in the value editor | Yes | In PR [#4141](https://github.com/TableProApp/TablePro/pull/4141) | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Virtualized grid with paging and an exact or estimated count | Yes | Yes | +| Alternate row shading | Yes | No | +| Values in the monospace font | Yes | No | +| Row numbers stay in view while scrolling sideways | Yes | Yes | +| Inline cell editing with pending changes, undo and redo | Yes | No | +| Filters per column and as a WHERE fragment | Yes | No | +| Open a referenced row and the rows that reference one | Yes | No | +| Set Value on every selected row (Empty, NULL, DEFAULT, UUID, an expression, any value) | Partial: Empty, NULL, DEFAULT and the engine's expressions | No | +| Show row numbers, row height and the text shown for NULL | Yes | No | +| Highlight rules (color rows and cells by a condition) | In [#4127](https://github.com/TableProApp/TablePro/pull/4127): kept per table in [#4129](https://github.com/TableProApp/TablePro/pull/4129) | No | +| The grid in the editor theme's colors | In [#4128](https://github.com/TableProApp/TablePro/pull/4128) | No | +| Font of the grid's cells, and zoom | In [#4135](https://github.com/TableProApp/TablePro/pull/4135): family and size; no zoom | No | +| Date format of the cells | In [#4142](https://github.com/TableProApp/TablePro/pull/4142) | No | +| Default sort of a table (none, primary key, first column) | In [#4140](https://github.com/TableProApp/TablePro/pull/4140) | No | +| The format Copy writes for several rows | In [#4137](https://github.com/TableProApp/TablePro/pull/4137) | No: copies tab-separated values only | +| Open the row details when a row is selected | In [#4138](https://github.com/TableProApp/TablePro/pull/4138) | No | +| Mark zero-width, control and special space characters in the value editor | No: [#4141](https://github.com/TableProApp/TablePro/pull/4141) marks spaces, tabs and line breaks instead | No | ## Bottom bar -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Columns button | Yes | In PR [#4118](https://github.com/TableProApp/TablePro/pull/4118) | Unknown | | -| Time a page or a query took | Yes | Partial ([#4119](https://github.com/TableProApp/TablePro/pull/4119)): query results show it; table pages in the pull request | Unknown | | -| Data and Structure in one tab | Yes | In PR [#4108](https://github.com/TableProApp/TablePro/pull/4108): one bar for it in 4111 | Unknown | | -| JSON view of the rows | Yes | In PR [#4122](https://github.com/TableProApp/TablePro/pull/4122): table tabs; not query results | Unknown | | -| Chart view of a result | Yes | No | Unknown | | -| Map view of a result | Yes | No | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Columns button | Yes | No | +| Time a page or a query took | Yes | Yes | +| Data and Structure in one tab | Yes | No | +| JSON view of the rows | In [#4122](https://github.com/TableProApp/TablePro/pull/4122): table tabs; not query results | No | +| Chart view of a result | No | No | +| Map view of a result | No | No | ## Row details -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Row details pane with an editor for the focused field | Yes | Yes | Unknown | | -| Field rows with type badge, key and edit marks | Yes | In PR [#4112](https://github.com/TableProApp/TablePro/pull/4112) | Unknown | | -| Field search and edited-only filter | Yes | In PR [#4113](https://github.com/TableProApp/TablePro/pull/4113) | Unknown | | -| An editor inside each field row | Yes | No | Unknown | | -| A row as JSON | Yes | Partial: a dialog from the grid menu, not a pane view | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Row details pane | Yes | No | +| Type, key and edit marks on a field | Yes | No | +| Foreign key mark on a field | In [#4131](https://github.com/TableProApp/TablePro/pull/4131) | No | +| Field search and an edited-only filter | Yes | No | +| A field drawn as its name over its value | In [#4156](https://github.com/TableProApp/TablePro/pull/4156) | No | +| An editor inside each field row | In [#4157](https://github.com/TableProApp/TablePro/pull/4157) | No | +| A menu on each field | In [#4158](https://github.com/TableProApp/TablePro/pull/4158) | No | +| A row as JSON | Partial: a dialog from the grid's menu, not a view of the row details | No | ## SQL editor -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Highlighting, completion, snippets and formatting | Yes | Yes | Unknown | | -| Move a query tab to another database | Yes | Yes | Unknown | | -| The chosen colour scheme is drawn as chosen | Yes | In PR [#4109](https://github.com/TableProApp/TablePro/pull/4109) | Unknown | | -| Dragging the results up keeps the query in view | Yes | In PR [#4120](https://github.com/TableProApp/TablePro/pull/4120) | Unknown | | -| Vim keybindings | Yes | Yes | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Highlighting, completion, snippets and formatting | Yes | Partial: highlighting only | +| Move a query tab to another database | Yes | No | +| Color schemes | Yes | No | +| Vim keybindings | Yes | No | ## Structure and schema -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Structure editor with a reviewed ALTER | Yes | Yes | Unknown | | -| ER diagram | Yes | Yes | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Structure editor with a reviewed ALTER | Yes | No | +| ER diagram | Yes | No | ## History, import and export -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Query history with search, pins and export | Yes | Yes | Unknown | | -| Saved queries | Yes | Yes | Unknown | | -| Export results (CSV, JSON, Markdown, HTML, XML, Excel, SQL) | Yes | Yes | Unknown | | -| Export a database as SQL and import a SQL file | Yes | Yes | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| Query history with search, pins and export | Yes | No | +| Saved queries | Yes | No | +| Export results (CSV, JSON, Markdown, HTML, XML, Excel, SQL) | Yes | No | +| Export a database as SQL and import a SQL file | Yes | No | -## Assistant, MCP and account +## Assistant, MCP, account and command line -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| AI assistant | Yes | Yes | Unknown | | -| MCP server for outside clients | Yes | Yes | Unknown | | -| TablePro account and entitlement | Yes | Yes | Unknown | | +| Feature | Linux | Windows | +|---|---|---| +| AI assistant | Yes | No | +| MCP server for outside clients | Yes | No | +| TablePro account and entitlement | Yes | No | +| The `tablepro` command line tool | In [#4145](https://github.com/TableProApp/TablePro/pull/4145) | No: `tablepro.exe` opens the app and reads no arguments | ## Window toolbar -| Feature | macOS | Linux | Windows | Notes | -|---|---|---|---|---| -| Safe Mode lock in the toolbar | Yes | In PR [#4124](https://github.com/TableProApp/TablePro/pull/4124) | Unknown | | -| Refresh button | Yes | In PR [#4125](https://github.com/TableProApp/TablePro/pull/4125) | Unknown | | -| Save Changes check | Yes | In PR [#4126](https://github.com/TableProApp/TablePro/pull/4126) | Unknown | | -| Connection and database chips | Yes | Partial: the title names the connection and the sidebar holds every open connection and database; no chips | Unknown | | -| Back and Forward through a tab's browse history | Yes | n/a: a referenced row opens in a new tab here, where macOS retargets the tab | Unknown | | -| Actions menu (Preview SQL, Show and Copy DDL, Users and Roles, Query Insights, Server Dashboard) | Yes | Partial: Show CREATE TABLE is in the sidebar's menu; the rest is not built | Unknown | | -| Reconnect after a lost connection | Yes | Yes | Unknown | On Linux it is the health banner's button. | +| Feature | Linux | Windows | +|---|---|---| +| Safe Mode level in the toolbar | In [#4124](https://github.com/TableProApp/TablePro/pull/4124) | No | +| Refresh button | Yes | Yes | +| Save Changes button | In [#4126](https://github.com/TableProApp/TablePro/pull/4126) | No | +| Connection and database chips | Partial: the title names the connection and the sidebar lists every open connection and database; no chips | Partial: the title bar names the connection; no database chip | +| Back and Forward through a tab's browse history | n/a: a referenced row opens in a new tab, where macOS moves the tab to it | No | +| Actions menu (Preview SQL, Show and Copy DDL, Users and Roles, Query Insights, Server Dashboard) | Partial: Show CREATE TABLE is in the sidebar's menu; the rest is not built | No | +| Reconnect after a lost connection | Yes | Yes | diff --git a/docs/feature-parity/features.yml b/docs/feature-parity/features.yml index 1bed38e5e9..e2e875ca1c 100644 --- a/docs/feature-parity/features.yml +++ b/docs/feature-parity/features.yml @@ -1,368 +1,240 @@ -# The one home of which user-visible features each app has. README.md in this -# folder is generated from it: python3 scripts/parity/render.py -# -# A platform's value is a status, or a mapping with `status` and optionally -# `pr` (a pull request number) and `note`. -# yes shipped -# pending built and in an open pull request, not shipped yet (give `pr`) -# partial some of it ships (say what in `note`) -# no not built -# na does not apply to this platform -# unknown nobody has checked -# macOS is the reference: the other two follow its behavior (see each app's AGENTS.md). +# The rows of README.md, which scripts/feature-parity.py writes from this file. README.md explains +# the statuses. A value is a status, or a mapping of status, pr and note. areas: - name: Connections features: - - id: saved-connections - name: Saved connections, groups, favourites and tags - macos: yes - linux: yes - windows: unknown - - id: ssh-tunnel - name: SSH tunnels with jump hosts - macos: yes - linux: yes - windows: unknown - - id: safe-mode - name: Safe Mode per connection (off, confirm writes, read only) - macos: yes - linux: yes - windows: unknown - - id: import-from-apps - name: Import connections from other apps - macos: yes - linux: yes - windows: unknown - notes: DBX is read on Linux and Windows through the shared core (4147); the macOS importers are Swift and do not list it. - - id: app-menu-bar - name: Application menu bar (File, Edit, View, Help) with Quit - macos: yes - linux: {status: pending, pr: 4139, note: "read by a global menu and assistive technology; GNOME draws none"} - windows: unknown - - id: open-database-beside - name: Open another database of a server beside the connection - macos: yes - linux: yes - windows: unknown + - name: Saved connections, groups, favorites and tags + linux: yes + windows: yes + - name: SSH tunnels with jump hosts + linux: yes + windows: {status: partial, note: "no jump hosts"} + - name: Safe Mode per connection (off, confirm writes, read only) + linux: yes + windows: {status: partial, note: "Confirm Writes does not ask before a write"} + - name: Import connections from other apps + linux: yes + windows: {status: no, note: "imports a TablePro JSON file only"} + - name: Application menu with Quit + linux: {status: yes, note: "a main menu, since GNOME apps have no menu bar; #4139 splits the session's commands into a menu of their own"} + windows: yes + - name: The server's other databases in the sidebar + linux: {status: yes, note: "each opened from the sidebar's menu"} + windows: no - name: Sidebar features: - - id: tables-tree - name: Schemas and tables, with search - macos: yes - linux: yes - windows: unknown - - id: favorites-scope - name: Tables and Favorites scope switch - macos: yes - linux: {status: pending, pr: 4114} - windows: unknown - notes: Linux lists the saved queries of the front connection, and renames and deletes them (4115). - - id: favorites-folders - name: Favorite folders - macos: yes - linux: {status: pending, pr: 4130, note: "on the storage of 4116"} - windows: unknown - - id: favorites-keywords - name: Favorite keywords that expand in the editor - macos: yes - linux: {status: partial, pr: 4116, note: "storage only; the editor does not expand them yet"} - windows: unknown - notes: "Shared storage and the decision are core ADR 0017." - - id: favorite-tables-databases - name: Favorite tables and databases, with environments - macos: yes - linux: {status: pending, pr: 4116, note: "storage only; no UI yet"} - windows: unknown - - id: quick-switcher - name: Open Quickly (find a table by name) - macos: yes - linux: {status: pending, pr: 4121, note: "tables and views, saved queries in 4133 and past queries in 4144; not databases, schemas, routines or other connections"} - windows: unknown - - id: sidebar-footer - name: Bottom bar with an Add menu and a schema picker - macos: yes - linux: {status: partial, pr: 4146, note: "the Add menu (table, schema, database); a Schemas menu filters the list (4150), with no active schema"} - windows: unknown - - id: sidebar-menu-size - name: A row's menu is shown whole, not cut with a scrollbar - macos: yes - linux: {status: pending, pr: 4149} - windows: unknown - - id: sidebar-toggle - name: Sidebar toggle in the window header - macos: yes - linux: {status: pending, pr: 4117} - windows: unknown + - name: Schemas and tables, with search + linux: yes + windows: yes + - name: A schema's objects grouped by kind + linux: {status: pending, pr: 4159} + windows: yes + - name: Width set by dragging its edge + linux: {status: pending, pr: 4155} + windows: yes + - name: Toggle in the window header + linux: yes + windows: {status: partial, note: "View > Object Tree and Ctrl+B; no button in the title bar"} + - name: Bottom bar with an Add menu + linux: {status: pending, pr: 4146} + windows: no + - name: Choose which schemas the sidebar lists + linux: {status: pending, pr: 4150} + windows: no + - name: Tables and Favorites scope switch + linux: yes + windows: no + - name: Favorite folders + linux: {status: pending, pr: 4130} + windows: no + - name: Favorite keywords that expand in the editor + linux: no + windows: no + - name: Favorite tables and databases, with environments + linux: no + windows: no + - name: Open Quickly (find a table by name) + linux: {status: pending, pr: 4121, note: "tables and views; saved queries in #4133, past queries in #4144"} + windows: {status: partial, note: "Ctrl+P moves to the sidebar's filter"} - name: Data grid features: - - id: virtual-grid - name: Virtualized grid with paging and an exact or estimated count - macos: yes - linux: yes - windows: unknown - - id: grid-alternate-rows - name: Alternate row shading - macos: yes - linux: yes - windows: unknown - - id: grid-monospace - name: Values in the monospace font - macos: yes - linux: yes - windows: unknown - - id: pinned-row-numbers - name: Row numbers stay in view while scrolling sideways - macos: yes - linux: {status: pending, pr: 4110} - windows: unknown - - id: cell-editing - name: Inline cell editing with pending changes, undo and redo - macos: yes - linux: yes - windows: unknown - - id: filters - name: Filters per column and as a WHERE fragment - macos: yes - linux: yes - windows: unknown - - id: foreign-key-navigation - name: Open a referenced row and the rows that reference one - macos: yes - linux: yes - windows: unknown - - id: highlight-rules - name: Highlight rules (colour rows by a condition) - macos: yes - linux: {status: pending, pr: 4127, note: "kept per table in 4129; not kept for a query result"} - windows: unknown - - id: grid-scheme-colors - name: The grid draws in the editor scheme's colours - macos: yes + - name: Virtualized grid with paging and an exact or estimated count + linux: yes + windows: yes + - name: Alternate row shading + linux: yes + windows: no + - name: Values in the monospace font + linux: yes + windows: no + - name: Row numbers stay in view while scrolling sideways + linux: yes + windows: yes + - name: Inline cell editing with pending changes, undo and redo + linux: yes + windows: no + - name: Filters per column and as a WHERE fragment + linux: yes + windows: no + - name: Open a referenced row and the rows that reference one + linux: yes + windows: no + - name: Set Value on every selected row (Empty, NULL, DEFAULT, UUID, an expression, any value) + linux: {status: partial, note: "Empty, NULL, DEFAULT and the engine's expressions"} + windows: no + - name: Show row numbers, row height and the text shown for NULL + linux: yes + windows: no + - name: Highlight rules (color rows and cells by a condition) + linux: {status: pending, pr: 4127, note: "kept per table in #4129"} + windows: no + - name: The grid in the editor theme's colors linux: {status: pending, pr: 4128} - windows: unknown - - - id: grid-row-display - name: Show row numbers, row height and the text shown for NULL - macos: yes - linux: {status: pending, pr: 4134} - windows: unknown - - id: grid-cell-font - name: Font of the grid's cells - macos: yes - linux: {status: partial, pr: 4135, note: "family and size; no zoom"} - windows: unknown - - id: grid-date-format - name: Date format of the cells - macos: yes - linux: {status: pending, pr: 4142, note: "cells only; copy and export keep the database's text"} - windows: unknown - - id: grid-default-sort - name: Default sort of a table (none, primary key, first column) - macos: yes - linux: {status: pending, pr: 4140, note: "one column"} - windows: unknown - - id: grid-copy-format - name: The format Copy writes for several rows - macos: yes + windows: no + - name: Font of the grid's cells, and zoom + linux: {status: pending, pr: 4135, note: "family and size; no zoom"} + windows: no + - name: Date format of the cells + linux: {status: pending, pr: 4142} + windows: no + - name: Default sort of a table (none, primary key, first column) + linux: {status: pending, pr: 4140} + windows: no + - name: The format Copy writes for several rows linux: {status: pending, pr: 4137} - windows: unknown - - id: grid-auto-inspector - name: Open the row details when a row is selected - macos: yes + windows: {status: no, note: "copies tab-separated values only"} + - name: Open the row details when a row is selected linux: {status: pending, pr: 4138} - windows: unknown - - id: grid-set-value - name: Set Empty, NULL or DEFAULT on every selected row - macos: yes - linux: {status: pending, pr: 4136, note: "Empty, NULL, DEFAULT and expressions"} - windows: unknown - - id: grid-invisibles - name: Mark spaces, tabs and line breaks in the value editor - macos: yes - linux: {status: pending, pr: 4141} - windows: unknown + windows: no + - name: Mark zero-width, control and special space characters in the value editor + linux: {status: no, note: "#4141 marks spaces, tabs and line breaks instead"} + windows: no - name: Bottom bar features: - - id: bar-columns - name: Columns button - macos: yes - linux: {status: pending, pr: 4118} - windows: unknown - - id: bar-timing - name: Time a page or a query took - macos: yes - linux: {status: partial, pr: 4119, note: "query results show it; table pages in the pull request"} - windows: unknown - - id: bar-structure - name: Data and Structure in one tab - macos: yes - linux: {status: pending, pr: 4108, note: "one bar for it in 4111"} - windows: unknown - - id: bar-json - name: JSON view of the rows - macos: yes + - name: Columns button + linux: yes + windows: no + - name: Time a page or a query took + linux: yes + windows: yes + - name: Data and Structure in one tab + linux: yes + windows: no + - name: JSON view of the rows linux: {status: pending, pr: 4122, note: "table tabs; not query results"} - windows: unknown - - id: bar-chart - name: Chart view of a result - macos: yes + windows: no + - name: Chart view of a result linux: no - windows: unknown - - id: bar-map - name: Map view of a result - macos: yes + windows: no + - name: Map view of a result linux: no - windows: unknown + windows: no - name: Row details features: - - id: row-details-pane - name: Row details pane with an editor for the focused field - macos: yes - linux: yes - windows: unknown - - id: row-details-look - name: Field rows with type badge, key and edit marks - macos: yes - linux: {status: pending, pr: 4112} - windows: unknown - - id: row-details-search - name: Field search and edited-only filter - macos: yes - linux: {status: pending, pr: 4113} - windows: unknown - - id: row-details-inline - name: An editor inside each field row - macos: yes - linux: no - windows: unknown - - id: row-json - name: A row as JSON - macos: yes - linux: {status: partial, note: "a dialog from the grid menu, not a pane view"} - windows: unknown + - name: Row details pane + linux: yes + windows: no + - name: Type, key and edit marks on a field + linux: yes + windows: no + - name: Foreign key mark on a field + linux: {status: pending, pr: 4131} + windows: no + - name: Field search and an edited-only filter + linux: yes + windows: no + - name: A field drawn as its name over its value + linux: {status: pending, pr: 4156} + windows: no + - name: An editor inside each field row + linux: {status: pending, pr: 4157} + windows: no + - name: A menu on each field + linux: {status: pending, pr: 4158} + windows: no + - name: A row as JSON + linux: {status: partial, note: "a dialog from the grid's menu, not a view of the row details"} + windows: no - name: SQL editor features: - - id: editor-basics - name: Highlighting, completion, snippets and formatting - macos: yes - linux: yes - windows: unknown - - id: editor-database-switch - name: Move a query tab to another database - macos: yes - linux: yes - windows: unknown - - id: editor-scheme - name: The chosen colour scheme is drawn as chosen - macos: yes - linux: {status: pending, pr: 4109} - windows: unknown - - id: editor-divider - name: Dragging the results up keeps the query in view - macos: yes - linux: {status: pending, pr: 4120} - windows: unknown - - id: vim-mode - name: Vim keybindings - macos: yes - linux: yes - windows: unknown + - name: Highlighting, completion, snippets and formatting + linux: yes + windows: {status: partial, note: "highlighting only"} + - name: Move a query tab to another database + linux: yes + windows: no + - name: Color schemes + linux: yes + windows: no + - name: Vim keybindings + linux: yes + windows: no - name: Structure and schema features: - - id: structure-editor - name: Structure editor with a reviewed ALTER - macos: yes + - name: Structure editor with a reviewed ALTER linux: yes - windows: unknown - - id: er-diagram - name: ER diagram - macos: yes + windows: no + - name: ER diagram linux: yes - windows: unknown + windows: no - name: History, import and export features: - - id: query-history - name: Query history with search, pins and export - macos: yes - linux: yes - windows: unknown - - id: saved-queries - name: Saved queries - macos: yes - linux: yes - windows: unknown - - id: export-results - name: Export results (CSV, JSON, Markdown, HTML, XML, Excel, SQL) - macos: yes - linux: yes - windows: unknown - - id: sql-dump - name: Export a database as SQL and import a SQL file - macos: yes - linux: yes - windows: unknown + - name: Query history with search, pins and export + linux: yes + windows: no + - name: Saved queries + linux: yes + windows: no + - name: Export results (CSV, JSON, Markdown, HTML, XML, Excel, SQL) + linux: yes + windows: no + - name: Export a database as SQL and import a SQL file + linux: yes + windows: no - - name: Assistant, MCP and account + - name: Assistant, MCP, account and command line features: - - id: ai-assistant - name: AI assistant - macos: yes + - name: AI assistant linux: yes - windows: unknown - - id: mcp-server - name: MCP server for outside clients - macos: yes + windows: no + - name: MCP server for outside clients linux: yes - windows: unknown - - id: account - name: TablePro account and entitlement - macos: yes + windows: no + - name: TablePro account and entitlement linux: yes - windows: unknown + windows: no + - name: The `tablepro` command line tool + linux: {status: pending, pr: 4145} + windows: {status: no, note: "`tablepro.exe` opens the app and reads no arguments"} - name: Window toolbar features: - - id: toolbar-safe-mode - name: Safe Mode lock in the toolbar - macos: yes + - name: Safe Mode level in the toolbar linux: {status: pending, pr: 4124} - windows: unknown - - id: toolbar-refresh - name: Refresh button - macos: yes - linux: {status: pending, pr: 4125} - windows: unknown - - id: toolbar-save-changes - name: Save Changes check - macos: yes + windows: no + - name: Refresh button + linux: yes + windows: yes + - name: Save Changes button linux: {status: pending, pr: 4126} - windows: unknown - - id: toolbar-chips - name: Connection and database chips - macos: yes - linux: {status: partial, note: "the title names the connection and the sidebar holds every open connection and database; no chips"} - windows: unknown - - id: toolbar-back-forward - name: Back and Forward through a tab's browse history - macos: yes - linux: {status: na, note: "a referenced row opens in a new tab here, where macOS retargets the tab"} - windows: unknown - - id: toolbar-actions-menu - name: Actions menu (Preview SQL, Show and Copy DDL, Users and Roles, Query Insights, Server Dashboard) - macos: yes + windows: no + - name: Connection and database chips + linux: {status: partial, note: "the title names the connection and the sidebar lists every open connection and database; no chips"} + windows: {status: partial, note: "the title bar names the connection; no database chip"} + - name: Back and Forward through a tab's browse history + linux: {status: na, note: "a referenced row opens in a new tab, where macOS moves the tab to it"} + windows: no + - name: Actions menu (Preview SQL, Show and Copy DDL, Users and Roles, Query Insights, Server Dashboard) linux: {status: partial, note: "Show CREATE TABLE is in the sidebar's menu; the rest is not built"} - windows: unknown - - id: toolbar-reconnect - name: Reconnect after a lost connection - macos: yes + windows: no + - name: Reconnect after a lost connection linux: yes - windows: unknown - notes: On Linux it is the health banner's button. + windows: yes diff --git a/linux/ROADMAP.md b/linux/ROADMAP.md index 1e3f1694fb..160304c6d6 100644 --- a/linux/ROADMAP.md +++ b/linux/ROADMAP.md @@ -183,7 +183,7 @@ The app runs on GNOME 50 ([ADR 0015](docs/decisions/0015-gnome-50-platform-floor ## Backlog -Remaining work and known issues, in no order. +Remaining work and known issues, in no order. The macOS app's features this app lacks are in the [feature parity table](../docs/feature-parity/README.md). ### Connections diff --git a/scripts/ci/test_feature_parity.py b/scripts/ci/test_feature_parity.py new file mode 100644 index 0000000000..e8c6f67382 --- /dev/null +++ b/scripts/ci/test_feature_parity.py @@ -0,0 +1,96 @@ +#!/usr/bin/env python3 + +import importlib.util +import tempfile +import unittest +from pathlib import Path + +SCRIPT = Path(__file__).resolve().parent.parent / "feature-parity.py" +SPEC = importlib.util.spec_from_file_location("feature_parity", SCRIPT) +parity = importlib.util.module_from_spec(SPEC) +SPEC.loader.exec_module(parity) + + +def registry(*rows): + features = "".join( + f" - name: {name}\n linux: {linux}\n windows: {windows}\n" for name, linux, windows in rows + ) + return f"areas:\n - name: Area\n features:\n{features}" + + +def load(text): + with tempfile.TemporaryDirectory() as folder: + path = Path(folder) / "features.yml" + path.write_text(text, encoding="utf-8") + return parity.load(path) + + +def rendered(text): + return parity.render(load(text)) + + +class LoadTests(unittest.TestCase): + def test_yes_and_no_stay_statuses(self): + [(_, [(_, cells)])] = load(registry(("A feature", "yes", "no"))) + self.assertEqual(cells, [("yes", None, None), ("no", None, None)]) + + def test_a_pending_feature_names_its_pull_request(self): + with self.assertRaisesRegex(parity.RegistryError, "pr names"): + load(registry(("A feature", "pending", "unknown"))) + + def test_only_a_pending_feature_names_a_pull_request(self): + with self.assertRaisesRegex(parity.RegistryError, "pr names"): + load(registry(("A feature", "{status: yes, pr: 4121}", "unknown"))) + + def test_a_pull_request_is_a_number(self): + with self.assertRaisesRegex(parity.RegistryError, "not a pull request number"): + load(registry(("A feature", "{status: pending, pr: soon}", "unknown"))) + + def test_a_partial_or_na_feature_says_why(self): + for status in ("partial", "na"): + with self.subTest(status=status), self.assertRaisesRegex(parity.RegistryError, "says why"): + load(registry(("A feature", status, "unknown"))) + + def test_an_unknown_status_is_refused(self): + with self.assertRaisesRegex(parity.RegistryError, "is not one of"): + load(registry(("A feature", "done", "unknown"))) + + def test_a_feature_names_both_apps_and_nothing_else(self): + missing = "areas:\n - name: Area\n features:\n - name: A feature\n linux: yes\n" + with self.assertRaisesRegex(parity.RegistryError, "exactly"): + load(missing) + with self.assertRaisesRegex(parity.RegistryError, "exactly"): + load(registry(("A feature", "yes", "yes")) + " macos: yes\n") + + def test_a_feature_is_listed_once(self): + with self.assertRaisesRegex(parity.RegistryError, "listed twice"): + load(registry(("A feature", "yes", "yes"), ("A feature", "no", "no"))) + + def test_a_note_is_one_line(self): + text = registry(("A feature", "{status: partial, note: x}", "unknown")).replace("note: x", 'note: "a\\nb"') + with self.assertRaisesRegex(parity.RegistryError, "one line"): + load(text) + + +class RenderTests(unittest.TestCase): + def test_a_pending_feature_links_its_pull_request(self): + text = rendered(registry(("A feature", "{status: pending, pr: 4121}", "unknown"))) + self.assertIn("| A feature | In [#4121](https://github.com/TableProApp/TablePro/pull/4121) | Unknown |", text) + + def test_a_note_follows_the_status_and_links_its_pull_requests(self): + text = rendered(registry(("A feature", '{status: partial, note: "tables only, views in #4133"}', "no"))) + link = "[#4133](https://github.com/TableProApp/TablePro/pull/4133)" + self.assertIn(f"| A feature | Partial: tables only, views in {link} | No |", text) + + def test_a_pipe_does_not_end_the_cell(self): + text = rendered(registry(("A feature", "{status: na, note: 'a | b'}", "yes"))) + self.assertIn("| n/a: a \\| b | Yes |", text) + + def test_every_status_is_in_the_legend(self): + text = rendered(registry(("A feature", "yes", "yes"))) + for label, meaning in parity.STATUSES.values(): + self.assertIn(f"| {label} | {meaning} |", text) + + +if __name__ == "__main__": + unittest.main() diff --git a/scripts/ci/test_parity.py b/scripts/ci/test_parity.py deleted file mode 100644 index 0013e6639c..0000000000 --- a/scripts/ci/test_parity.py +++ /dev/null @@ -1,90 +0,0 @@ -#!/usr/bin/env python3 -"""Tests the feature parity registry and the README rendered from it.""" - -import importlib.util -import tempfile -import unittest -from pathlib import Path - -RENDER = Path(__file__).resolve().parents[1] / "parity" / "render.py" -spec = importlib.util.spec_from_file_location("parity_render", RENDER) -render = importlib.util.module_from_spec(spec) -spec.loader.exec_module(render) - - -def areas_of(text): - with tempfile.TemporaryDirectory() as folder: - path = Path(folder) / "features.yml" - path.write_text(text, encoding="utf-8") - return render.load(path) - - -def feature(extra="", ident="a", macos="yes", linux="yes", windows="unknown"): - return f""" -areas: - - name: Area - features: - - id: {ident} - name: A feature - macos: {macos} - linux: {linux} - windows: {windows} -{extra}""" - - -class ParityTests(unittest.TestCase): - def test_the_committed_registry_is_valid_and_its_readme_is_current(self): - areas = render.load() - self.assertTrue(areas) - self.assertEqual(render.TARGET.read_text(encoding="utf-8"), render.render(areas)) - - def test_a_bare_yes_and_no_are_read_as_statuses(self): - areas = areas_of(feature(linux="no")) - cells = areas[0]["features"][0]["cells"] - self.assertEqual(cells["macos"][0], "yes") - self.assertEqual(cells["linux"][0], "no") - - def test_a_pending_feature_links_its_pull_request(self): - text = feature(linux="{status: pending, pr: 4114}") - rendered = render.render(areas_of(text)) - self.assertIn("In PR [#4114](https://github.com/TableProApp/TablePro/pull/4114)", rendered) - - def test_a_pending_feature_without_a_pull_request_is_refused(self): - with self.assertRaisesRegex(render.ParityError, "pull request"): - areas_of(feature(linux="{status: pending}")) - - def test_an_unknown_status_is_refused(self): - with self.assertRaisesRegex(render.ParityError, "status"): - areas_of(feature(linux="done")) - - def test_a_missing_platform_is_refused(self): - text = """ -areas: - - name: Area - features: - - id: a - name: A feature - macos: yes - linux: yes -""" - with self.assertRaisesRegex(render.ParityError, "windows"): - areas_of(text) - - def test_an_id_is_used_once(self): - text = feature() + """ - - id: a - name: Again - macos: yes - linux: yes - windows: yes -""" - with self.assertRaisesRegex(render.ParityError, "twice"): - areas_of(text) - - def test_a_pipe_in_a_note_does_not_break_the_table(self): - rendered = render.render(areas_of(feature(linux="{status: partial, note: 'a | b'}"))) - self.assertIn("Partial: a \\| b", rendered) - - -if __name__ == "__main__": - unittest.main() diff --git a/scripts/feature-parity.py b/scripts/feature-parity.py new file mode 100755 index 0000000000..98a8b69298 --- /dev/null +++ b/scripts/feature-parity.py @@ -0,0 +1,147 @@ +#!/usr/bin/env python3 +"""Write docs/feature-parity/README.md from docs/feature-parity/features.yml. + +Usage: + scripts/feature-parity.py write README.md + scripts/feature-parity.py --check fail when features.yml is invalid or README.md is not what it writes +""" + +import argparse +import re +import sys +from pathlib import Path + +import yaml + +ROOT = Path(__file__).resolve().parent.parent +SOURCE = ROOT / "docs" / "feature-parity" / "features.yml" +TARGET = SOURCE.with_name("README.md") +PULL = "https://github.com/TableProApp/TablePro/pull/" + +PLATFORMS = (("linux", "Linux"), ("windows", "Windows")) +STATUSES = { + "yes": ("Yes", "On `main`."), + "pending": ("In #N", "In that open pull request."), + "partial": ("Partial", "Part of it is on `main`. The note says which part."), + "no": ("No", "Not built."), + "na": ("n/a", "Does not apply to that app. The note says why."), + "unknown": ("Unknown", "Not checked yet."), +} +NEEDS_NOTE = {"partial", "na"} +NUMBER = re.compile(r"[1-9][0-9]*") +REFERENCE = re.compile(r"#([1-9][0-9]*)\b") + +HEADER = """# Feature parity + +Which of the macOS app's features the Linux and Windows apps have. A feature with no row has not been compared yet. +What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ROADMAP.md#implemented). + +`scripts/feature-parity.py` writes this file from [features.yml](features.yml). Edit that file, then run the script. + +| Status | Meaning | +|---|---| +""" + + +class RegistryError(ValueError): + pass + + +def one_line(text, where, what): + if not isinstance(text, str) or not text.strip() or "\n" in text: + raise RegistryError(f"{where}: {what} is one line of text") + return text.strip() + + +def cell(value, where): + if isinstance(value, str): + value = {"status": value} + if not isinstance(value, dict): + raise RegistryError(f"{where}: give a status, or a mapping of status, pr and note") + extra = sorted(set(value) - {"status", "pr", "note"}) + if extra: + raise RegistryError(f"{where}: unknown keys {', '.join(extra)}") + status, pr, note = value.get("status"), value.get("pr"), value.get("note") + if status not in STATUSES: + raise RegistryError(f"{where}: status {status!r} is not one of {', '.join(STATUSES)}") + if (status == "pending") != (pr is not None): + raise RegistryError(f"{where}: pr names the open pull request of a pending feature, and only of one") + if pr is not None and not (isinstance(pr, str) and NUMBER.fullmatch(pr)): + raise RegistryError(f"{where}: pr {pr!r} is not a pull request number") + if note is not None: + note = one_line(note, where, "note") + elif status in NEEDS_NOTE: + raise RegistryError(f"{where}: a {status} feature says why in a note") + return status, pr, note + + +def load(path): + # BaseLoader keeps every scalar a string, so yes and no stay statuses instead of YAML 1.1 booleans. + with Path(path).open(encoding="utf-8") as handle: + document = yaml.load(handle, Loader=yaml.BaseLoader) + areas = document.get("areas") if isinstance(document, dict) else None + if not isinstance(areas, list) or not areas: + raise RegistryError("give a list of areas") + names = set() + loaded = [] + for area in areas: + if not isinstance(area, dict) or set(area) != {"name", "features"}: + raise RegistryError("an area has a name and features, and nothing else") + title = one_line(area["name"], "area", "name") + if not isinstance(area["features"], list) or not area["features"]: + raise RegistryError(f"{title}: give a list of features") + features = [] + for feature in area["features"]: + expected = {"name"} | {key for key, _ in PLATFORMS} + if not isinstance(feature, dict) or set(feature) != expected: + raise RegistryError(f"{title}: a feature has exactly {', '.join(sorted(expected))}") + name = one_line(feature["name"], title, "name") + if name in names: + raise RegistryError(f"{name}: listed twice") + names.add(name) + cells = [cell(feature[key], f"{name}, {key}") for key, _ in PLATFORMS] + features.append((name, cells)) + loaded.append((title, features)) + return loaded + + +def linked(text): + return REFERENCE.sub(lambda match: f"[#{match[1]}]({PULL}{match[1]})", text.replace("|", "\\|")) + + +def shown(status, pr, note): + text = f"In [#{pr}]({PULL}{pr})" if status == "pending" else STATUSES[status][0] + return f"{text}: {linked(note)}" if note else text + + +def render(areas): + lines = [HEADER.rstrip("\n")] + lines += [f"| {label} | {meaning} |" for label, meaning in STATUSES.values()] + header = "| Feature | " + " | ".join(label for _, label in PLATFORMS) + " |" + for title, features in areas: + lines += ["", f"## {title}", "", header, "|---" * (len(PLATFORMS) + 1) + "|"] + for name, cells in features: + lines.append("| " + " | ".join([linked(name)] + [shown(*value) for value in cells]) + " |") + return "\n".join(lines) + "\n" + + +def main(argv=None): + parser = argparse.ArgumentParser(description="Write docs/feature-parity/README.md from features.yml.") + parser.add_argument("--check", action="store_true", help="fail when README.md is not what features.yml writes") + arguments = parser.parse_args(argv) + try: + text = render(load(SOURCE)) + except (OSError, yaml.YAMLError, RegistryError) as error: + print(f"{SOURCE.relative_to(ROOT)}: {error}", file=sys.stderr) + return 1 + if not arguments.check: + TARGET.write_text(text, encoding="utf-8") + return 0 + if not TARGET.is_file() or TARGET.read_text(encoding="utf-8") != text: + print(f"{TARGET.relative_to(ROOT)} is stale. Run scripts/feature-parity.py", file=sys.stderr) + return 1 + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/scripts/parity/render.py b/scripts/parity/render.py deleted file mode 100644 index ffc72e0ea8..0000000000 --- a/scripts/parity/render.py +++ /dev/null @@ -1,162 +0,0 @@ -#!/usr/bin/env python3 -"""Check docs/feature-parity/features.yml and write the table in README.md from it. - - python3 scripts/parity/render.py write README.md - python3 scripts/parity/render.py --check fail when README.md is not what features.yml renders -""" - -import argparse -import sys -from pathlib import Path - -import yaml - -ROOT = Path(__file__).resolve().parents[2] -FOLDER = ROOT / "docs" / "feature-parity" -SOURCE = FOLDER / "features.yml" -TARGET = FOLDER / "README.md" -REPOSITORY = "https://github.com/TableProApp/TablePro" - -PLATFORMS = (("macos", "macOS"), ("linux", "Linux"), ("windows", "Windows")) -STATUSES = { - "yes": "Yes", - "pending": "In a PR", - "partial": "Partial", - "no": "No", - "na": "n/a", - "unknown": "Unknown", -} - - -class ParityError(ValueError): - pass - - -def cell_of(value, where): - """The status, pull request and note a platform's value stands for.""" - # YAML 1.1 reads a bare yes and no as booleans. - if isinstance(value, bool): - value = "yes" if value else "no" - if isinstance(value, str): - value = {"status": value} - if not isinstance(value, dict): - raise ParityError(f"{where}: a platform is a status or a mapping") - unknown = set(value) - {"status", "pr", "note"} - if unknown: - raise ParityError(f"{where}: unknown keys {sorted(unknown)}") - status = value.get("status") - if isinstance(status, bool): - status = "yes" if status else "no" - if status not in STATUSES: - raise ParityError(f"{where}: status {status!r} is not one of {sorted(STATUSES)}") - pr = value.get("pr") - if pr is not None and (not isinstance(pr, int) or isinstance(pr, bool) or pr <= 0): - raise ParityError(f"{where}: pr is a pull request number") - if status == "pending" and pr is None: - raise ParityError(f"{where}: a pending feature names its pull request") - note = value.get("note") - if note is not None and not isinstance(note, str): - raise ParityError(f"{where}: note is text") - return status, pr, note - - -def load(path=SOURCE): - """The areas of `path`, each feature with its three cells checked.""" - document = yaml.safe_load(Path(path).read_text(encoding="utf-8")) - if not isinstance(document, dict) or not isinstance(document.get("areas"), list): - raise ParityError("features.yml holds a list of areas") - seen = set() - areas = [] - for area in document["areas"]: - features = [] - for feature in area.get("features", []): - name = feature.get("name") - ident = feature.get("id") - if not name or not ident: - raise ParityError(f"{area.get('name')}: a feature needs an id and a name") - if ident in seen: - raise ParityError(f"{ident}: the id is used twice") - seen.add(ident) - cells = {} - for key, _ in PLATFORMS: - if key not in feature: - raise ParityError(f"{ident}: no value for {key}") - cells[key] = cell_of(feature[key], f"{ident}.{key}") - features.append({"id": ident, "name": name, "cells": cells, "notes": feature.get("notes", "")}) - if not area.get("name") or not features: - raise ParityError("an area needs a name and features") - areas.append({"name": area["name"], "features": features}) - return areas - - -def shown(cell): - status, pr, note = cell - text = STATUSES[status] - if status == "pending": - text = f"In PR [#{pr}]({REPOSITORY}/pull/{pr})" - elif pr is not None: - text = f"{text} ([#{pr}]({REPOSITORY}/pull/{pr}))" - if note: - text = f"{text}: {note}" - return text.replace("|", "\\|") - - -def render(areas): - lines = [ - "# Feature parity", - "", - "Which user-visible features each app has. The macOS app is the reference, and the Linux and Windows apps", - "follow its behavior. This file is generated: edit [`features.yml`](features.yml), then run", - "`python3 scripts/parity/render.py`. A pull request that adds or finishes a feature updates its row.", - "", - "Status: Yes is shipped. In PR is built in an open pull request. Partial says what ships. No is not built.", - "n/a does not apply. Unknown has not been checked.", - "", - "## Totals", - "", - "| | " + " | ".join(label for _, label in PLATFORMS) + " |", - "|---|" + "---|" * len(PLATFORMS), - ] - total = sum(len(area["features"]) for area in areas) - for status, label in STATUSES.items(): - counts = [ - sum(1 for area in areas for f in area["features"] if f["cells"][key][0] == status) - for key, _ in PLATFORMS - ] - if any(counts): - lines.append(f"| {label} | " + " | ".join(str(count) for count in counts) + " |") - lines += ["", f"{total} features.", ""] - for area in areas: - lines += [ - f"## {area['name']}", - "", - "| Feature | " + " | ".join(label for _, label in PLATFORMS) + " | Notes |", - "|---|" + "---|" * (len(PLATFORMS) + 1), - ] - for feature in area["features"]: - row = " | ".join(shown(feature["cells"][key]) for key, _ in PLATFORMS) - lines.append(f"| {feature['name']} | {row} | {feature['notes'].replace('|', chr(92) + '|')} |") - lines.append("") - return "\n".join(lines) - - -def main(argv=None): - parser = argparse.ArgumentParser(description=__doc__.splitlines()[0]) - parser.add_argument("--check", action="store_true", help="fail when README.md is out of date") - arguments = parser.parse_args(argv) - try: - text = render(load()) - except ParityError as error: - print(f"features.yml: {error}", file=sys.stderr) - return 1 - if arguments.check: - if not TARGET.exists() or TARGET.read_text(encoding="utf-8") != text: - print("docs/feature-parity/README.md is out of date: run python3 scripts/parity/render.py", file=sys.stderr) - return 1 - return 0 - TARGET.write_text(text, encoding="utf-8") - return 0 - - -if __name__ == "__main__": - sys.exit(main()) From 49382e339490fd60583443304d7cf2178ad429e6 Mon Sep 17 00:00:00 2001 From: Ngo Quoc Dat Date: Fri, 13 Nov 2026 04:34:12 +0700 Subject: [PATCH 7/7] docs(parity): mark merged and closed pull requests as of 2026-11-13 --- docs/feature-parity/README.md | 46 ++++++++++++++++---------------- docs/feature-parity/features.yml | 46 ++++++++++++++++---------------- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/feature-parity/README.md b/docs/feature-parity/README.md index beb7aaf7e9..e1b845b486 100644 --- a/docs/feature-parity/README.md +++ b/docs/feature-parity/README.md @@ -22,7 +22,7 @@ What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ | SSH tunnels with jump hosts | Yes | Partial: no jump hosts | | Safe Mode per connection (off, confirm writes, read only) | Yes | Partial: Confirm Writes does not ask before a write | | Import connections from other apps | Yes | No: imports a TablePro JSON file only | -| Application menu with Quit | Yes: a main menu, since GNOME apps have no menu bar; [#4139](https://github.com/TableProApp/TablePro/pull/4139) splits the session's commands into a menu of their own | Yes | +| Application menu with Quit | Yes: a main menu, since GNOME apps have no menu bar, and a session menu for the database commands | Yes | | The server's other databases in the sidebar | Yes: each opened from the sidebar's menu | No | ## Sidebar @@ -30,16 +30,16 @@ What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ | Feature | Linux | Windows | |---|---|---| | Schemas and tables, with search | Yes | Yes | -| A schema's objects grouped by kind | In [#4159](https://github.com/TableProApp/TablePro/pull/4159) | Yes | -| Width set by dragging its edge | In [#4155](https://github.com/TableProApp/TablePro/pull/4155) | Yes | +| A schema's objects grouped by kind | Yes | Yes | +| Width set by dragging its edge | Yes | Yes | | Toggle in the window header | Yes | Partial: View > Object Tree and Ctrl+B; no button in the title bar | -| Bottom bar with an Add menu | In [#4146](https://github.com/TableProApp/TablePro/pull/4146) | No | -| Choose which schemas the sidebar lists | In [#4150](https://github.com/TableProApp/TablePro/pull/4150) | No | +| Bottom bar with an Add menu | Yes | No | +| Choose which schemas the sidebar lists | Yes | No | | Tables and Favorites scope switch | Yes | No | -| Favorite folders | In [#4130](https://github.com/TableProApp/TablePro/pull/4130) | No | +| Favorite folders | Yes | No | | Favorite keywords that expand in the editor | No | No | | Favorite tables and databases, with environments | No | No | -| Open Quickly (find a table by name) | In [#4121](https://github.com/TableProApp/TablePro/pull/4121): tables and views; saved queries in [#4133](https://github.com/TableProApp/TablePro/pull/4133), past queries in [#4144](https://github.com/TableProApp/TablePro/pull/4144) | Partial: Ctrl+P moves to the sidebar's filter | +| Open Quickly (find a table by name) | Yes: tables, views, saved queries and past queries | Partial: Ctrl+P moves to the sidebar's filter | ## Data grid @@ -54,14 +54,14 @@ What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ | Open a referenced row and the rows that reference one | Yes | No | | Set Value on every selected row (Empty, NULL, DEFAULT, UUID, an expression, any value) | Partial: Empty, NULL, DEFAULT and the engine's expressions | No | | Show row numbers, row height and the text shown for NULL | Yes | No | -| Highlight rules (color rows and cells by a condition) | In [#4127](https://github.com/TableProApp/TablePro/pull/4127): kept per table in [#4129](https://github.com/TableProApp/TablePro/pull/4129) | No | -| The grid in the editor theme's colors | In [#4128](https://github.com/TableProApp/TablePro/pull/4128) | No | -| Font of the grid's cells, and zoom | In [#4135](https://github.com/TableProApp/TablePro/pull/4135): family and size; no zoom | No | -| Date format of the cells | In [#4142](https://github.com/TableProApp/TablePro/pull/4142) | No | -| Default sort of a table (none, primary key, first column) | In [#4140](https://github.com/TableProApp/TablePro/pull/4140) | No | -| The format Copy writes for several rows | In [#4137](https://github.com/TableProApp/TablePro/pull/4137) | No: copies tab-separated values only | -| Open the row details when a row is selected | In [#4138](https://github.com/TableProApp/TablePro/pull/4138) | No | -| Mark zero-width, control and special space characters in the value editor | No: [#4141](https://github.com/TableProApp/TablePro/pull/4141) marks spaces, tabs and line breaks instead | No | +| Highlight rules (color rows and cells by a condition) | Yes | No | +| The grid in the editor theme's colors | Yes | No | +| Font of the grid's cells, and zoom | Partial: family and size; no zoom | No | +| Date format of the cells | Yes | No | +| Default sort of a table (none, primary key, first column) | Yes | No | +| The format Copy writes for several rows | Yes | No: copies tab-separated values only | +| Open the row details when a row is selected | Yes | No | +| Mark zero-width, control and special space characters in the value editor | Yes | No | ## Bottom bar @@ -70,7 +70,7 @@ What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ | Columns button | Yes | No | | Time a page or a query took | Yes | Yes | | Data and Structure in one tab | Yes | No | -| JSON view of the rows | In [#4122](https://github.com/TableProApp/TablePro/pull/4122): table tabs; not query results | No | +| JSON view of the rows | Partial: table tabs; not query results | No | | Chart view of a result | No | No | | Map view of a result | No | No | @@ -80,11 +80,11 @@ What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ |---|---|---| | Row details pane | Yes | No | | Type, key and edit marks on a field | Yes | No | -| Foreign key mark on a field | In [#4131](https://github.com/TableProApp/TablePro/pull/4131) | No | +| Foreign key mark on a field | Yes | No | | Field search and an edited-only filter | Yes | No | -| A field drawn as its name over its value | In [#4156](https://github.com/TableProApp/TablePro/pull/4156) | No | -| An editor inside each field row | In [#4157](https://github.com/TableProApp/TablePro/pull/4157) | No | -| A menu on each field | In [#4158](https://github.com/TableProApp/TablePro/pull/4158) | No | +| A field drawn as its name over its value | Yes | No | +| An editor inside each field row | Yes | No | +| A menu on each field | Yes | No | | A row as JSON | Partial: a dialog from the grid's menu, not a view of the row details | No | ## SQL editor @@ -119,15 +119,15 @@ What the Linux app does in each area, in detail: [linux/ROADMAP.md](../../linux/ | AI assistant | Yes | No | | MCP server for outside clients | Yes | No | | TablePro account and entitlement | Yes | No | -| The `tablepro` command line tool | In [#4145](https://github.com/TableProApp/TablePro/pull/4145) | No: `tablepro.exe` opens the app and reads no arguments | +| The `tablepro` command line tool | Yes | No: `tablepro.exe` opens the app and reads no arguments | ## Window toolbar | Feature | Linux | Windows | |---|---|---| -| Safe Mode level in the toolbar | In [#4124](https://github.com/TableProApp/TablePro/pull/4124) | No | +| Safe Mode level in the toolbar | Yes | No | | Refresh button | Yes | Yes | -| Save Changes button | In [#4126](https://github.com/TableProApp/TablePro/pull/4126) | No | +| Save Changes button | Yes | No | | Connection and database chips | Partial: the title names the connection and the sidebar lists every open connection and database; no chips | Partial: the title bar names the connection; no database chip | | Back and Forward through a tab's browse history | n/a: a referenced row opens in a new tab, where macOS moves the tab to it | No | | Actions menu (Preview SQL, Show and Copy DDL, Users and Roles, Query Insights, Server Dashboard) | Partial: Show CREATE TABLE is in the sidebar's menu; the rest is not built | No | diff --git a/docs/feature-parity/features.yml b/docs/feature-parity/features.yml index e2e875ca1c..504a6b430a 100644 --- a/docs/feature-parity/features.yml +++ b/docs/feature-parity/features.yml @@ -17,7 +17,7 @@ areas: linux: yes windows: {status: no, note: "imports a TablePro JSON file only"} - name: Application menu with Quit - linux: {status: yes, note: "a main menu, since GNOME apps have no menu bar; #4139 splits the session's commands into a menu of their own"} + linux: {status: yes, note: "a main menu, since GNOME apps have no menu bar, and a session menu for the database commands"} windows: yes - name: The server's other databases in the sidebar linux: {status: yes, note: "each opened from the sidebar's menu"} @@ -29,25 +29,25 @@ areas: linux: yes windows: yes - name: A schema's objects grouped by kind - linux: {status: pending, pr: 4159} + linux: yes windows: yes - name: Width set by dragging its edge - linux: {status: pending, pr: 4155} + linux: yes windows: yes - name: Toggle in the window header linux: yes windows: {status: partial, note: "View > Object Tree and Ctrl+B; no button in the title bar"} - name: Bottom bar with an Add menu - linux: {status: pending, pr: 4146} + linux: yes windows: no - name: Choose which schemas the sidebar lists - linux: {status: pending, pr: 4150} + linux: yes windows: no - name: Tables and Favorites scope switch linux: yes windows: no - name: Favorite folders - linux: {status: pending, pr: 4130} + linux: yes windows: no - name: Favorite keywords that expand in the editor linux: no @@ -56,7 +56,7 @@ areas: linux: no windows: no - name: Open Quickly (find a table by name) - linux: {status: pending, pr: 4121, note: "tables and views; saved queries in #4133, past queries in #4144"} + linux: {status: yes, note: "tables, views, saved queries and past queries"} windows: {status: partial, note: "Ctrl+P moves to the sidebar's filter"} - name: Data grid @@ -89,28 +89,28 @@ areas: linux: yes windows: no - name: Highlight rules (color rows and cells by a condition) - linux: {status: pending, pr: 4127, note: "kept per table in #4129"} + linux: yes windows: no - name: The grid in the editor theme's colors - linux: {status: pending, pr: 4128} + linux: yes windows: no - name: Font of the grid's cells, and zoom - linux: {status: pending, pr: 4135, note: "family and size; no zoom"} + linux: {status: partial, note: "family and size; no zoom"} windows: no - name: Date format of the cells - linux: {status: pending, pr: 4142} + linux: yes windows: no - name: Default sort of a table (none, primary key, first column) - linux: {status: pending, pr: 4140} + linux: yes windows: no - name: The format Copy writes for several rows - linux: {status: pending, pr: 4137} + linux: yes windows: {status: no, note: "copies tab-separated values only"} - name: Open the row details when a row is selected - linux: {status: pending, pr: 4138} + linux: yes windows: no - name: Mark zero-width, control and special space characters in the value editor - linux: {status: no, note: "#4141 marks spaces, tabs and line breaks instead"} + linux: yes windows: no - name: Bottom bar @@ -125,7 +125,7 @@ areas: linux: yes windows: no - name: JSON view of the rows - linux: {status: pending, pr: 4122, note: "table tabs; not query results"} + linux: {status: partial, note: "table tabs; not query results"} windows: no - name: Chart view of a result linux: no @@ -143,19 +143,19 @@ areas: linux: yes windows: no - name: Foreign key mark on a field - linux: {status: pending, pr: 4131} + linux: yes windows: no - name: Field search and an edited-only filter linux: yes windows: no - name: A field drawn as its name over its value - linux: {status: pending, pr: 4156} + linux: yes windows: no - name: An editor inside each field row - linux: {status: pending, pr: 4157} + linux: yes windows: no - name: A menu on each field - linux: {status: pending, pr: 4158} + linux: yes windows: no - name: A row as JSON linux: {status: partial, note: "a dialog from the grid's menu, not a view of the row details"} @@ -212,19 +212,19 @@ areas: linux: yes windows: no - name: The `tablepro` command line tool - linux: {status: pending, pr: 4145} + linux: yes windows: {status: no, note: "`tablepro.exe` opens the app and reads no arguments"} - name: Window toolbar features: - name: Safe Mode level in the toolbar - linux: {status: pending, pr: 4124} + linux: yes windows: no - name: Refresh button linux: yes windows: yes - name: Save Changes button - linux: {status: pending, pr: 4126} + linux: yes windows: no - name: Connection and database chips linux: {status: partial, note: "the title names the connection and the sidebar lists every open connection and database; no chips"}