Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
87 lines (65 loc) · 2.75 KB

DEVELOPMENT.md

File metadata and controls

87 lines (65 loc) · 2.75 KB
Raw

Development Guide

Prerequisites

Setup

git clone https://github.com/luongnv89/asm.git
cd asm
npm install

Running

npm start        # Launch the TUI
npm run dev          # Same as start (alias)

To test CLI commands during development:

npx tsx bin/agent-skill-manager.ts list
npx tsx bin/agent-skill-manager.ts search "my-skill"
npx tsx bin/agent-skill-manager.ts audit --json
npx tsx bin/agent-skill-manager.ts --help

Testing

npm test             # Run all tests
npm run typecheck    # Type-check without emitting
npm run lint         # ESLint over src/

Verified results for npm run build, CI=true npm test, npm run typecheck, and npm run lint:site, the Node version constraints, and two repo-specific traps (scripts that rewrite tracked files; the unit suite writing to your real ~/.config/agent-skill-manager/) are recorded in AGENT_ENVIRONMENT.md.

Test files are co-located with source files using the *.test.ts convention. 44 *.test.ts files live under src/, one per module — e.g. cli.test.ts, scanner.test.ts, installer.test.ts, eval/*.test.ts. Run npm test for the full, current list.

Pre-commit Hooks

The project uses pre-commit with:

  • trailing-whitespace — removes trailing whitespace
  • end-of-file-fixer — ensures files end with a newline
  • check-yaml / check-json — validates config files
  • check-added-large-files — prevents accidental large file commits
  • prettier — auto-formats TS, JS, JSON, CSS, and MD files (commit)
  • lint — runs npm run lint (ESLint over src/) (commit)
  • typecheck — runs tsc --noEmit on staged TypeScript files (commit)
  • unit-tests — npx vitest run src/ (push)
  • build / e2e-node — production build and node e2e (push)

Install both hook stages; a plain pre-commit install skips pre-push:

pre-commit install --hook-type pre-commit --hook-type pre-push

Debugging

Since this is a TUI application, standard console.log will interfere with the terminal UI. For debugging:

  1. Write to a log file: fs.writeFileSync("/tmp/sm-debug.log", JSON.stringify(data))
  2. Run tests to isolate logic from the TUI layer
  3. Use CLI commands to test core logic without launching the TUI: 
    npx tsx bin/agent-skill-manager.ts list --json
npx tsx bin/agent-skill-manager.ts audit --json
  4. Use the --help flag to verify CLI plumbing without launching the TUI

Project Layout

See ARCHITECTURE.md for the full component breakdown and data flow diagrams.