Development Guide
Quick Start
Section titled “Quick Start”# Enable corepack and use pnpmcorepack enable
# Install dependenciespnpm install
# Install the repository-managed Git hookspnpm run hooks:install
# Build all packagespnpm run build
# Run testspnpm run testCommon Commands
Section titled “Common Commands”| Command | Description |
|---|---|
pnpm run build | Build all packages (Turborepo) |
pnpm run dev | Watch mode for development |
pnpm run lint | Lint the entire monorepo |
pnpm run lint:fix | Auto-fix lint issues |
pnpm run test | Run integration tests (Vitest) |
pnpm run inspector | Open ESLint config inspector UI |
pnpm run docs | Generate API docs (TypeDoc) |
pnpm run hooks:install | Install the hooks declared in quality.yml |
pnpm run clean | Remove all dist/ and node_modules/ |
Quality CLI prerequisite
Section titled “Quality CLI prerequisite”The Git hooks are managed by the external quality CLI,
not by a JavaScript workspace dependency. Install the checksum-verified native
binary before running pnpm run hooks:install:
curl --proto '=https' --tlsv1.2 -fsSL \ https://raw.githubusercontent.com/santi020k/quality/main/install.sh \ | sh -s -- santi020k/quality v1.1.1
quality --versionpnpm run hooks:installquality hooks statusThe repository’s hook definitions live in quality.yml; rerun the install
command after changing them.
Project Structure
Section titled “Project Structure”This is a monorepo using Turborepo + pnpm Workspaces. Each config lives under packages/:
packages/basic— Main entry point, composes all configspackages/core— Core JS rules, types, utilitiespackages/typescript— TypeScript rulespackages/react— React + Hooks rulespackages/next— Next.js rulespackages/astro— Astro rulespackages/expo— Expo/React Native rulespackages/nest— NestJS rulespackages/vue— Vue rulespackages/{extensions,formats,libraries,testing,tools}— dependency-owning feature packs.packages/integrations— compatibility aggregate over the feature packs.packages/tests— Integration testspackages/playground— Local testing playground
Validation
Section titled “Validation”Always validate your changes before submitting:
pnpm run okFor full contributing guidelines, see the CONTRIBUTING.md.
Did this page help?
One click helps us spot documentation that needs another pass. No personal data is sent.