Eve library

Neith QA API Reference

Guide

Revision 1

On this page

Reference guide for the public surface of @neith/qa.

Entry Points#

typescript
import * as qa from '@neith/qa';
import * as codeQuality from '@neith/qa/code-quality';
import * as docQuality from '@neith/qa/doc-quality';

Root Package API#

The root package re-exports:

  • shared report and issue types from src/types.ts
  • all code-quality auditors from src/code-quality/index.ts
  • all doc-quality analyzers from src/doc-quality/index.ts

This means the root import is the most complete surface for downstream tooling that wants a single entry point.

Code Quality API#

The @neith/qa/code-quality subpath exports deterministic repository auditors for:

  • linting, formatting, complexity, technical debt, duplication, dependencies, dead code, and security analysis
  • repository governance checks such as PR gates, merge checks, branch protection, and release gates
  • Phase 52 sovereignty and completion certifications including domain migration, third-party isolation, sovereign replacement availability, self-hostability, integration coverage, E2E coverage, performance regression, license compliance, SBOM completeness, developer documentation, user documentation, API documentation, training materials, community resources, and support infrastructure

Most code-quality modules follow the same shape:

  • exported constants describing the certified scope
  • an *Auditor class with an audit(repoRoot) method
  • a format*Report(...) or format*CertificationReport(...) helper for published ledgers

Documentation Quality API#

The @neith/qa/doc-quality subpath exports documentation analyzers for:

  • linting and coverage
  • API docs validation
  • link detection and example validation
  • tutorial testing and screenshot automation
  • changelog and release-note checks
  • translation, terminology, style-guide, accessibility, readability, and search

These modules are intended for reuse by documentation gates and domain-level QA automation.

Report Model API#

src/types.ts exports the shared report contracts used across both subpaths. This includes:

  • generic QA reports such as lint, dependency, and security models
  • doc-quality report models
  • Phase 52 certification-specific report types for sovereignty, test coverage, performance, SBOM, documentation completion, training-material completion, and community-resource completion, and support-infrastructure completion

Consumers building dashboards or additional report formatters should depend on these types rather than duplicating schemas.

Stability Notes#

  • @neith/qa is designed for deterministic local/repository analysis rather than long-lived service execution.
  • Most APIs operate on a repository root path and return structured reports.
  • Certification modules are tightly coupled to the implemented Neith Phase 52 footprint and should be updated when that footprint changes.