Skip to content

jiahm/phplint

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PHPLint

StyleCI Build Status Latest Stable Version Total Downloads Latest Unstable Version License Scrutinizer Code Quality

phplint is a tool that can speed up linting of php files by running several lint processes at once.

Installation

$ composer require overtrue/phplint -vvv

Usage

CLI

Usage:
  phplint [options] [--] [<path>]

Arguments:
  path                               Path to file or directory to lint

Options:
      --exclude=EXCLUDE              Path to file or directory to exclude from linting (multiple values allowed)
      --extensions=EXTENSIONS        Check only files with selected extensions (default: php)
  -j, --jobs=JOBS                    Number of parraled jobs to run (default: 5)
  -c, --configuration=CONFIGURATION  Read configuration from config file (default: .phplint.yml).
      --no-configuration             Ignore default configuration file (default: .phplint.yml).
      --no-cache                     Ignore cached data.
  -h, --help                         Display this help message
  -q, --quiet                        Do not output any message
  -V, --version                      Display this application version

example:

$ ./vendor/bin/phplint ./ --exclude=vendor

You can also define configuration as a file .phplint.yml:

path: ./
jobs: 10
extensions:
  - php
exclude:
  - vendor
$ ./vendor/bin/phplint

By default, the command will read configuration from file .phplint.yml of path specified, you can custom the filename by option: --configuration=FILENAME or -c=FILENAME;

if you want do disabled any config file, you can add option --no-configuration.

Program

use Overtrue\PHPLint\Linter;

$path = __DIR__ .'/app';
$exclude = ['vendor'];
$extensions = ['php'];

$linter = new Linter($path, $exclude, $extensions);

// get errors
$errors = $linter->lint();

//
// [
//    '/path/to/foo.php' => [
//          'error' => "unexpected '$key' (T_VARIABLE)",
//          'line' => 168,
//          'file' => '/path/to/foo.php',
//      ],
//    '/path/to/bar.php' => [
//          'error' => "unexpected 'class' (T_CLASS), expecting ',' or ';'",
//          'line' => 28,
//          'file' => '/path/to/bar.php',
//      ],
// ]

License

MIT

About

🐛 PHP syntax lint tool.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%