Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.01 KB

composer_script.md

File metadata and controls

41 lines (28 loc) · 1.01 KB
Raw

Composer script

The Composer script task will run your configured Composer script. It lives under the composer_script namespace and has following configurable parameters:

# grumphp.yml
grumphp:
    tasks:
        composer_script:
            script: ~
            triggered_by: [php, phtml]
            working_directory: ~

script

Default: null

This option specifies which Composer script you want to run. This option is set to null by default. This means that grumphp will stop immediately. Note that this script should be used to verify things. It is also possible to alter code during commit, but this is surely NOT recommended!

triggered_by

Default: [php, phtml]

This option will specify which file extensions will trigger the Composer script. By default Composer script will be triggered by altering any file. You can overwrite this option to whatever file you want to use!

working_directory

Default: null

This option specifies in which directory the Composer script should be run.