phug / dev-tool
Phug unit tests, coverage and code style tools
Fund package maintenance!
kylekatarnls, TorbenKoehn
Open Collective
Tidelift
Installs: 19 998
Dependents: 3
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- php: >=5.5.0
- phpunit/php-code-coverage: ^2.2 || ^4.0 || ^5.2 || ^6.0 || ^7.0
- phpunit/phpunit: ^4.8.35 || ^5.7 || ^6.0 || ^7.0 || ^8.0
- squizlabs/php_codesniffer: ^2.8 || ^3.0
- symfony/console: ^3.2 || ^4.0 || ^5.0
This package is auto-updated.
Last update: 2024-10-16 14:56:37 UTC
README
What is Phug Dev Tool?
The Phug Dev Tool is a command-line utility that comes with required libraries to develop the Phug template engine.
Installation
Install via Composer
composer require phug/dev-tool --dev
Usage
Available Commands
install
Updates composer and installs composer dependencies
check
Runs unit-tests:run
, code-style:check
and coverage:check
in this order and fails as soon as one of the commands fail.
Return code is the return code of the failed command.
If --report
is set, this command will generate code-coverage data and report it to code-climate.
code-style:check
Automatically scans code for problems regarding PSR-2
and attempts to fix them if wanted.
This runs phpcs
with a default config or a local config, if found.
code-style:fix
Automatically fixes code-problems regarding PSR-2
.
This runs phpcbf
with a default config or a local config, if found.
unit-tests:run
Runs unit tests located in ./tests
.
You can pass --coverage-text
and --coverage-clover=<targetXmlPath>
to generate code-coverage information.
coverage:check
Checks existing code-coverage data and fails if a specific percentage coverage (80% by default) is not reached.
Accepts --input-file=<targetXmlPath>
that points to a coverage file generated by unit-tests:run --coverage-clover=<targetXmlPath>
coverage:report
Reports coverage data to CodeClimate.
Accepts --input-file=<targetXmlPath>
that points to a coverage file generated by unit-tests:run --coverage-clover=<targetXmlPath>
Security contact information
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.