Skip to content

Latest commit

 

History

History
132 lines (96 loc) · 4.56 KB

File metadata and controls

132 lines (96 loc) · 4.56 KB

eliware.org

@eliware/test npm version license CI

Documentation: docs · specifications · release notes

Purpose

@eliware/test is the shared deterministic validation CLI for Eliware repositories. This repository is the native v8 implementation; it does not provide a v7 compatibility layer.

Description: Shared deterministic repository validation for Eliware projects. Keywords: eliware, testing, validation, jest, oxlint, prettier, cli. Author: Eliware eliware@eliware.org. License: MIT. Repository: https://github.com/eliware/test.

Requirements

Node.js 26 is required.

Setup

npm ci

Usage

Commands are exposed through the eliware-test CLI.

npm test
npm run lint
npm run format:check
npm run audit
npm run pack
node bin/eliware-test.mjs --help
node bin/eliware-test.mjs --version
node bin/eliware-test.mjs --ignore-100x4
node bin/eliware-test.mjs --ignore-monolith-limits
node bin/eliware-test.mjs --debug-timing
node bin/eliware-test.mjs --lint
node bin/eliware-test.mjs --format
node bin/eliware-test.mjs --format-check
node bin/eliware-test.mjs tests/example.test.mjs

--format mutates files; --format-check only validates formatting. --pack validates the package contents without publishing it.

The public CLI accepts the corresponding --audit and --pack flags. The npm script forms are the supported package-level shortcuts; arbitrary npm script names are not CLI arguments.

The two --ignore-* flags bypass enforcement and are diagnostic-only. They must not be used for release validation or CI and require approved transitional use.

The v8 orchestration and convention-check registry are implemented as focused native ESM modules under src/.

Authority and scope

Test owns the validator architecture, public CLI lifecycle, deterministic check execution, and validation acceptance contract. Docs owns cross-repository documentation and authority mapping; Conventions owns the policies Test validates; Operations owns cross-cutting release, deployment, and publication procedures. Test consumes those policies and does not redefine them.

For web applicability, document routes, assets, configuration, ports, browser validation, and deployment boundaries. Library applicability additionally requires public API, packaging, and examples documentation. This repository does not provide a separate consumer-facing examples catalog; the focused CLI command above is an invocation example, not that missing examples surface.

Exit codes identify the failed validation stage: 0 is success, 8 is Jest failure, 10 is coverage failure, 12 is lint failure, 14 is an internal tool failure, 17 is a package-check failure, and 18 is a convention failure. Validation output is intended to preserve actionable diagnostics and does not print secrets or arbitrary environment values. The CLI performs no deploy, publish, release, or destructive repository operation.

Configuration

Repository convention applicability is declared in package.json under eliware.apply. Test-specific directives are documented in specs/directives.json.

Validation

npm test
npm run lint
npm run format:check
git diff --check

Operations

This package performs local and CI validation only. Release, publication, deployment, and other operational changes are controlled by the applicable Eliware runbooks and are not performed by eliware-test.

Security

Never commit secrets, credentials, private runtime state, or generated output.

Support

Discord

eliware.org on Discord

Use the Eliware Discord community, GitHub issues, or eliware@eliware.org. Include the command, Node.js version, and redacted diagnostics when requesting help.

License

license

Links