Git Product home page Git Product logo

code-standards's Introduction

uMotif Code Standards & Tooling config

Installing tools globally

Install Tools

First, clone the standards repository in your home directory.

cd
git clone [email protected]:umotif-public/code-standards.git standards
composer global require squizlabs/php_codesniffer
composer global require phpmd/phpmd

Ensure the composer bin directory in in your PATH in your ~/.bash_profile (or ~/.bashrc) like this:

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

Set up PHPStorm

  • Open PHPStorm, but close all of your project windows, so all you have is the Welcome window.
  • Configure -> Import Settings
  • Then select ~/standards/PHPStorm/settings.zip
  • Open Preferences (Cmd+,) and go to Languages & Frameworks -> PHP -> Quality Tools
  • Ensure PHPCS and PHPMD are set up correctly
  • Go to Editor -> Inspections, then inside the Inspections window, go to PHP -> Quality Tools
  • Under PHP Mess Detector Validation, ensure the Custom ruleset points to your standards/phpmd/phpmd.xml
  • Under PHP CodeSniffer Validation, ensure the Custom ruleset points to your standards/codesniffer/phpcs.xml

code-standards's People

Contributors

umotif-shorner avatar ghaddow avatar umotif-edemirtas avatar umotif-scotton 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.