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

Sublime​Linter-phpmd

by SublimeLinter ST3

SublimeLinter plugin for php, using phpmd.

Labels linting, SublimeLinter, phpmd, php

Details

Installs

  • Total 22K
  • Win 12K
  • Mac 6K
  • Linux 5K
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 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16
Windows 0 0 1 0 0 0 1 0 2 0 0 0 0 0 0 0 0 1 1 0 0 2 1 1 4 0 0 1 0 0 0 1 2 0 1 0 2 0 1 0 2 0 0 0 2 1
Mac 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 3 1 0 0 0 0 0 0 1 1 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0
Linux 0 0 2 1 0 0 0 0 0 1 0 0 1 0 0 0 0 2 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 1 2 0 0 0 0 0 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"
    }
  }