Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.31 KB

php_loc.md

File metadata and controls

38 lines (28 loc) · 1.31 KB
Raw

Plugin PHPLoc

Runs PHPLoc against your project and records some key metrics.

Configuration

Options

See additional options below.

Example

Run PHPLoc against the app directory only. This will prevent inclusion of code from 3rd party libraries that are included outside of the app directory.

test:
    php_loc_step:
        plugin: php_loc
        directory: "app"

Additional Options

The following general options can also be used:

  • allow_failures [bool, optional] - If true, allow the build to succeed even if this plugin fails.
  • directory [string, optional] - This option lets you specify the tests directory to run.
  • ignore [optional] - A list of files / paths to ignore (default: build_settings > ignore).
  • binary_name [string|array, optional] - Allows you to provide a name of the binary.
  • binary_path [string, optional] - Allows you to provide a path to the binary vendor/bin, or a system-provided.
  • priority_path [string, optional] - Priority path for locating the plugin binary (Allowable values: local (Local current build path) | global (Global PHP Censor 'vendor/bin' path) | system (OS System binaries path, /bin:/usr/bin etc.). Default order: local -> global -> system)