deblan/php-censor
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #55 from bochkovprivate/master

Browse source 
Fix Technical Debt Plugin configuration parameters
This commit is contained in:
Dmitry Khomutov 2017-04-06 22:40:03 +07:00 committed by GitHub
parent 506af65421 acf25afdd6
commit 3140516430
2 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/en/plugins/technical_dept.md
View file

@ -7,5 +7,8 @@ Configuration
-------------
### Options
* **searches** - Optional - Case-insensitive array of terms to search for. Defaults to TODO, TO DO, FIXME and FIX ME.
* **allowed_errors** [int, optional] - The error limit for a successful build (default: 0). -1 disables errors. Setting allowed_errors in conjunction with zero_config will override zero_config.
* **suffixes** [array, optional] - An array of file extensions to check (default: 'php')
* **directory** [string, optional] - directory to inspect (default: build root)
* **ignore** [array, optional] - directory to ignore (default: inherits ignores specified in setup)
* **searches** [array, optional] - Optional - Case-insensitive array of terms to search for. Defaults to TODO, TO DO, FIXME and FIX ME.

15
src/PHPCensor/Plugin/TechnicalDebt.php
View file

@ -75,6 +75,21 @@ class TechnicalDebt extends Plugin implements ZeroConfigPluginInterface
if (isset($options['zero_config']) && $options['zero_config']) {
$this->allowed_errors = -1;
}
$this->setOptions($options);
}
/**
* Handle this plugin's options.
* @param $options
*/
protected function setOptions($options)
{
foreach (array('directory', 'path', 'ignore', 'allowed_errors') as $key) {
if (array_key_exists($key, $options)) {
$this->{$key} = $options[$key];
}
}
}
/**