jbzoo/codestyle

Collection of QA tools and JBZoo code standards

7.1.2 2024-03-26 20:28 UTC

Requires

• php: ^8.1
• friendsofphp/php-cs-fixer: >=3.48.0
• jbzoo/data: ^7.1
• kubawerlos/php-cs-fixer-custom-fixers: >=3.19.2
• nikic/php-parser: >=4.18.0
• pdepend/pdepend: >=2.16.2
• phan/phan: >=5.4.3
• phpmd/phpmd: >=2.15.0
• phpmetrics/phpmetrics: >=2.8.2
• phpstan/phpstan: >=1.10.57
• phpstan/phpstan-strict-rules: >=1.5.2
• povils/phpmnd: >=3.4.0
• squizlabs/php_codesniffer: >=3.8.1
• symfony/console: >=6.4
• symfony/finder: >=6.4
• symfony/yaml: >=6.4
• vimeo/psalm: >=5.20.0

Requires (Dev)

• jbzoo/phpunit: ^7.0
• jbzoo/utils: ^7.1.1
• symfony/var-dumper: >=6.4

MIT

• Denis Smetannikov

• php
• phpunit
• tests
• phpcs
• qa
• phpmd
• php-cs-fixer
• phpmetrics
• jbzoo
• Codestyle
• coding-standard
• PHPStan
• phan
• psalm
• phpcompatibility

README

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.

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