Skip to content

Latest commit

 

History

History
123 lines (77 loc) · 2.24 KB

Development.md

File metadata and controls

123 lines (77 loc) · 2.24 KB

Meritoo Common Library

Development-related information

Requirements

  • Docker
  • Your favourite IDE :)

Getting started

  1. Build, create and start Docker's containers by running command:

    docker-compose up -d

  2. Rebuild project by running command (installs packages, prepares required directories and runs tests):

    docker-compose exec php phing

What is Docker?

Composer

Available as composer service. You can run any Composer's command using the composer service:

docker-compose run --rm composer [command]

Examples below.

Install packages
docker-compose run --rm composer install
Update packages
docker-compose run --rm composer update
Add package
docker-compose run --rm composer require [vendor]/[package]
Remove package
docker-compose run --rm composer remove [vendor]/[package]

Coding Standards Fixer

Fix coding standard by running command:

docker-compose exec php php-cs-fixer fix

or

docker-compose exec php phing -f phing/tests.xml build:fix-coding-standards

Omit cache and run the Fixer from scratch by running command:

docker-compose exec php rm .php_cs.cache && docker-compose exec php php-cs-fixer fix

Want more?

Tests

Prerequisites

Install required packages by running command: docker-compose run --rm composer install.

Running PHPUnit tests

Easy (with code coverage)
docker-compose run --rm phpunit --verbose

or

docker-compose exec php phing -f phing/tests.xml test:phpunit
Quick (without code coverage)
docker-compose run --rm phpunit --verbose --no-coverage

Versions of packages

squizlabs/php_codesniffer

I have to use squizlabs/php_codesniffer ^2.9 instead of ^3.3, because Phing doesn't support 3.x PHP_CodeSniffer.

Other

Rebuild project and run tests by running command:

docker-compose exec php phing

‹ Back to Readme