k-kinzal / requirements
Links source text, EARS specifications, and tests for PHP projects
dev-main
2026-09-28 02:33 UTC
Requires
- php: ^8.1
- ext-dom: *
- ext-libxml: *
- ext-mbstring: *
- league/commonmark: ^2.7
- opis/json-schema: ^2.6
- symfony/console: ^6.4
- symfony/css-selector: ^6.4
- symfony/dom-crawler: ^6.4
- symfony/http-client: ^6.4
- symfony/process: ^6.4
- symfony/yaml: ^6.4
Requires (Dev)
- behat/behat: ^3.14
- brianium/paratest: ^7.3
- deptrac/deptrac: ^3.0
- friendsofphp/php-cs-fixer: ^3.95.25
- k-kinzal/php-ai-toolkit: dev-main
- phpcompatibility/php-compatibility: ^10.0.0-alpha2
- phpstan/phpstan: ^2.1
- phpstan/phpstan-strict-rules: ^2.0
- phpunit/phpunit: ^10.5
- squizlabs/php_codesniffer: ^4.0.4
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-09-28 02:33:14 UTC
README
Requirements connects source text, EARS specifications and executable tests for PHP projects. It finds changed quotations, unaccounted source units, unsupported behaviour and specifications without sources. Requirements are optional upstream records; specifications and their verification are the central model. Coverage is limited to explicitly selected source scopes and does not prove semantic equivalence.
Requirements
- PHP 8.1+ with the dom, libxml and mbstring extensions
- PHPUnit 10.5+ or Behat 3.14+ to run linked tests
Getting Started
$ composer require --dev k-kinzal/requirements $ vendor/bin/requirements --help Requirements Usage: command [options] [arguments] Options: -h, --help Display command help, or the application overview when no command is given. -q, --quiet Do not output any message -V, --version Display this application version --ansi|--no-ansi Force (or disable --no-ansi) ANSI output -n, --no-interaction Do not ask any interactive question -c, --config=CONFIG Path to the YAML project configuration. [default: "requirements.yaml"] --json Write a JSON report to stdout instead of terminal tables. -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug Available commands: check Verify quotations against the declared source scopes. completion Dump the shell completion script coverage Show source coverage and enforce total and differential gates. format Format YAML and Markdown definition documents. help Display help for a command lint Validate schemas, EARS syntax and cross-file traceability. list List commands spec Browse specifications and requirements, and verify linked tests unless --no-test is set.
License
MIT License. See LICENSE for details.