fabiang/cludearg

Normalizer library for command line arguments for in- or exclude paths and files

dev-master / 1.0.x-dev 2014-07-04 13:33 UTC

Requires

• php: >=5.3
• seld/jsonlint: ~1.1

Requires (Dev)

• justinrainbow/json-schema: ~1.3
• lstrojny/phpunit-clever-and-smart: 0.*
• mikey179/vfsstream: ~1.2
• phpunit/phpunit: ~4.1

BSD-2-Clause

• Fabian Grutschus

README

Normalizer library for command line arguments for in- or exclude paths and files

When running code checks against your code (manually or automatically via continues integration) you'll have to define paths/files that should (includes) and paths/files that shouldn't (excludes) be checked by the various applications.

The problem is that all those tools define the command-line arguments in a different way. This library instead accepts only a standardized format and can return the application-format for a given application name and version.

SUPPORTED APPLICATIONS

• php/lint (php -l)
• squizlabs/php_codesniffer
• phpmd/phpmd
• phpdocumentor/phpdocumentor
• pdepend/pdepend
• sebastian/phpcpd

INSTALLATION

New to Composer? Read the introduction. Add the following to your composer file:

{
    "require": {
        "fabiang/cludearg": "1.0.x-dev as 1.0.0"
    }
}

USAGE

You'll only need one method:

Fabiang\Cludearg\Cludearg::getArgument(
    string $application,
    string $version,
    array $include,
    array $exclude,
    string $path
)

Example:

use Fabiang\Cludearg\Cludearg;

$cludearg = new Cludearg();

$arguments = $cludearg->getArgument(
    'squizlabs/php_codesniffer',
    '1.0.1',
    array('bin/foo.php', 'src'), // files and folders to be included
    array('vendor', 'tests'), // files and folders to be excluded
    '/myproject' // path where the project can be found
);

All paths for in- and exclude must be relative to the given path. The constructor of Cludearg can optionally take an Definition object, which allows you to add your own definition of arguments.

SYSTEM REQUIREMENTS

• PHP >=5.3
• seld/jsonlint >= 1.1

LICENSE

BSD-2-Clause. See the LICENSE.

CONTRIBUTING

Contributing is easy, just make sure the tests are running:

./vendor/bin/phpunit -c tests

If you change the default definition file check if the json schema validates:

./vendor/bin/validate-json definition.json schema/cludearg.json

Also Jsonlint may help you to find errors in the definition file:

./vendor/bin/jsonlint definition.json