php-censor/docs/en/plugins/technical_dept.md

15 lines
755 B
Markdown
Raw Normal View History

2016-07-19 11:12:28 +02:00
Plugin Technical Dept
2017-01-04 13:22:20 +01:00
=====================
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
Checks all files in your project for TODOs and other technical debt.
2016-07-19 11:12:28 +02:00
Configuration
2017-01-04 13:22:20 +01:00
-------------
2016-07-19 11:12:28 +02:00
### Options
* **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.