phpguard

File watcher and test runner for PHP.

npm install phpguard
6 downloads in the last week
12 downloads in the last month

phpGuard

A simple tool that executes tests for php files, which has changed. Searching files is based on @covers tag.

Instalation

npm install [-g] phpguard

Dependencies

watchr
commander

Usage

Usage: phpguard [options]

Options:

  -h, --help          output usage information
  -V, --version       output the version number
  -i, --init          creates local configuration
  -t, --test [value]  type of phpunit test (defined in configuration)

Configuration

phpguard.config.json

{
  "baseNamespacePath": "src",
  "testTypes": {
    "fast": "phpunit --colors"
  },
  "defaultType": "fast",
  "delayBetweenTests": 500
}

Legend:

  • baseNamespacePath - Path where php files are stored, it should be defined to root of defined namespaces.
  • testTypes - Array with command that will be executed after running phpguard with --test (-t) flag, feel free to add your own commands (at the end of command are added paths to tests, that should be run).
  • defaultType - Default test type, that should be executed, when you are running phpguard without --test (-t) flag.
  • delayBetweenTests - Deley between running tests if files are changing frequently. It's bugfix for issue when you are working on remote server (sometimes files saves twice, etc.), feel free to set it to 0 value.

License

(The MIT License)

Copyright (c) 2013 Szymon FrÄ…szczak <fraszczak.szymon@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you