wearejust/grumphp-extra-tasks

A set of extra tasks for grumphp

GrumPHP Extra tasks

This package is brought alive to extend the functionalities of the already existing GrumPHP., _(*1)

Installation

The easiest way to install this package is through composer:, _(*2)

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

Add the extension loader to your grumphp.yml, _(*3)

parameters:
    extensions:
        - Wearejust\GrumPHPExtra\Extension\Loader

Usage

PhpCsAutoFixer

In grumphp core it is not possible to use the php-cs-fixer to auto fix your files according to your config. This package adds this missing feature., _(*4)

The configuration of this custom task is the same as the already existing task, only specify the new php_cs_auto_fixer configuration key. For example:, _(*5)

parameters:
    tasks:
        php_cs_auto_fixer:
            config_file: .php_cs
            config: ~
            fixers: []
            level: ~
            verbose: true

PhpCsAutoFixerV2

In grumphp core it is not possible to use the php-cs-fixer to auto fix your files according to your config. This package adds this missing feature., _(*6)

The configuration of this custom task is the same as the already existing task, only specify the new php_cs_auto_fixerv2 configuration key. For example:, _(*7)

parameters:
    tasks:
        php_cs_auto_fixerv2:
            allow_risky: false
            cache_file: ~
            config: ~
            rules: []
            using_cache: true
            path_mode: ~
            verbose: true
            diff: false
            triggered_by: ['php']

Phpdoc

In grumphp core there is no phpdoc tasks to generate phpDoc if necessary (and add it) before commit. This package adds this missing feature., _(*8)

To use this task, just specify if inside grumphp.yml in the tasks: section., _(*9)

parameters:
    tasks:
        phpdoc:
            config_file: ~
            target_folder: ~
            cache_folder: ~
            filename: ~
            directory: ~
            encoding: ~
            extensions: ~
            ignore: ~
            ignore_tags: ~
            ignore_symlinks: ~
            markers: ~
            title: ~
            force: ~
            visibility: ~
            default_package_name: ~
            source_code: ~
            progress_bar: ~
            template: ~
            quiet: ~
            ansi: ~
            no_ansi: ~
            no_interaction: ~

config_file Default: null, _(*10)

Without config_file parameter phpdoc will search for a phpdoc.dist.xml config file. This file can be overload by phpdoc.xml. If no file found, no config file will be used., _(*11)

target_folder Default: null, _(*12)

Without this parameter the doc will be generated in an output/ folder., _(*13)

cache_folder Default: null, _(*14)

Without this parameter, cache will be placed in the target_folder., _(*15)

filename Default: null, _(*16)

Comma separated file list to documents., _(*17)

directory Default: null Comma separated directory list to documents., _(*18)

encoding Default: null, _(*19)

Without this parameter, encoding will be 'UTF-8'., _(*20)

extensions Default: null, _(*21)

Comma separated file extension list. Contains extension of file to parse. Without this parameter, parsed file are : * php * php3 * phtml, _(*22)

ignore Default: null, _(*23)

Comma separated list of paths to skip when parsing., _(*24)

ignore_tags Default: null, _(*25)

Comma separated list of tags to skip when parsing., _(*26)

ignore_symlinks Default: false Tells the parser not to follow symlinks., _(*27)

markers Default: null, _(*28)

Provide a comma-separated list of markers to parse (TODO ...)., _(*29)

title Default: null, _(*30)

Specify a title for the documentation., _(*31)

force Default: null, _(*32)

Ignore exceptions and continue parsing., _(*33)

visibility Default: null, _(*34)

Provide a comma-separated list of visibility scopes to parse. This parameter may be used to tell phpDocumentor to only parse public properties and methods, or public and protected., _(*35)

default_package_name Default: null, _(*36)

Default package name, _(*37)

source_code Default: null, _(*38)

When this parameter is provided the parser will add a compressed, base64-encoded version of the parsed file’s source as child element of the element. This information can then be picked up by the transformer to generate a syntax highlighted view of the file’s source code and even have direct links to specific lines., _(*39)

progress_bar Default: null, _(*40)

Display progress bar during the process., _(*41)

template Default: null, _(*42)

Specify a template to use. Without this parameter the template named "clean" will be used., _(*43)

quiet Default: null, _(*44)

With this option, only errors will be displayed., _(*45)

ansi Default: null, _(*46)

Force ANSI output., _(*47)

no_ansi Default: null, _(*48)

Disable ANSI output., _(*49)

no_interaction Default: null, _(*50)

License

This package is licensed under the MIT License., _(*51)