Mirrors/wiosna-dev_common-library
1
0
Fork 1
mirror of https://github.com/wiosna-dev/common-library.git synced 2026-03-12 01:31:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation > Development > add commands based on Phing & update whole document

Browse Source
This commit is contained in:
Meritoo
2018-10-28 00:09:29 +02:00
parent 822dbf6830
commit 61209e3f67
1 changed files with 34 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/Development.md
View File

@@ -15,10 +15,10 @@ Development-related information
docker-compose up -d
```
2. Install packages by running command:
2. Rebuild project by running command (installs packages, prepares required directories and runs tests):
```bash
docker-compose run composer install
docker-compose exec php phing
```
> [What is Docker?](https://www.docker.com/what-docker)
@@ -28,7 +28,7 @@ Development-related information
Available as `composer` service. You can run any Composer's command using the `composer` service:
```bash
docker-compose run composer <command>
docker-compose run --rm composer [command]
```
Examples below.
@@ -36,25 +36,25 @@ Examples below.
##### Install packages
```bash
docker-compose run composer install
docker-compose run --rm composer install
```
##### Update packages
```bash
docker-compose run composer update
docker-compose run --rm composer update
```
##### Add package
```bash
docker-compose run composer require <vendor>/<package>
docker-compose run --rm composer require [vendor]/[package]
```
##### Remove package
```bash
docker-compose run composer remove <vendor>/<package>
docker-compose run --rm composer remove [vendor]/[package]
```
# Coding Standards Fixer
@@ -65,6 +65,12 @@ Fix coding standard by running command:
docker-compose exec php php-cs-fixer fix
```
or
```bash
docker-compose exec php phing -f phing/tests.xml build:fix-coding-standards
```
Omit cache and run the Fixer from scratch by running command:
```bash
@@ -77,37 +83,35 @@ docker-compose exec php rm .php_cs.cache && docker-compose exec php php-cs-fixer
### Prerequisites
Install required packages by running command: `docker-compose run composer install`.
Install required packages by running command: `docker-compose run --rm composer install`.
### Running tests
### Running [PHPUnit](https://phpunit.de) tests
#### Simply & quick, without code coverage
Tests are running using Docker and `php` service defined in `docker-compose.yml`. Example:
##### Easy (with code coverage)
```bash
docker-compose exec php phpunit --no-coverage
docker-compose run --rm phpunit --verbose
```
You can also run them in container. In this case you have to run 2 commands:
1. Enter container:
```bash
docker-compose exec php bash
```
2. Run tests:
```bash
phpunit --no-coverage
```
#### With code coverage
or
```bash
docker-compose exec php phpunit
docker-compose exec php phing -f phing/tests.xml test:phpunit
```
##### Quick (without code coverage)
```bash
docker-compose run --rm phpunit --verbose --no-coverage
```
# Versions of packages
### squizlabs/php_codesniffer
I have to use [squizlabs/php_codesniffer](https://packagist.org/packages/squizlabs/php_codesniffer) `^2.9` instead of
`^3.3`, because [Phing doesn't support 3.x PHP_CodeSniffer](https://github.com/phingofficial/phing/issues/716).
# Other
Rebuild project and run tests by running command: