diff --git a/docs/options.md b/docs/options.md index e109d97..fc61e74 100644 --- a/docs/options.md +++ b/docs/options.md @@ -526,7 +526,7 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify) **Description**: Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy) -### PHP - Cs fixer path +### PHP - PHP-CS-Fixer Path **Key**: `php_cs_fixer_path` diff --git a/src/beautifiers/php-cs-fixer.coffee b/src/beautifiers/php-cs-fixer.coffee index 632bb42..06c55ad 100644 --- a/src/beautifiers/php-cs-fixer.coffee +++ b/src/beautifiers/php-cs-fixer.coffee @@ -24,7 +24,14 @@ module.exports = class PHPCSFixer extends Beautifier "--level=#{options.level}" if options.level "--fixers=#{options.fixers}" if options.fixers tempFile = @tempFile("temp", text) - ], {ignoreReturnCode: true}) + ], { + ignoreReturnCode: true + help: { + link: "https://github.com/FriendsOfPHP/PHP-CS-Fixer" + program: "php-cs-fixer.phar" + pathOption: "PHP - CS Fixer Path" + } + }) .then(=> @readFile(tempFile) ) @@ -34,7 +41,14 @@ module.exports = class PHPCSFixer extends Beautifier "--level=#{options.level}" if options.level "--fixers=#{options.fixers}" if options.fixers tempFile = @tempFile("temp", text) - ], {ignoreReturnCode: true}) + ], { + ignoreReturnCode: true + help: { + link: "https://github.com/FriendsOfPHP/PHP-CS-Fixer" + program: "php-cs-fixer.phar" + pathOption: "PHP - CS Fixer Path" + } + }) .then(=> @readFile(tempFile) ) diff --git a/src/languages/php.coffee b/src/languages/php.coffee index f63684e..1b44403 100644 --- a/src/languages/php.coffee +++ b/src/languages/php.coffee @@ -19,6 +19,7 @@ module.exports = { options: cs_fixer_path: + title: "PHP-CS-Fixer Path" type: 'string' default: "" description: "Path to the `php-cs-fixer` CLI executable"