Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-01-10 20:08:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

prepare master merge

Browse Source
This commit is contained in:
Dennis Eichhorn 2024-04-24 23:37:15 +00:00
parent 495ee35225
commit 55c964b0d7
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
quality/inspections.md
View File

@ -10,9 +10,10 @@ The following automated tests must pass without errors, failures and warnings fo
* `php ./vendor/bin/php-cs-fixer fix ./ --config=Build/Config/.php-cs-fixer.php --allow-risky=yes`
* `php ./vendor/bin/phpcbf --standard=Build/Config/phpcs.xml ./`
* `php ./vendor/bin/phpcs --severity=1 ./ --standard="Build/Config/phpcs.xml"`
* `php ./vendor/bin/phpunit -c tests/phpunit_no_coverage.xml`
* `php ./vendor/bin/rector process --config Build/Config/rector.php --dry-run ./`
* `npx eslint ./ -c Build/Config/.eslintrc.json`
* `find . -regex '.*\.\(cpp\|h\)' -exec clang-format -style=file:Build/Config/.clang-format -i {} \;`
* `php ./vendor/bin/phpunit -c tests/phpunit_no_coverage.xml`
* `./Build/Config/jasmine_build.sh && npx jasmine --config=Build/Config/jasmine.json`
* `./cOMS/tests/test.sh`
@ -138,6 +139,7 @@ Tools used for the code inspection are:
* PHP CS Fixer
* PHP CBF
* Rector
* Clang-Format
* Custom scripts/tools
### PHPUnit
@ -219,6 +221,14 @@ php vendor/bin/phpcbf --standard=Build/Config/phpcs.xml ./
php vendor/bin/rector process --dry-run --config Build/Config/rector.php ./
```
### Clang-Format
The c/c++ code base has a defined code style standard. The following command automatically fixes some of the violations
```sh
find . -regex '.*\.\(cpp\|h\)' -exec clang-format -style=file:Build/Config/.clang-format -i {} \;
```
### Jasmine
The javascript testing is done with jasmine. The javascript testing directory is structured the same way as the `Framework`. Unit tests for specific classes need to be named in the same manner as the testing class.
@ -323,7 +333,7 @@ quadrantChart;
y-axis Low Importance --> High Importance;
PHPStan: [0.2, 0.5];
*UI tests: [0.8, 0.05];
PHPCS/CBF/Fixer/Rector/eslint: [0.1, 0.1];
Code Style: [0.1, 0.1];
PHPUnit: [0.5, 0.75];
cOMS/tests.sh: [0.2, 0.2];
Jasmine: [0.3, 0.5];