https://github.com/jandc/grumphp-yarn-task

Simple grumphp task akin to the 'npm_script' task, but runs yarn instead
https://github.com/jandc/grumphp-yarn-task

Last synced: 19 days ago
JSON representation

Simple grumphp task akin to the 'npm_script' task, but runs yarn instead

• Host: GitHub
• URL: https://github.com/jandc/grumphp-yarn-task
• Owner: JanDC
• License: bsd-3-clause
• Created: 2019-05-02T09:17:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-19T08:55:36.000Z (over 3 years ago)
• Last Synced: 2024-11-09T03:10:38.431Z (2 months ago)
• Language: PHP
• Homepage:
• Size: 11.7 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grumphp-yarn-task

Simple grumphp task akin to the 'npm_script' task, but runs yarn instead

## Usage

### Dependencies

yarn (obviously), has to be installed and available in $PATH. 
 Refer to https://yarnpkg.com/en/docs/install for the installation procedures.

### Installation

To install the yarn task simply run 


`composer require jandc/grumphp-yarn-task` 


or 


`composer global require jandc/grumphp-yarn-task`

depending on your grumphp location

You can register the task by adding it's extension:

```yaml

# grumphp.yml

parameters:

    extensions:

        - YarnTask\Extension\Loader

```

### Configuration

Usage is almost identical to npm_script: 


(https://github.com/phpro/grumphp/blob/v0.15.0/doc/tasks/npm_script.md)

```yaml

# grumphp.yml

parameters:

    tasks:

        yarn:

            script: lint

            options:

                - '--no-fix'

                - '--max-warnings=0'

            triggered_by: [js, jsx, coffee, ts, less, sass, scss]

            working_directory: ./

            is_run_task: false

```

Note the extra 'options' array which can be used to append extra parameters to your scripts