Skip to content
This repository has been archived by the owner on Mar 19, 2023. It is now read-only.

Commit

Permalink
Merge pull request #12 from mll-lab/readme
Browse files Browse the repository at this point in the history
Enhance README and gitignore
  • Loading branch information
ceesvanegmond authored Mar 26, 2019
2 parents 0a39613 + 0e24369 commit c173f21
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 19 deletions.
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
composer.phar
/vendor/
# Don't commit the lock file as this is a library
composer.lock

# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
# composer.lock
.idea/
grumphp.yml
43 changes: 27 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
# GrumPHP Extra tasks

This package is brought alive to extend the functionalities of the already existing [GrumPHP](https://github.com/phpro/grumphp).

## Installation
Add this package using composer, firstly add the packages repository

The easiest way to install this package is through composer:

composer require --dev wearejust/grumphp-extra-tasks

Then, require the this repository
Add the extension loader to your `grumphp.yml`

```json
composer require --dev wearejust/grumphp-extra-tasks
```yaml
parameters:
extensions:
- Wearejust\GrumPHPExtra\Extension\Loader
```
## Usage
### PhpCsAutoFixer
In this main package it is not possible to use the php-cs-fixer [to auto fix your files according to your config](https://github.com/phpro/grumphp/issues/110). This package adds this missing feature.
The configuration of this custom task is the same as the already [existing](https://github.com/phpro/grumphp/blob/master/doc/tasks/php_cs_fixer.md) task, only specify the new `php_cs_auto_fixer` configuration key. For example:
In [grumphp core](https://github.com/phpro/grumphp)
it is not possible to use the php-cs-fixer [to auto fix your files according to your config](https://github.com/phpro/grumphp/issues/110).
This package adds this missing feature.
The configuration of this custom task is the same as [the already existing task](https://github.com/phpro/grumphp/blob/master/doc/tasks/php_cs_fixer.md),
only specify the new `php_cs_auto_fixer` configuration key. For example:

```yaml
parameters:
Expand All @@ -27,14 +36,16 @@ parameters:
fixers: []
level: ~
verbose: true
extensions:
- Wearejust\GrumPHPExtra\Extension\Loader
```

### PhpCsAutoFixerV2
In this main package it is not possible to use the php-cs-fixer [to auto fix your files according to your config](https://github.com/phpro/grumphp/issues/110). This package adds this missing feature, but for php-cs-fixerv2

The configuration of this custom task is the same as the already [existing](https://github.com/phpro/grumphp/blob/master/doc/tasks/phpcsfixer2.md) task, only specify the new `php_cs_auto_fixerv2` configuration key. For example:
In [grumphp core](https://github.com/phpro/grumphp)
it is not possible to use the php-cs-fixer [to auto fix your files according to your config](https://github.com/phpro/grumphp/issues/110).
This package adds this missing feature.

The configuration of this custom task is the same as [the already existing task](https://github.com/phpro/grumphp/blob/master/doc/tasks/php_cs_fixer.md),
only specify the new `php_cs_auto_fixerv2` configuration key. For example:

```yaml
parameters:
Expand All @@ -49,13 +60,15 @@ parameters:
verbose: true
diff: false
triggered_by: ['php']
extensions:
- Wearejust\GrumPHPExtra\Extension\Loader
```

### Phpdoc
In this main package there is no phpdoc tasks [to generate phpDoc if necessary (and add it) before commit](https://github.com/phpro/grumphp/pull/253). This package adds this missing feature.
To use this task, just specify if inside grumphp.yml, in `tasks:`section. Do not forget to specify the loader in extension.

In [grumphp core](https://github.com/phpro/grumphp)
there is no phpdoc tasks [to generate phpDoc if necessary (and add it) before commit](https://github.com/phpro/grumphp/pull/253).
This package adds this missing feature.

To use this task, just specify if inside `grumphp.yml` in the `tasks:` section.

```yaml
parameters:
Expand Down Expand Up @@ -83,8 +96,6 @@ parameters:
ansi: ~
no_ansi: ~
no_interaction: ~
extensions:
- Wearejust\GrumPHPExtra\Extension\Loader
```

**config_file**
Expand Down

0 comments on commit c173f21

Please sign in to comment.