Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Findings — tests failed, contracts have problems |
2 | Misconfiguration — the config is missing, invalid, or unreadable |
A CI job that gates on findings needs to tell "your contracts have problems" apart from "your pipeline is broken".
Exports
| Export | Purpose |
|---|---|
defineConfig(config) | Type-safe config helper; accepts an object or a function |
defineTypeFetchTestConfig(config) | Deprecated alias for the pre-2.0 flat shape |
loadTypeWireConfig(options) | Find, merge and validate the config yourself |
requireTypeFetch(config, command) | The typefetch section, or an error naming the command |
TypeWireConfigError | Carries exitCode: 2 |
runCli(argv) | Run the CLI programmatically |
writeReportFiles(report, path) | Write a report as .md, .html or .json |
License
MIT © Taha Nabavi ↗