Giter VIP home page Giter VIP logo

codeclimate-phpmd's Introduction

Code Climate PHP Mess Detector (PHPMD) Engine

Code Climate

codeclimate-phpmd is a Code Climate Engine that wraps the PHP Mess Detector (PHPMD) static analysis tool.

Installation

  1. If you haven't already, install the Code Climate CLI.
  2. Run codeclimate engines:enable phpmd. This command both installs the engine and enables it in your .codeclimate.yml file.
  3. You're ready to analyze! Browse into your project's folder and run codeclimate analyze.

Config Options

Format the values for these config options per the PHPMD documentation.

  • file_extensions - This is where you can configure the file extensions for the files that you want PHPMD to analyze.
  • rulesets - This is the list of rulesets that you want PHPMD to use while analyzing your files.

Sample Config

exclude_paths:
 - "/examples/**/*"
engines:
  phpmd:
    enabled: true
    config:
      file_extensions: "php"
      rulesets: "unusedcode,codesize,naming,optional_relative_path_to_custom_ruleset.xml"
ratings:
  paths:
  - "**.php"

Need help?

For help with PHPMD, check out their documentation.

If you're running into a Code Climate issue, first look over this project's GitHub Issues, as your question may have already been covered. If not, go ahead and open a support ticket with us.

codeclimate-phpmd's People

Contributors

gdiggs avatar brynary avatar pbrisbin avatar wfleming avatar ablyler avatar dblandin avatar landrok avatar blakewilliams avatar jpignata avatar maxjacobson avatar noahd1 avatar pointlessone avatar dbudwin avatar josephdpurcell avatar mik-laj avatar mxie avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.