@auto-engineer/server-checks

Server validation commands for TypeScript type checking, ESLint linting, and Vitest test execution.

Purpose

Without @auto-engineer/server-checks, you would have to manually run TypeScript, ESLint, and Vitest separately, parse their outputs, and integrate results into your pipeline.

This package provides command handlers for validating server code quality. Each command follows the CQRS pattern, accepting a command and emitting passed or failed events for integration with event-driven workflows.

Installation

pnpm add @auto-engineer/server-checks

Quick Start

Register the handlers and run validation checks:

1. Register the handlers

import { COMMANDS } from '@auto-engineer/server-checks';
import { createMessageBus } from '@auto-engineer/message-bus';

const bus = createMessageBus();
COMMANDS.forEach(cmd => bus.registerCommand(cmd));

2. Send a command

const result = await bus.dispatch({
  type: 'CheckTypes',
  data: {
    targetDirectory: './server',
  },
  requestId: 'req-123',
});

console.log(result);
// → { type: 'TypeCheckPassed', data: { targetDirectory: './server', checkedFiles: 42 } }

The command runs tsc --noEmit and returns structured results.

How-to Guides

Run via CLI

auto check:types --target-directory=./server
auto check:lint --target-directory=./server
auto check:tests --target-directory=./server

Run with Auto-Fix

auto check:lint --target-directory=./server --fix

Run at Project Scope

auto check:types --target-directory=./server --scope=project

Run Programmatically

import { checkTypesCommandHandler } from '@auto-engineer/server-checks';

const result = await checkTypesCommandHandler.handle({
  type: 'CheckTypes',
  data: {
    targetDirectory: './server',
    scope: 'slice',
  },
  requestId: 'req-123',
});

Handle Errors

if (result.type === 'TypeCheckFailed') {
  console.error('Type errors:', result.data.errors);
  console.error('Failed files:', result.data.failedFiles);
}

if (result.type === 'LintCheckFailed') {
  console.error('Lint errors:', result.data.errorCount);
}

if (result.type === 'TestsCheckFailed') {
  console.error('Failed tests:', result.data.failedTests);
}

Enable Debug Logging

DEBUG=auto:server-checks:* auto check:types --target-directory=./server

API Reference

Exports

import {
  COMMANDS,
  checkTypesCommandHandler,
  checkLintCommandHandler,
  checkTestsCommandHandler,
} from '@auto-engineer/server-checks';

import type {
  CheckTypesCommand,
  TypeCheckPassedEvent,
  TypeCheckFailedEvent,
  CheckLintCommand,
  LintCheckPassedEvent,
  LintCheckFailedEvent,
  CheckTestsCommand,
  TestsCheckPassedEvent,
  TestsCheckFailedEvent,
} from '@auto-engineer/server-checks';

Commands

| Command | CLI Alias | Description | |---------|-----------|-------------| | CheckTypes | check:types | Run TypeScript type checking | | CheckLint | check:lint | Run ESLint validation | | CheckTests | check:tests | Run Vitest tests |

CheckTypesCommand

type CheckTypesCommand = Command<'CheckTypes', {
  targetDirectory: string;
  scope?: 'slice' | 'project';
}>;

CheckLintCommand

type CheckLintCommand = Command<'CheckLint', {
  targetDirectory: string;
  scope?: 'slice' | 'project';
  fix?: boolean;
}>;

CheckTestsCommand

type CheckTestsCommand = Command<'CheckTests', {
  targetDirectory: string;
  scope?: 'slice' | 'project';
}>;

Scope Options

| Value | Description | |-------|-------------| | slice | Check only files within target directory (default) | | project | Check all files in the project |

Architecture

src/
├── index.ts
└── commands/
    ├── check-types.ts
    ├── check-lint.ts
    └── check-tests.ts

The following diagram shows the check flow:

flowchart TB
    A[Command] --> B[Find Project Root]
    B --> C[Discover Files]
    C --> D[Run Tool]
    D --> E{Success?}
    E -->|Yes| F[PassedEvent]
    E -->|No| G[FailedEvent]

Flow: Command finds project root, discovers files based on scope, runs tool, emits result event.

Dependencies

| Package | Usage | |---------|-------| | @auto-engineer/message-bus | Command/event infrastructure | | execa | Process execution for tsc, eslint, vitest | | fast-glob | File discovery | | debug | Debug logging |