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

  • 1.3.0
    1.2.3
  • github.​com
  • github.​com
  • 2 years ago
  • 5 days ago
  • 11 years ago

Installs

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