docs: automate demo generation

Author: andrewbrey

.dockerignore

@@ -0,0 +1,252 @@
+.github
+*deleteme*
+
+.deno_cache/
+
+### Deno ###
+/.idea/
+/.vscode/
+
+/node_modules
+
+.env
+*.orig
+*.pyc
+*.swp
+
+### Dropbox ###
+# Dropbox settings and caches
+.dropbox
+.dropbox.attr
+.dropbox.cache
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

.github/demos/Dockerfile

@@ -1,12 +1,23 @@
 FROM ghcr.io/charmbracelet/vhs:v0.2.0
 
+ARG MDRB_VERSION
+
+RUN [ -z "$MDRB_VERSION" ] && echo "MDRB_VERSION is required" && exit 1 || true
+
 ENV PATH="$PATH:/root/.deno/bin"
 
 RUN echo 'export PATH="$PATH:/root/.deno/bin"' >> ~/.bashrc
 
 RUN apt install curl unzip bat -y \
-  && curl -fsSL https://deno.land/x/install/install.sh | sh \
-  && deno install --unstable -Arfn mdrb https://deno.land/x/mdrb/mod.ts
+  && curl -fsSL https://deno.land/x/install/install.sh | sh
+
+RUN deno install -Arfn mdrb https://deno.land/x/mdrb@${MDRB_VERSION}/mod.ts
+
+ADD deno.lock deps.ts deps.dev.ts /tmp/
+
+RUN deno cache --lock=/tmp/deno.lock /tmp/deps.ts /tmp/deps.dev.ts
+
+RUN mdrb https://deno.land/x/mdrb@${MDRB_VERSION}/demo.md --mode isolated
 
 ENTRYPOINT [] # override parent layer
 

.github/demos/generate.ts

@@ -0,0 +1,20 @@
+import { $ } from "../../deps.ts";
+
+const root = $.relativePath(import.meta.url, "..", "..");
+const latestTag = await $`git describe --tags --abbrev=0`.cwd(root).text();
+const img = "mdrb-demos:latest";
+const demosDir = $.path.join(".github", "demos");
+const dockerfile = $.path.join(demosDir, "Dockerfile");
+
+await $`docker build --build-arg MDRB_VERSION=${latestTag} -t ${img} -f ${dockerfile} .`
+	.cwd(root);
+
+for await (
+	const tape of $.fs.expandGlob($.path.joinGlobs([demosDir, "*.tape"]))
+) {
+	await $`docker run --rm -v ${root}:/vhs ${img} vhs ${demosDir}/${tape.name}`
+		.cwd(root);
+}
+
+const me = Deno.env.get("USER");
+await $`sudo chown -R ${me}:${me} ${demosDir}`;

.github/demos/usage-basic.gif

@@ -0,0 +1,34 @@
+Output .github/demos/usage-basic.gif
+
+Require deno
+Require mdrb
+
+Set Theme "Gruvbox Dark"
+Set Shell bash
+Set FontFamily "JetBrainsMono Nerd Font"
+
+# pre-cache runtime deps
+Hide
+Type "mdrb demo.md --mode isolated"
+Enter
+Sleep 5s
+Type "clear"
+Enter
+Sleep 500ms
+Show
+
+Type "mdrb demo.md"
+Enter
+Sleep 1s
+
+Type "y"
+Sleep 500ms
+Enter
+Sleep 1s
+
+Type "y"
+Sleep 500ms
+Enter
+Sleep 1s
+
+Sleep 3s

.github/demos/usage-basic.tape

@@ -0,0 +1,32 @@
+# What can `$` do?
+
+<details data-mdrb>
+<summary>make an http request and do stuff with results</summary>
+</details>
+
+```ts
+const html = await $.request("https://example.com").text();
+
+$.log("example.com is", html.length, "characters");
+```
+
+<details data-mdrb>
+<summary>prompt the user</summary>
+</details>
+
+```ts
+const fruits = ["apples", "bananas", "oranges"];
+const faves = await $.multiSelect({ message: "favorite fruits?", options: fruits })
+	.then((chosen) => chosen.map((idx) => fruits.at(idx)));
+
+$.log("your faves are:", faves);
+```
+
+<details data-mdrb>
+<summary>run shell commands</summary>
+</details>
+
+```ts
+const thisDir = $.path.dirname($.path.fromFileUrl(import.meta.url));
+await $`ls ${thisDir}`.printCommand(true);
+```