Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.33 KB

npm_script.md

File metadata and controls

55 lines (36 loc) · 1.33 KB
Raw

NPM script

The NPM script task will run your configured npm script. It lives under the npm_script namespace and has following configurable parameters:

# grumphp.yml
grumphp:
    tasks:
        npm_script:
            script: ~
            triggered_by: [js, jsx, coffee, ts, less, sass, scss]
            working_directory: "./"
            is_run_task: false
            silent: false

script

Default: null

This option specifies which NPM 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: [js, jsx, coffee, ts, less, sass, scss]

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

working_directory

Default: "./"

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

is_run_task

Default: false

This option will append 'run' to the npm command to make it possible to run custom npm scripts.

silent

Default: false

This option will append '--silent' to the npm script to supress npm ERR! messages from showing.