This package provides code quality scripts that can be run via Composer.
The scripts also work on continous integration (CI) servers like Jenkins.
Used for testing (SpecBDD) the code.
Must be configured with a phpspec.yml file in your root folder.
We are using the leanphp/phpspec-code-coverage extension for generating coverage reports.
This extension requires a phpspec-coverage.yml file in your root folder and Xdebug enabled.
Currently used for checking (linting) and fixing the code.
Sniffs all files in src directory.
Used for mess detection.
Runs the defined ruleset (config/phpmd.xml) on all files in src directory.
Run composer require --dev karriere/code-quality to install this package.
After installing, insert the desired scripts to your composer.json.
{
"scripts": {
"test": "Karriere\\CodeQuality\\SpecificationTest::run",
"lint": "Karriere\\CodeQuality\\CodeStyleChecker::run",
"fix": "Karriere\\CodeQuality\\CodeStyleFixer::run",
"coverage": "Karriere\\CodeQuality\\CodeCoverage::run",
"md": "Karriere\\CodeQuality\\MessDetector::run"
}
}You can run a script like this: composer {script} -- {options}.
If you are using Git-Shell on Windows (or Git-Shell in Intellij Terminal on Windows), call scripts like this:
composer.bat {script}. Otherwise colors will not work.
You can disable TTY by adding the --notty flag (needed for Jenkins).
On Windows platform it's disabled automatically.
composer {script} -- --env=jenkins --notty
Usage:
test [--] [options]
Options:
--fail Exit with 1 if tests fail.
--notty Disable TTY.
--ptimeout Set process timeout (defaults to 60 seconds).
-v --verbose Increase the verbosity of messages.
Usage:
coverage [--] [options]
Options:
--env Specifiy the environment. Possible values:
'local': prints output on command-line.
'jenkins': generates a JUnit report file.
--notty Disable TTY.
--ptimeout Set process timeout (defaults to 60 seconds).
Usage:
lint [--] [options]
Options:
--env Specifiy the environment. Possible values:
'local': prints output on command-line.
'jenkins': generates a checkstyle report file.
--fail Exit with 1 if linting fails.
--notty Disable TTY.
--ptimeout Set process timeout (defaults to 60 seconds).
Usage:
lint [--] [options]
Options:
--env Specifiy the environment. Possible values:
'local': prints output on command-line.
'jenkins': generates a xml report file.
--notty Disable TTY.
--ptimeout Set process timeout (defaults to 60 seconds).
Usage:
fix [--] [options]
Options:
--notty Disable TTY.
--ptimeout Set process timeout (defaults to 60 seconds).
This package integrates karriere/phpspec-matchers.
In order to use the custom matchers defined in this package,
please include the extension configuration in your phpspec.yml.
The code-coverage-extension slows down the phpspec tests, so we excluded it from the normal configuration file. Keep tests fast!
Run composer test -- -v.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent