@lassehaslev/executor

Run a command every time a file change. Its that simple.

Install

# Install project globaly
npm install -g @lassehaslev/executor

# Install executor per project
npm install @lassehaslev/executor --save-dev

Usage

Command line

# Doc
executor "<command>"
    [--run-on-first=true]
    [--watch="**/*"]
    [--ignore=""]

    -- [{Custom arguments added to the <command>}]

# Example
executor './vendor/bin/phpunit --color=always' --watch='**/*.php' --ignore='/node_modules|\.git|vendor/'

# Custom arguments
executor './vendor/bin/phpunit --color=always' --watch='**/*.php' -- --filter="CustomTest"

Npm

package.json

{
    "scripts": {
        "my-script": "executor '<command>' [options]",
    }
}

Now you can run the command npm run my-script from command line.

If you run per project and not in a npm script the command is ./node_modules/.bin/executor.

Pro tip: use npm run my-script -- --your --command-option="yey" to add options to your command.

Laravel TDD

I use this project to run Test Driven Development for my Laravel applications.

Check out this Laracasts thread for more information.

Add tdd script to projects package.json

{
  "scripts": {
    "tdd": "executor './vendor/bin/phpunit --color=always' --watch='**/*.php' --ignore='node_modules/' --ignore='vendor/'"
  }
}

Then run npm run tdd from your projects folder.

Pro tip: use npm run tdd -- --filter="awesome_test" to filter your phpunit tests.

Contributing

Follow these steps to contribute to project.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

Development

# link to local command line
npm link

# compile to es6
npm run dev

# When you are finished unlink local command
npm unlink