From 02ee0152b844abc1e4f2fbbf1aceec897d5d8ab4 Mon Sep 17 00:00:00 2001 From: Vincent Taverna Date: Wed, 11 Feb 2026 13:43:53 -0500 Subject: [PATCH 1/3] chore: add localias configuration for npmx.test --- .gitignore | 7 ++ .localias.yml | 7 ++ CONTRIBUTING.md | 25 +++++++ nuxt.config.ts | 4 ++ package.json | 2 + scripts/setup-local-domain.sh | 122 ++++++++++++++++++++++++++++++++++ 6 files changed, 167 insertions(+) create mode 100644 .localias.yml create mode 100755 scripts/setup-local-domain.sh diff --git a/.gitignore b/.gitignore index 99e727c21..1b0372e55 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,10 @@ file-tree-sprite.svg # output .vercel + +# Local development certificates (if using manual mkcert) +*.pem +*.key +*.crt +!public/**/*.{pem,key,crt} +.localias-certs/ diff --git a/.localias.yml b/.localias.yml new file mode 100644 index 000000000..3652ce65a --- /dev/null +++ b/.localias.yml @@ -0,0 +1,7 @@ +# Localias configuration +# See: https://github.com/peterldowns/localias +# Usage: localias set npmx.test 3000 +# Visit: https://npmx.test + +- from: npmx.test + to: http://127.0.0.1:3000 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6fc688264..204a26fb1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,6 +95,31 @@ This focus helps guide our project decisions as a community and what we choose t pnpm npmx-connector ``` +### Optional: Custom Local Domain + +Configure dev server to run at `http://npmx.test:3000` instead of `http://127.0.0.1:3000`. + +**Setup:** + +```bash +# 1. Install Localias +brew install peterldowns/tap/localias + +# 2. Run setup (requires sudo) +pnpm setup:local + +# 3. Start dev server +pnpm dev +``` + +Visit `https://npmx.test` (localias proxies to `127.0.0.1:3000`). + +**Uninstall:** + +```bash +pnpm setup:local:uninstall +``` + ## Development workflow ### Available commands diff --git a/nuxt.config.ts b/nuxt.config.ts index 00d89f429..3260034cb 100644 --- a/nuxt.config.ts +++ b/nuxt.config.ts @@ -303,6 +303,10 @@ export default defineNuxtConfig({ }, vite: { + server: { + // Allow .test domains for local development (e.g., npmx.test via localias) + allowedHosts: ['.test'], + }, optimizeDeps: { include: [ '@vueuse/core', diff --git a/package.json b/package.json index 3b18c3a9e..1b87f293e 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,8 @@ "generate:sprite": "node scripts/generate-file-tree-sprite.ts", "generate:fixtures": "node scripts/generate-fixtures.ts", "generate:lexicons": "lex build --lexicons lexicons --out shared/types/lexicons --clear", + "setup:local": "bash scripts/setup-local-domain.sh", + "setup:local:uninstall": "localias rm npmx.test && sudo localias stop || echo 'No local domain configured'", "test": "vite test", "test:a11y": "pnpm build:test && LIGHTHOUSE_COLOR_MODE=dark pnpm test:a11y:prebuilt && LIGHTHOUSE_COLOR_MODE=light pnpm test:a11y:prebuilt", "test:a11y:prebuilt": "./scripts/lighthouse.sh", diff --git a/scripts/setup-local-domain.sh b/scripts/setup-local-domain.sh new file mode 100755 index 000000000..3e0e2b716 --- /dev/null +++ b/scripts/setup-local-domain.sh @@ -0,0 +1,122 @@ +#!/bin/bash +set -e + +R='\033[0;31m' G='\033[0;32m' Y='\033[1;33m' B='\033[0;34m' NC='\033[0m' + +error_exit() { + echo -e "\n${R}āœ— $1${NC}" >&2 + [ -n "$2" ] && echo -e "${Y}ā†’ $2${NC}" >&2 + exit 1 +} + +# Detect operating system +detect_os() { + case "$(uname -s)" in + Darwin*) + echo "macos" + ;; + Linux*) + if grep -qi microsoft /proc/version 2>/dev/null; then + echo "wsl" + else + echo "linux" + fi + ;; + MINGW*|MSYS*|CYGWIN*) + echo "windows" + ;; + *) + echo "unknown" + ;; + esac +} + +OS_TYPE=$(detect_os) + +echo -e "\nšŸŒ Configure npmx.test domain for local development" + +# Check for unsupported platforms +if [ "$OS_TYPE" = "windows" ]; then + error_exit "Windows is not supported by Localias" \ + "Please use WSL2 instead: https://learn.microsoft.com/windows/wsl/install" +fi + +if [ "$OS_TYPE" = "unknown" ]; then + error_exit "Unsupported operating system" "Localias supports macOS, Linux, and WSL2" +fi + +# Check prerequisites with platform-specific instructions +if ! command -v localias &>/dev/null; then + case "$OS_TYPE" in + macos) + error_exit "Localias not installed" "brew install peterldowns/tap/localias" + ;; + linux|wsl) + error_exit "Localias not installed" "go install github.com/peterldowns/localias/cmd/localias@latest" + ;; + esac +fi + +[ -f ".localias.yml" ] || error_exit ".localias.yml not found" "Run from project root" + +# Linux/WSL: Check and configure privileged port capability +if [ "$OS_TYPE" = "linux" ] || [ "$OS_TYPE" = "wsl" ]; then + LOCALIAS_PATH=$(which localias) + if ! getcap "$LOCALIAS_PATH" 2>/dev/null | grep -q "cap_net_bind_service"; then + echo -e "${Y}āš™ Configuring privileged port access for Localias${NC}" + echo "This allows Localias to bind to ports 80 and 443 without sudo" + sudo setcap CAP_NET_BIND_SERVICE=+eip "$LOCALIAS_PATH" || \ + error_exit "Failed to set capabilities" "Run: sudo setcap CAP_NET_BIND_SERVICE=+eip \$(which localias)" + echo -e "${G}āœ“ Capabilities configured${NC}" + fi +fi + +# Check if already configured +if localias list 2>/dev/null | grep -q "npmx.test"; then + echo -e "${Y}āš  npmx.test already configured${NC}" + if localias status &>/dev/null; then + echo -e "${G}āœ“ Daemon running${NC} - visit ${B}https://npmx.test${NC}" + exit 0 + fi + echo "Restarting daemon..." +else + echo "Configuring npmx.test ā†’ localhost:3000 (requires sudo)" + read -p "Press Enter to continue or Ctrl+C to cancel... " + localias set npmx.test 3000 || error_exit "Failed to configure alias" "Check sudo access" +fi + +# Start daemon +echo "Starting localias daemon (requires sudo)..." +sudo localias stop 2>/dev/null || true +if ! sudo localias start 2>&1 | grep -q "server running"; then + error_exit "Failed to start daemon" "Check ports 80/443 or run: sudo localias start" +fi + +# Verify +sleep 1 +if ! localias status &>/dev/null; then + error_exit "Daemon not running" "Run manually: sudo localias start" +fi + +echo -e "\n${G}āœ“ Setup complete${NC}" +echo -e " Start dev server: ${B}pnpm dev${NC}" +echo -e " Visit: ${B}https://npmx.test${NC}" +echo -e " Remove: ${B}pnpm setup:local:uninstall${NC}" + +# Platform-specific notes +if [ "$OS_TYPE" = "wsl" ]; then + echo -e "\n${Y}ā„¹ WSL2 Note:${NC}" + echo -e " - SSL certificates work in WSL browsers" + echo -e " - For Windows browsers, manually install cert from:" + echo -e " ~/.localias/certs/npmx.test.crt" +fi + +# AtProto OAuth caveat +echo -e "\n${Y}āš  AtProto OAuth Note:${NC}" +echo -e " When using Bluesky login, the OAuth callback will redirect to" +echo -e " ${B}http://127.0.0.1:3000${NC} instead of ${B}npmx.test${NC}" +echo -e " This is required per AtProto spec for localhost development." +echo -e " Your session will work correctly after the redirect." +echo -e " See: ${B}https://atproto.com/specs/oauth#localhost-client-development${NC}" + +echo "" From 5e001042241c187c6e5c42ee3960d9ce45d0dbbc Mon Sep 17 00:00:00 2001 From: Vincent Taverna Date: Wed, 11 Feb 2026 14:25:27 -0500 Subject: [PATCH 2/3] fix: knip configuration --- knip.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/knip.ts b/knip.ts index 257a58608..759d71d1b 100644 --- a/knip.ts +++ b/knip.ts @@ -1,6 +1,10 @@ import type { KnipConfig } from 'knip' const config: KnipConfig = { + ignoreBinaries: [ + /** Global CLI tool installed via brew/go, not npm */ + 'localias', + ], workspaces: { '.': { entry: [ From f4510e6336a11590bda21a6abe635c59dda06a23 Mon Sep 17 00:00:00 2001 From: Vincent Taverna Date: Wed, 11 Feb 2026 14:31:50 -0500 Subject: [PATCH 3/3] chore: feedback enhancements --- CONTRIBUTING.md | 3 +++ package.json | 2 +- scripts/setup-local-domain.sh | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 204a26fb1..424ad9057 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -105,6 +105,9 @@ Configure dev server to run at `http://npmx.test:3000` instead of `http://127.0. # 1. Install Localias brew install peterldowns/tap/localias +# Linux/WSL2 +go install github.com/peterldowns/localias/cmd/localias@latest + # 2. Run setup (requires sudo) pnpm setup:local diff --git a/package.json b/package.json index 1b87f293e..ca2900d8a 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "generate:fixtures": "node scripts/generate-fixtures.ts", "generate:lexicons": "lex build --lexicons lexicons --out shared/types/lexicons --clear", "setup:local": "bash scripts/setup-local-domain.sh", - "setup:local:uninstall": "localias rm npmx.test && sudo localias stop || echo 'No local domain configured'", + "setup:local:uninstall": "bash -c 'if localias rm npmx.test; then sudo localias stop || echo \"Failed to stop Localias daemon\"; else echo \"No local domain configured\"; fi'", "test": "vite test", "test:a11y": "pnpm build:test && LIGHTHOUSE_COLOR_MODE=dark pnpm test:a11y:prebuilt && LIGHTHOUSE_COLOR_MODE=light pnpm test:a11y:prebuilt", "test:a11y:prebuilt": "./scripts/lighthouse.sh", diff --git a/scripts/setup-local-domain.sh b/scripts/setup-local-domain.sh index 3e0e2b716..eab9bef7b 100755 --- a/scripts/setup-local-domain.sh +++ b/scripts/setup-local-domain.sh @@ -88,7 +88,7 @@ fi # Start daemon echo "Starting localias daemon (requires sudo)..." sudo localias stop 2>/dev/null || true -if ! sudo localias start 2>&1 | grep -q "server running"; then +if ! sudo localias start; then error_exit "Failed to start daemon" "Check ports 80/443 or run: sudo localias start" fi