new coding guidelines

This commit is contained in:
Chris Wanstrath 2026-01-28 22:21:03 -08:00
parent 2c8fff85f4
commit 2d544e9bd3
4 changed files with 178 additions and 95 deletions

View File

@ -1,15 +1,18 @@
# Toes - Claude Code Guide # Toes - Claude Code Guide
## What It Is ## What It Is
Personal web server framework that auto-discovers and runs multiple web apps on your home network. "Set it up, turn it on, forget about the cloud." Personal web server framework that auto-discovers and runs multiple web apps on your home network. "Set it up, turn it on, forget about the cloud."
## How It Works ## How It Works
1. Host server scans `/apps` directory for valid apps 1. Host server scans `/apps` directory for valid apps
2. Valid app = has `package.json` with `scripts.toes` entry 2. Valid app = has `package.json` with `scripts.toes` entry
3. Each app spawned as child process with unique port (3001+) 3. Each app spawned as child process with unique port (3001+)
4. Dashboard UI shows all apps with current status, logs, and links 4. Dashboard UI shows all apps with current status, logs, and links
## Key Files ## Key Files
- `src/server/apps.ts` - **The heart**: app discovery, process management, lifecycle - `src/server/apps.ts` - **The heart**: app discovery, process management, lifecycle
- `src/server/index.tsx` - Entry point (minimal, just initializes Hype) - `src/server/index.tsx` - Entry point (minimal, just initializes Hype)
- `src/pages/index.tsx` - Dashboard UI - `src/pages/index.tsx` - Dashboard UI
@ -17,32 +20,107 @@ Personal web server framework that auto-discovers and runs multiple web apps on
- `TODO.md` - User-maintained task list (read this!) - `TODO.md` - User-maintained task list (read this!)
## Tech Stack ## Tech Stack
- **Bun** runtime (not Node) - **Bun** runtime (not Node)
- **Hype** (custom HTTP framework wrapping Hono) from git+https://git.nose.space/defunkt/hype - **Hype** (custom HTTP framework wrapping Hono) from git+https://git.nose.space/defunkt/hype
- **Forge** (typed CSS-in-JS) from git+https://git.nose.space/defunkt/forge - **Forge** (typed CSS-in-JS) from git+https://git.nose.space/defunkt/forge
- TypeScript + Hono JSX - TypeScript + Hono JSX
## Running ## Running
```bash ```bash
bun run --hot src/server/index.tsx # Dev mode with hot reload bun run --hot src/server/index.tsx # Dev mode with hot reload
``` ```
## App Structure ## App Structure
```tsx ```tsx
// apps/example/index.tsx // apps/example/index.tsx
import { Hype } from 'hype' import { Hype } from "hype"
const app = new Hype() const app = new Hype()
app.get('/', c => c.html(<h1>Content</h1>)) app.get("/", (c) => c.html(<h1>Content</h1>))
export default app.defaults export default app.defaults
``` ```
## Conventions ## Conventions
- Apps get `PORT` env var from host - Apps get `PORT` env var from host
- Each app is isolated process with own dependencies - Each app is isolated process with own dependencies
- No path-based routing - apps run on separate ports - No path-based routing - apps run on separate ports
- `DATA_DIR` env controls where apps are discovered - `DATA_DIR` env controls where apps are discovered
## Current State ## Current State
- Core infrastructure: ✓ Complete (discovery, spawn, watch, ports, UI) - Core infrastructure: ✓ Complete (discovery, spawn, watch, ports, UI)
- Apps: basic, profile (working); risk, tictactoe (empty) - Apps: basic, profile (working); risk, tictactoe (empty)
- Check TODO.md for planned features - Check TODO.md for planned features
## Coding Guidelines
TS files should be organized in the following way:
- imports
- re-exports
- const/lets
- enums
- interfaces
- types
- classes
- functions
- module init (top level function calls)
In each section, put the `export`s first, in alphabetical order.
Then, after the `export`s (if there were any), put everything else,
also in alphabetical order.
For single-line functions, use `const fn = () => {}` and put them in the
"functions" section of the file.
All other functions use the `function blah(){}` format.
Example:
```ts
import { code } from "coders"
import { something } from "somewhere"
export type { SomeType }
const RETRY_TIMES = 5
const WIDTH = 480
enum State {
Stopped,
Starting,
Running,
}
interface Config {
name: string
port: number
}
type Handler = (req: Request) => Response
class App {
config: Config
constructor(config: Config) {
this.config = config
}
}
const isApp = (name: string) =>
apps.has(name)
function createApp(name: string): App {
const app = new App({ name, port: 3000 })
apps.set(name, app)
return app
}
function start(app: App): void {
console.log(`Starting ${app.config.name}`)
}
```

View File

@ -1,52 +1,99 @@
import type { App as SharedApp, AppState, LogLine } from '@types'
import type { Subprocess } from 'bun' import type { Subprocess } from 'bun'
import { import { existsSync, readdirSync, readFileSync, statSync, watch, writeFileSync } from 'fs'
existsSync, readdirSync, readFileSync, writeFileSync,
statSync, watch
} from 'fs'
import { join } from 'path' import { join } from 'path'
import type { App as SharedApp, AppState, LogLine } from '../shared/types'
export type { AppState } from '../shared/types' export type { AppState } from '@types'
export const APPS_DIR = join(process.env.DATA_DIR ?? '.', 'apps')
const DEFAULT_EMOJI = '🖥️' const DEFAULT_EMOJI = '🖥️'
const APPS_DIR = join(process.env.DATA_DIR ?? '.', 'apps')
const MAX_LOGS = 100 const MAX_LOGS = 100
const _apps = new Map<string, App>()
const _listeners = new Set<() => void>()
let NEXT_PORT = 3001
export type App = SharedApp & { export type App = SharedApp & {
proc?: Subprocess proc?: Subprocess
} }
const _apps = new Map<string, App>() type LoadResult = { pkg: any; error?: string }
// Change notification system export const allApps = (): App[] =>
const _listeners = new Set<() => void>() Array.from(_apps.values())
export const onChange = (cb: () => void) => { .sort((a, b) => a.name.localeCompare(b.name))
export const getApp = (dir: string): App | undefined =>
_apps.get(dir)
export const runApps = () =>
allAppDirs().filter(isApp).forEach(startApp)
export const runningApps = (): App[] =>
allApps().filter(a => a.state === 'running')
export function initApps() {
discoverApps()
runApps()
watchAppsDir()
}
export function onChange(cb: () => void) {
_listeners.add(cb) _listeners.add(cb)
return () => _listeners.delete(cb) return () => _listeners.delete(cb)
} }
const update = () => _listeners.forEach(cb => cb())
export function startApp(dir: string) {
const app = _apps.get(dir)
if (!app || app.state !== 'stopped') return
if (!isApp(dir)) return
runApp(dir, getPort())
}
export function stopApp(dir: string) {
const app = _apps.get(dir)
if (!app || app.state !== 'running') return
info(dir, 'Stopping...')
app.state = 'stopping'
update()
app.proc?.kill()
}
export function updateAppIcon(dir: string, icon: string) {
const { pkg, error } = loadApp(dir)
if (error) throw new Error(error)
pkg.toes ??= {}
pkg.toes.icon = icon
saveApp(dir, pkg)
}
const err = (app: string, ...msg: string[]) => const err = (app: string, ...msg: string[]) =>
console.error('🐾', `${app}:`, ...msg) console.error('🐾', `${app}:`, ...msg)
const getPort = () => NEXT_PORT++
const info = (app: string, ...msg: string[]) => const info = (app: string, ...msg: string[]) =>
console.log('🐾', `${app}:`, ...msg) console.log('🐾', `${app}:`, ...msg)
const isApp = (dir: string): boolean =>
!loadApp(dir).error
const log = (app: string, ...msg: string[]) => const log = (app: string, ...msg: string[]) =>
console.log(`<${app}>`, ...msg) console.log(`<${app}>`, ...msg)
/** Returns all directory names in APPS_DIR */ const update = () => _listeners.forEach(cb => cb())
const allAppDirs = () => {
function allAppDirs() {
return readdirSync(APPS_DIR, { withFileTypes: true }) return readdirSync(APPS_DIR, { withFileTypes: true })
.filter(e => e.isDirectory()) .filter(e => e.isDirectory())
.map(e => e.name) .map(e => e.name)
.sort() .sort()
} }
let NEXT_PORT = 3001 function discoverApps() {
const getPort = () => NEXT_PORT++
const discoverApps = () => {
for (const dir of allAppDirs()) { for (const dir of allAppDirs()) {
const { pkg, error } = loadApp(dir) const { pkg, error } = loadApp(dir)
const state: AppState = error ? 'invalid' : 'stopped' const state: AppState = error ? 'invalid' : 'stopped'
@ -55,12 +102,15 @@ const discoverApps = () => {
} }
} }
export const runApps = () => function isDir(path: string): boolean {
allAppDirs().filter(isApp).forEach(startApp) try {
return statSync(path).isDirectory()
} catch {
return false
}
}
type LoadResult = { pkg: any; error?: string } function loadApp(dir: string): LoadResult {
const loadApp = (dir: string): LoadResult => {
try { try {
const file = readFileSync(join(APPS_DIR, dir, 'package.json'), 'utf-8') const file = readFileSync(join(APPS_DIR, dir, 'package.json'), 'utf-8')
@ -86,24 +136,7 @@ const loadApp = (dir: string): LoadResult => {
} }
} }
const saveApp = (dir: string, pkg: any) => { async function runApp(dir: string, port: number) {
const path = join(APPS_DIR, dir, 'package.json')
writeFileSync(path, JSON.stringify(pkg, null, 2) + '\n')
}
export const updateAppIcon = (dir: string, icon: string) => {
const { pkg, error } = loadApp(dir)
if (error) throw new Error(error)
pkg.toes ??= {}
pkg.toes.icon = icon
saveApp(dir, pkg)
}
const isApp = (dir: string): boolean =>
!loadApp(dir).error
const runApp = async (dir: string, port: number) => {
const { pkg, error } = loadApp(dir) const { pkg, error } = loadApp(dir)
if (error) return if (error) return
@ -175,35 +208,12 @@ const runApp = async (dir: string, port: number) => {
}) })
} }
/** Returns all apps */ function saveApp(dir: string, pkg: any) {
export const allApps = (): App[] => const path = join(APPS_DIR, dir, 'package.json')
Array.from(_apps.values()) writeFileSync(path, JSON.stringify(pkg, null, 2) + '\n')
.sort((a, b) => a.name.localeCompare(b.name))
/** Returns only running apps (for backwards compatibility) */
export const runningApps = (): App[] =>
allApps().filter(a => a.state === 'running')
export const getApp = (dir: string): App | undefined => _apps.get(dir)
export const startApp = (dir: string) => {
const app = _apps.get(dir)
if (!app || app.state !== 'stopped') return
if (!isApp(dir)) return
runApp(dir, getPort())
} }
export const stopApp = (dir: string) => { function watchAppsDir() {
const app = _apps.get(dir)
if (!app || app.state !== 'running') return
info(dir, 'Stopping...')
app.state = 'stopping'
update()
app.proc?.kill()
}
const watchAppsDir = () => {
watch(APPS_DIR, { recursive: true }, (event, filename) => { watch(APPS_DIR, { recursive: true }, (event, filename) => {
if (!filename) return if (!filename) return
@ -265,17 +275,3 @@ const watchAppsDir = () => {
} }
}) })
} }
function isDir(path: string): boolean {
try {
return statSync(path).isDirectory()
} catch {
return false
}
}
export const initApps = () => {
discoverApps()
runApps()
watchAppsDir()
}

View File

@ -1,12 +1,9 @@
import { allApps, initApps, onChange, startApp, stopApp, updateAppIcon } from '$apps'
import type { App as SharedApp } from '@types'
import { Hype } from 'hype' import { Hype } from 'hype'
import { allApps, initApps, onChange, startApp, stopApp, updateAppIcon } from './apps'
import type { App as SharedApp } from '../shared/types'
const app = new Hype({ layout: false }) const app = new Hype({ layout: false })
console.log('🐾 Toes!')
initApps()
// SSE endpoint for real-time app state updates // SSE endpoint for real-time app state updates
app.get('/api/apps/stream', c => { app.get('/api/apps/stream', c => {
const encoder = new TextEncoder() const encoder = new TextEncoder()
@ -98,4 +95,7 @@ app.post('/api/apps/:app/icon', c => {
} }
}) })
console.log('🐾 Toes!')
initApps()
export default app.defaults export default app.defaults

View File

@ -1,30 +1,39 @@
{ {
"compilerOptions": { "compilerOptions": {
// Environment setup & latest features // Environment setup & latest features
"lib": ["ESNext", "DOM"], "lib": [
"ESNext",
"DOM"
],
"target": "ESNext", "target": "ESNext",
"module": "Preserve", "module": "Preserve",
"moduleDetection": "force", "moduleDetection": "force",
"jsx": "react-jsx", "jsx": "react-jsx",
"jsxImportSource": "hono/jsx", "jsxImportSource": "hono/jsx",
"allowJs": true, "allowJs": true,
// Bundler mode // Bundler mode
"moduleResolution": "bundler", "moduleResolution": "bundler",
"allowImportingTsExtensions": true, "allowImportingTsExtensions": true,
"verbatimModuleSyntax": true, "verbatimModuleSyntax": true,
"noEmit": true, "noEmit": true,
// Best practices // Best practices
"strict": true, "strict": true,
"skipLibCheck": true, "skipLibCheck": true,
"noFallthroughCasesInSwitch": true, "noFallthroughCasesInSwitch": true,
"noUncheckedIndexedAccess": true, "noUncheckedIndexedAccess": true,
"noImplicitOverride": true, "noImplicitOverride": true,
// Some stricter flags (disabled by default) // Some stricter flags (disabled by default)
"noUnusedLocals": false, "noUnusedLocals": false,
"noUnusedParameters": false, "noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false "noPropertyAccessFromIndexSignature": false,
"baseUrl": ".",
"paths": {
"$*": [
"./src/server/*"
],
"@*": [
"./src/shared/*"
]
}
} }
} }