https://github.com/jbzoo/codestyle
Collection of QA tools and JBZoo coding-standards
https://github.com/jbzoo/codestyle
codestyle jbzoo makefile phpcs phpmd testing testing-tools
Last synced: 20 days ago
JSON representation
Collection of QA tools and JBZoo coding-standards
- Host: GitHub
- URL: https://github.com/jbzoo/codestyle
- Owner: JBZoo
- License: mit
- Created: 2020-05-17T16:45:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T20:29:38.000Z (about 1 year ago)
- Last Synced: 2024-04-26T09:20:40.840Z (about 1 year ago)
- Topics: codestyle, jbzoo, makefile, phpcs, phpmd, testing, testing-tools
- Language: PHP
- Homepage:
- Size: 282 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JBZoo / Codestyle
[](https://github.com/JBZoo/Codestyle/actions/workflows/main.yml?query=branch%3Amaster) [](https://coveralls.io/github/JBZoo/Codestyle?branch=master) [](https://shepherd.dev/github/JBZoo/Codestyle) [](https://shepherd.dev/github/JBZoo/Codestyle) [](https://www.codefactor.io/repository/github/jbzoo/codestyle/issues)
[](https://packagist.org/packages/jbzoo/codestyle/) [](https://packagist.org/packages/jbzoo/codestyle/stats) [](https://packagist.org/packages/jbzoo/codestyle/dependents?order_by=downloads) [](https://github.com/JBZoo/Codestyle/blob/master/LICENSE)
Provides popular tools and general code style standards for all JBZoo projects.
### Makefile
Add into your Makefile the line to have predefined commands like `test-*`, `help`, `list`, etc.
```makefile
ifneq (, $(wildcard ./vendor/jbzoo/codestyle/src/init.Makefile))
include ./vendor/jbzoo/codestyle/src/init.Makefile
endif
update: ##@Project Install/Update all 3rd party dependencies
$(call title,"Install/Update all 3rd party dependencies")
@echo "Composer flags: $(JBZOO_COMPOSER_UPDATE_FLAGS)"
@composer update $(JBZOO_COMPOSER_UPDATE_FLAGS)
test-all: ##@Project Run all project tests at once
@make test
@make codestyle
```
### Makefile Build-in help
```
Usage:
- `make [target]`
- `make [target] OPTION=value`
- `ENV_VAR=value make [target]`
Misc:
help Show this text
list Full list of targets
Project:
autoload Dump optimized autoload file for PHP
build-phar Compile phar file
clean Cleanup only build directory
clean-vendor Cleanup all
test-all Run all project tests at once
update Install/Update all 3rd party dependencies
Tests:
codestyle Launch all codestyle linters at once
test Launch PHPUnit Tests (alias "test-phpunit")
test-composer Validates composer.json and composer.lock
test-composer-reqs Checks composer.json the defined dependencies against your code
test-performance Run benchmarks and performance tests
test-phan Phan - super strict static analyzer for PHP
test-phpcpd PHPcpd - Find obvious Copy&Paste
test-phpcs PHPcs - Checking PHP Code Sniffer (PSR-12 + PHP Compatibility)
test-phpcsfixer PhpCsFixer - Check code to follow stylish standards
test-phpcsfixer-fix PhpCsFixer - Auto fix code to follow stylish standards
test-phpmd PHPmd - Mess Detector Checker
test-phpmd-strict PHPmd - Mess Detector Checker (strict mode)
test-phpmnd PHPmnd - Magic Number Detector
test-phpstan PHPStan - Static Analysis Tool
test-phpunit PHPUnit - Launch General Tests
test-psalm Psalm - static analysis tool for PHP
Reports:
report-all Build all reports at once
report-composer-diff What has changed after a composer update
report-composer-graph Build composer graph of dependencies
report-coveralls Send coverage report to coveralls.io
report-merge-coverage Merge all coverage reports in one clover file
report-pdepend Build PHP Depend Report
report-performance Build performance summary report
report-phploc PHPloc - Show code stats
report-phpmetrics Build PHP Metrics Report
update-extend Checks new compatible versions of 3rd party libraries
Trick: Add into your "~/.bash_aliases" the line "complete -W "\`make list\`" make" to use TAB
```