ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-phpmd

by SublimeLinter ST3

SublimeLinter plugin for php, using phpmd.

Details

Installs

  • Total 14K
  • Win 7K
  • OS X 4K
  • Linux 3K
Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29
Windows 4 4 9 6 8 10 16 12 12 12 7 7 11 8 9 9 17 2 4 5 9 13 11 8 5 9 8 11 10 8 11 2 7 11 11 4 11 6 11 6 12 8 8 6 6 5
OS X 4 1 3 1 0 6 3 5 6 2 2 2 3 4 10 1 3 0 1 7 3 3 6 2 2 1 9 4 4 2 6 1 8 2 1 2 6 5 2 2 2 7 2 6 7 2
Linux 2 2 5 1 1 4 5 4 2 4 0 2 2 2 1 2 1 2 1 4 4 4 4 4 0 1 5 2 1 1 4 1 0 3 3 2 3 3 3 2 1 2 6 1 1 0

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-phpmd

Build Status

This linter plugin for SublimeLinter provides an interface to phpmd. It will be used with files that have the “PHP”, “HTML” and “HTML5” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before installing this plugin, you must ensure that phpmd is installed on your system. To install phpmd, do the following:

  1. Install php.

  2. Install pear.

  3. Install phpmd by typing the following in a terminal:

pear channel-discover pear.phpmd.org
   pear channel-discover pear.pdepend.org
   pear install --alldeps phpmd/PHP_PMD

Alternative installation using composer:

  1. Install composer.
  2. Install phpmd using below command:
composer global require phpmd/phpmd
  1. Make sure composer global bin directory is available in $PATH
export PATH=~/.composer/vendor/bin:$PATH

Now you can proceed to install the SublimeLinter-phpmd plugin.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type phpmd. Among the entries you should see SublimeLinter-phpmd. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

Project Specific Executable

It is possible to specify the phpcs executable that should be used to lint your code on a per-project level.

Example:

{
    "SublimeLinter": {
        "linters": {
            "phpmd": {
                "cmd": "${project}/vendor/bin/phpmd"
            }
        }
    }
}

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!