Development

Node 22 or later: Node runs the .ts files directly, with no build step.

npm install
npm test                  # unit tests (node --test)
npm run typecheck
npm run test:integration  # in a real VS Code, downloaded to .vscode-test
npm run package           # builds cte-diff-<version>.vsix

Release: bump version in package.json, add a CHANGELOG.md entry, commit, then run scripts/release.sh.

Screenshots and footage

The README's and the docs' screenshots, and the footage for the demo video, come from the packaged extension in a real VS Code. npm run capture packages the extension, builds a scratch dbt-duckdb project from web/sample.ts (the site's example), and commits its orders model before the change. It then drives VS Code the way the site's live demo plays: open the change from Source Control, preview payments, compare order_payments, and compare final from the sidebar.

npm run capture   # writes docs/assets/img/*.png, and out/capture/review.mp4 with its marks

It needs ffmpeg, the duckdb CLI and a dbt with dbt-duckdb: set CTE_DIFF_DBT, or set up examples/duckdb's venv (see its README). Rerun it after any change to what the sidebar, the CodeLens or the results look like.

The short GIFs in the README and on Use it are scenes of the demo film. videos/cte-diff-demo/gifs.sh cuts them from the web copy; ship.sh runs it after the film. Compare Files is not in the film, so that shot stays a still.

This site

The site is MkDocs Material, with the landing page in overrides/home.html and the playground page in overrides/playground.html. The landing page's live demo (web/demo.ts) and the playground (web/playground.ts) bundle the extension's own parser and results view (src/cte.ts, src/query.ts, src/results.ts). Both run the extension's SQL over the made-up tables in web/sample.ts: the demo from web/demo-rows.json, generated on DuckDB; the playground live, on DuckDB in the browser (duckdb-wasm).

npm run site:js                        # builds docs/javascripts/playground.js and demo.js
node scripts/demo-rows.ts              # regenerates web/demo-rows.json (needs the duckdb CLI)
python3 -m venv .venv && .venv/bin/pip install -r requirements-docs.txt
.venv/bin/mkdocs serve

.github/workflows/pages.yml builds the site on every pull request and deploys it to GitHub Pages from main.