aislop AGENTS.md

AI Agent Instructions for aislop

This file provides context for AI coding assistants (Claude Code, OpenCode, Copilot, Cursor, etc.) working on the aislop codebase.

What is aislop?

aislop is a unified code-quality CLI that catches the lazy patterns AI coding tools leave behind. It runs formatting, linting, code-quality, AI-pattern, architecture, and security checks behind a single command and returns a score out of 100.

• npm package: aislop
• CLI binary: aislop
• Config directory: .aislop/
• Repository: https://github.com/scanaislop/aislop

Build & test commands

pnpm install           # Install dependencies
pnpm build             # Build with tsdown (tsdown cleans dist itself)
pnpm typecheck         # tsc --noEmit
pnpm test              # Build + vitest run
pnpm vitest run        # Run tests without rebuilding (faster iteration)
pnpm scan              # Build + run aislop on itself
node dist/cli.js scan . # Run after building manually

Cross-platform scripts

Contributors and CI run on Linux, macOS, and Windows. Keep package.json scripts portable:

• No Unix-only shell in scripts. rm -rf, cp, mv, etc. fail under cmd.exe on Windows. tsdown already cleans its output directory before each build, so an explicit rm -rf dist is redundant; the build script is just tsdown.
• No VAR=value cmd prefixes. cmd.exe cannot parse a leading env-var assignment, so NODE_ENV=production tsdown errors with 'NODE_ENV' is not recognized. If a script genuinely needs an env var set cross-platform, add the cross-env dev dependency and use cross-env VAR=value cmd.
• A green Linux CI run is not a Windows guarantee. A handful of path/permission tests (home-dir resolution, 0600 permission bits, repo-relative path conversion) are environment-specific and may fail locally on Windows while passing in CI. Emit forward-slash paths in diagnostics so /-anchored classifiers match on every OS.