phpcs.sublime-settings

{
  // Plugin settings
  //
  // All string settings support Sublime Text variable expansion using
  // the ${var} syntax. The most useful variables are:
  //   $project_path - The path to the folder containing the .sublime-project file
  //   $folder       - The full path to the first folder in the side bar
  // See https://www.sublimetext.com/docs/build_systems.html#variables

  // Turn the debug output on/off
  "show_debug": false,

  // Which file types (file extensions), do you want the plugin to
  // execute for
  "extensions_to_execute": ["php"],

  // Do we need to blacklist any sub extensions from extensions_to_execute
  // An example would be ["twig.php"]
  "extensions_to_blacklist": [],

  // Execute the sniffer on file save
  "phpcs_execute_on_save": true,

  // Show the error list after save.
  "phpcs_show_errors_on_save": true,

  // Show the errors in the gutter
  "phpcs_show_gutter_marks": true,

  // Show outline for errors
  "phpcs_outline_for_errors": true,

  // Show the errors in the status bar
  "phpcs_show_errors_in_status": true,

  // Show the errors in the quick panel so you can then goto line
  "phpcs_show_quick_panel": true,

  // The path to the php executable.
  // Needed for windows, or anyone who doesn't/can't make phars
  // executable. Avoid setting this if at all possible
  //
  // You can use a dictionary to specify different paths per platform:
  // "phpcs_php_prefix_path": {
  //     "windows": "c:\\xampp\\php\\bin\\php",
  //     "linux": "/usr/bin/php",
  //     "osx": "/usr/local/bin/php"
  // }
  "phpcs_php_prefix_path": "",

  // Options include:
  // - Sniffer
  // - Fixer
  // - MessDetector
  // - CodeBeautifier
  //
  // This will prepend the application with the path to php
  // Needed for windows, or anyone who doesn't/can't make phars
  // executable. Avoid setting this if at all possible
  "phpcs_commands_to_php_prefix": [],

  // What color to stylise the icon
  // https://www.sublimetext.com/docs/3/api_reference.html#sublime.View
  // add_regions
  "phpcs_icon_scope_color": "comment",

  // PHP_CodeSniffer settings

  // Do you want to run the phpcs checker?
  "phpcs_sniffer_run": true,

  // Execute the sniffer on file save
  "phpcs_command_on_save": true,

  // It seems python/sublime cannot always find the phpcs application
  // If empty, then use PATH version of phpcs, else use the set value
  //
  // You can use a dictionary to specify different paths per platform:
  // "phpcs_executable_path": {
  //     "windows": "c:\\xampp\\php\\bin\\phpcs",
  //     "linux": "/usr/bin/phpcs",
  //     "osx": "/usr/local/bin/phpcs"
  // }
  "phpcs_executable_path": "",

  // Additional arguments you can specify into the application
  //
  // Example:
  // {
  //     "--standard": "PEAR",
  //     "-n"
  // }
  "phpcs_additional_args": {
    "--standard": "PSR2",
    "-n": ""
  },

  // PHP-CS-Fixer settings

  // Fix the issues on save
  "php_cs_fixer_on_save": false,

  // Show the quick panel
  "php_cs_fixer_show_quick_panel": false,

  // Path to where you have the php-cs-fixer installed
  //
  // You can use a dictionary to specify different paths per platform:
  // "php_cs_fixer_executable_path": {
  //     "windows": "c:\\xampp\\php\\bin\\php-cs-fixer",
  //     "linux": "/usr/local/bin/php-cs-fixer",
  //     "osx": "/usr/local/bin/php-cs-fixer"
  // }
  "php_cs_fixer_executable_path": "",

  // Additional arguments you can specify into the application
  //
  // Supports ${var} variable expansion, for example:
  // "php_cs_fixer_additional_args": {
  //     "--config": "${project_path}/.php-cs-fixer.php"
  // }
  "php_cs_fixer_additional_args": {},

  // phpcbf settings

  // Fix the issues on save
  "phpcbf_on_save": false,

  // Show the quick panel
  "phpcbf_show_quick_panel": false,

  // Path to where you have the phpcbf installed
  //
  // You can use a dictionary to specify different paths per platform:
  // "phpcbf_executable_path": {
  //     "windows": "c:\\xampp\\php\\bin\\phpcbf",
  //     "linux": "/usr/local/bin/phpcbf",
  //     "osx": "/usr/local/bin/phpcbf"
  // }
  "phpcbf_executable_path": "",

  // Additional arguments you can specify into the application
  //
  // Example:
  // {
  //     "--level": "all"
  // }
  "phpcbf_additional_args": {
    "--standard": "PSR2",
    "-n": ""
  },

  // PHP Linter settings

  // Are we going to run php -l over the file?
  "phpcs_linter_run": true,

  // Execute the linter on file save
  "phpcs_linter_command_on_save": true,

  // It seems python/sublime cannot always find the php application
  // If empty, then use PATH version of php, else use the set value
  //
  // You can use a dictionary to specify different paths per platform:
  // "phpcs_php_path": {
  //     "windows": "c:\\xampp\\php\\bin\\php",
  //     "linux": "/usr/bin/php",
  //     "osx": "/usr/local/bin/php"
  // }
  "phpcs_php_path": "",

  // What is the regex for the linter? Has to provide a named match for 'message' and 'line'
  "phpcs_linter_regex": "(?P<message>.*) on line (?P<line>\\d+)",

  // PHP Mess Detector settings

  // Execute phpmd
  "phpmd_run": false,

  // Execute the phpmd on file save
  "phpmd_command_on_save": true,

  // It seems python/sublime cannot always find the phpmd application
  // If empty, then use PATH version of phpmd, else use the set value
  //
  // You can use a dictionary to specify different paths per platform:
  // "phpmd_executable_path": {
  //     "windows": "c:\\xampp\\php\\bin\\phpmd",
  //     "linux": "/usr/local/bin/phpmd",
  //     "osx": "/usr/local/bin/phpmd"
  // }
  "phpmd_executable_path": "",

  // Additional arguments you can specify into the application
  //
  // Example:
  // {
  //     "codesize,unusedcode"
  // }
  "phpmd_additional_args": {
    "codesize,unusedcode,naming": ""
  }
}