mirror of
https://github.com/priyanshujain/margin-docs.git
synced 2026-10-02 11:07:05 +00:00
133 lines
5.3 KiB
Makefile
133 lines
5.3 KiB
Makefile
# Building and installing Margin Docs on the machine you are sitting at. The release pipeline in
|
|
# .github/workflows/release.yml is what builds for everyone else; this is the local equivalent, and
|
|
# `just install` is deliberately the same command whether or not the app is already installed.
|
|
|
|
set shell := ["bash", "-euo", "pipefail", "-c"]
|
|
|
|
app := "Margin Docs"
|
|
bundle := "src-tauri/target/release/bundle"
|
|
|
|
# List the recipes.
|
|
default:
|
|
@just --list
|
|
|
|
# Run the app against the Vite dev server.
|
|
dev:
|
|
pnpm tauri dev
|
|
|
|
# The gate: the frontend suites and the Rust suites, both of which must be green.
|
|
test:
|
|
pnpm test
|
|
cd src-tauri && cargo test
|
|
|
|
# The browser suite that drives the real UI.
|
|
test-ui:
|
|
pnpm test:ui
|
|
|
|
# Build the release bundle for this machine.
|
|
build:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
# The .app on macOS, the .deb and AppImage on Linux. No dmg: nothing here needs a disk image
|
|
# to copy a bundle into place, and building one is the slowest part of a mac bundle.
|
|
pnpm install
|
|
case "$(uname -s)" in
|
|
Darwin) pnpm tauri build --bundles app ;;
|
|
Linux) pnpm tauri build --bundles deb,appimage ;;
|
|
*) echo "just: no local build for $(uname -s); macOS and Linux are the desktop targets." >&2; exit 1 ;;
|
|
esac
|
|
|
|
# Build and install, replacing whatever version is already installed.
|
|
install: build
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
case "$(uname -s)" in
|
|
Darwin) just _install-macos ;;
|
|
Linux) just _install-linux ;;
|
|
*) echo "just: no installer for $(uname -s); macOS and Linux are the desktop targets." >&2; exit 1 ;;
|
|
esac
|
|
|
|
_install-macos:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
src="{{bundle}}/macos/{{app}}.app"
|
|
[ -d "$src" ] || { echo "just: nothing to install, $src does not exist." >&2; exit 1; }
|
|
|
|
# /Applications is writable by admin users, so the common case needs no sudo. When it is not,
|
|
# ~/Applications is a real Launchpad location and beats prompting for a password mid-build.
|
|
if [ -w /Applications ]; then dir=/Applications; else dir="$HOME/Applications"; mkdir -p "$dir"; fi
|
|
dest="$dir/{{app}}.app"
|
|
|
|
# Which of the two names the executable carries depends on how the bundle was configured, so
|
|
# ask about both rather than assuming, and replacing a bundle out from under a live process.
|
|
running() { pgrep -x "{{app}}" > /dev/null || pgrep -x margin-docs > /dev/null; }
|
|
|
|
# Replacing the bundle under a running app leaves it half old and half new, and the running
|
|
# copy holds the deleted files open. Ask it to quit and wait, rather than killing it.
|
|
if running; then
|
|
echo "Quitting the running {{app}}…"
|
|
osascript -e 'quit app "{{app}}"' 2> /dev/null || true
|
|
for _ in $(seq 40); do running || break; sleep 0.25; done
|
|
if running; then echo "just: {{app}} is still running; quit it and try again." >&2; exit 1; fi
|
|
fi
|
|
|
|
rm -rf "$dest"
|
|
cp -R "$src" "$dest"
|
|
version=$(defaults read "$dest/Contents/Info.plist" CFBundleShortVersionString 2> /dev/null || echo "?")
|
|
echo "Installed $version to $dest"
|
|
|
|
_install-linux:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
deb=$(ls -t {{bundle}}/deb/*.deb 2> /dev/null | head -1 || true)
|
|
appimage=$(ls -t {{bundle}}/appimage/*.AppImage 2> /dev/null | head -1 || true)
|
|
|
|
# apt over dpkg where it exists: it pulls in the webkit and gtk runtime the package depends on,
|
|
# and --reinstall makes installing over the same version an update rather than a no-op.
|
|
if [ -n "$deb" ] && command -v apt-get > /dev/null; then
|
|
sudo apt-get install -y --reinstall "$PWD/$deb"
|
|
echo "Installed $deb"
|
|
elif [ -n "$deb" ] && command -v dpkg > /dev/null; then
|
|
sudo dpkg -i "$deb"
|
|
echo "Installed $deb"
|
|
elif [ -n "$appimage" ]; then
|
|
install -Dm755 "$appimage" "$HOME/.local/bin/margin-docs"
|
|
install -Dm644 src-tauri/icons/128x128.png "$HOME/.local/share/icons/margin-docs.png"
|
|
mkdir -p "$HOME/.local/share/applications"
|
|
printf '%s\n' \
|
|
'[Desktop Entry]' \
|
|
'Type=Application' \
|
|
'Name=Margin Docs' \
|
|
'Comment=A folder of markdown documents' \
|
|
'Exec=margin-docs' \
|
|
'Icon=margin-docs' \
|
|
'Categories=Office;' \
|
|
> "$HOME/.local/share/applications/margin-docs.desktop"
|
|
echo "Installed $appimage to ~/.local/bin/margin-docs"
|
|
echo "Make sure ~/.local/bin is on your PATH."
|
|
else
|
|
echo "just: nothing to install, no .deb or AppImage under {{bundle}}." >&2
|
|
exit 1
|
|
fi
|
|
|
|
# Remove the installed app, leaving its data directory alone.
|
|
uninstall:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
# What the data directory is and what deleting it costs you is in docs/setup.md.
|
|
case "$(uname -s)" in
|
|
Darwin)
|
|
for dest in "/Applications/{{app}}.app" "$HOME/Applications/{{app}}.app"; do
|
|
if [ -d "$dest" ]; then rm -rf "$dest"; echo "Removed $dest"; fi
|
|
done
|
|
;;
|
|
Linux)
|
|
if dpkg -s margin-docs > /dev/null 2>&1; then sudo apt-get remove -y margin-docs; fi
|
|
rm -f "$HOME/.local/bin/margin-docs" \
|
|
"$HOME/.local/share/icons/margin-docs.png" \
|
|
"$HOME/.local/share/applications/margin-docs.desktop"
|
|
echo "Removed the AppImage install, if there was one."
|
|
;;
|
|
*) echo "just: nothing to uninstall on $(uname -s)." >&2; exit 1 ;;
|
|
esac
|