Skip to content

validation.md

Latest commit

 

History

History
156 lines (117 loc) · 5.87 KB

validation.md

File metadata and controls

156 lines (117 loc) · 5.87 KB
Raw

Validation

Eliware Test runs deterministic checks for the selected profiles. It does not publish, deploy, release, or change external systems. It does not run semantic reviews.

Aggregate validation

Run this command from the consumer repository root:

eliware-test

The CLI selects checks from package.json.eliware.apply. It runs enabled work in this order:

  1. Lint.
  2. Format check.
  3. npm audit.
  4. npm outdated.
  5. Package check when npm-published applies.
  6. Typecheck when library applies.
  7. Build when web applies.
  8. Convention checks.
  9. Jest and coverage.

The CLI skips a stage when its profile does not require it. It runs all earlier stages and checks before Jest. It skips Jest when an earlier stage fails. It reports all failures and returns the highest failure code. The CLI runs Jest without the consumer's npm test script.

Focused validation

Pass one or more test paths to select a focused run:

eliware-test tests/example.test.mjs
eliware-test tests/one.test.mjs tests/two.test.mjs

The CLI runs only the selected Jest tests. It checks lint, format, and applicable layout rules for each selected test and matching source module. It checks coverage for each matching source module. It runs other checks only when their rules can use the selected files. It skips repository-wide checks that cannot use the focused file list.

Pass a Jest option after --:

eliware-test tests/example.test.mjs -- --testNamePattern "case name"

Put each test path before --. Do not pass tool modes with focused paths. The CLI rejects absolute paths, parent traversal, and paths that do not start with tests/. The CLI also rejects options that replace its Jest configuration, reporters, coverage, or test selection.

Application and library profiles require one .test.mjs file for each maintained .mjs source. Each application or library test must contain an executable Jest test. Store each library declaration file in the directory of its matching .mjs source.

Jest and coverage

The CLI uses consumer Jest when available. If not, it uses bundled Jest. It reads supported Jest settings from package.json. It rejects Jest configuration files not in package.json. Configured reporter names must be strings. Reporter option objects are not supported.

The CLI runs Jest with --runInBand, --detectOpenHandles, and --no-cache on each run. It adds a reporter and coverage reports. It keeps the consumer's required coverage settings. The selected profile rules define required coverage thresholds.

Before each Jest run, the CLI clears the consumer's coverage/ directory. Jest writes coverage reports and jest-console-output.json to that directory. The CLI keeps these files after the run. The CLI also writes stage, check, and suite timing to coverage/eliware-test.log. The CLI keeps this timing log while it clears other coverage files. The CLI does not use system temp or user folders for its temporary files.

Each test suite has a ten-second limit. A 15-second watchdog also covers startup and pauses between suites. Output does not change the limits. The CLI requests a graceful stop after a timeout. It forces a stop after one second. The CLI reports an error if the child command does not close.

Read the summary

After a clean aggregate or focused run, the CLI reports:

  • The number of checks, Jest suites, and tests.
  • The number of lint warnings, format issues, audit issues, and pack issues.
  • The time for checks, Jest, and the full run.
  • The exit code on the final line.

Use --debug-timing to show stage, check, and suite timings on the console. The CLI writes the same timing lines to coverage/eliware-test.log on every run.

README links

The general profile checks local README links and Markdown fragments. It checks supported links in Markdown and quoted HTML attributes. It does not fetch external links or fragments. It ignores links in code spans and fenced code blocks. Read the general convention files for the supported link forms.

Repository specifications

The CLI parses all YAML files in specs/. The CLI checks YAML syntax in all files. It checks the directives schema only when a YAML document has a top-level directives key. It checks unique rule IDs across all directive files. It checks each specs/ index against YAML files in its folder and child indexes. Read the profile rules for the full specs/ layout.

Repository map and links

The general check reads ../docs/repo-map.yaml when that file exists. When it finds a matching entry, it compares the repository ID, description, keywords, and profiles. Without a map, the package metadata supplies the repository description and rule ID namespace. The CLI checks local README links and fragments without network access. It does not check if an external website responds.

Data and validation scope

The CLI checks tracked links through the Git index. It rejects tracked file and directory symlinks. It does not resolve symlink targets.

Keep secrets out of child command output. The CLI redacts known secrets when it writes diagnostics. That redaction cannot find all secrets.

README and AGENTS sections

The general checks require content after every required level-two heading in README.md and AGENTS.md. The checks report a section when it contains only blank lines or other headings. The semantic conventions define the information that belongs in each section.

Documentation and release notes

The General profile requires documentation and release notes in every repository. Keep a docs/README.md index and link it from the root README.md. Index each maintained Markdown file in docs/, except the index itself. Keep RELEASE_NOTES.md and link it from the root README Usage section. Read the General convention files for release-note format and content rules.

Eliware Test runs validation only. It does not change a release or deployment system.

Return to documentation.