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 22K
  • Win 12K
  • Mac 6K
  • Linux 5K
Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1
Windows 0 0 1 3 3 1 0 1 2 3 0 0 0 0 0 1 0 0 0 0 0 3 2 2 0 0 4 0 1 1 2 1 2 0 1 1 0 0 0 0 0 0 2 2 0
Mac 0 0 0 0 1 0 0 0 0 0 1 1 1 0 0 1 1 0 1 0 0 0 1 0 1 0 0 2 0 0 2 2 0 1 0 1 1 0 1 0 0 0 0 1 0
Linux 0 1 1 0 1 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 1 2 0 0 0 0 1 0 1 0 0 0 0 0 0 1 0 0 0 0 2 1 0 0

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-phpmd

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

Install SublimeLinter and SublimeLinter-phpmd

Make sure Package Control is installed.

  1. Open the command palette (Ctrl + Shift + P)
  2. Type Package Control: Install Package and select it.
  3. Type SublimeLinter and select it.
  4. Repeat steps 1-3 typing SublimeLinter-phpmd in step 3.

Install phpmd

Choose one of the installation methods below.

A local install allows you to fine-tune phpmd on a per-project basis. A global install is available system-wide.

Local install with Composer

On a command line inside your project:

composer require phpmd/phpmd

Inside Sublime, go to Preferences -> Package Settings -> SublimeLinter -> Settings.

Set the phpmd executable by adding/editing:

"linters": {
    "phpmd": {
      "executable": "${folder}/vendor/bin/phpmd"
    }
  }

Global install with Composer

composer global require phpmd/phpmd

Make sure the composer global bin directory is available in $PATH:

export PATH=~/.composer/vendor/bin:$PATH

Global install with PEAR

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

Settings

Additional settings

If you want to use a baseline file, the linter needs to run on the actual files instead of the temporary files we need for real-time “background” linting. Therefore, set the “real_file_mode” setting to true.

"linters": {
  "phpmd": {
    "real_file_mode": true
  }
}

Rulesets

You can configure rules via the rulesets setting. This can be a list of rules, or a path to a custom ruleset file.

"linters": {
    "phpmd": {
      "rulesets": "codesize,unusedcode,naming"
    }
  }
"linters": {
    "phpmd": {
      "rulesets": "${folder}/phpmd.xml"
    }
  }