https://github.com/froiden/phpstandard

PHP Coding standard to be followed at Froiden
https://github.com/froiden/phpstandard

Last synced: 3 months ago
JSON representation

PHP Coding standard to be followed at Froiden

• Host: GitHub
• URL: https://github.com/froiden/phpstandard
• Owner: Froiden
• License: mit
• Created: 2016-06-30T04:04:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-06T07:45:43.000Z (8 months ago)
• Last Synced: 2024-10-07T05:08:46.923Z (4 months ago)
• Language: PHP
• Homepage:
• Size: 41 KB
• Stars: 5
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Coding Standard

This repository contains rulesets for **PHP CodeSniffer** and **PHP Mess Detector** along with some custom rules. These standards are followed internally at *Froiden* (www.froiden.com)

## Installation

Install this repository globally using composer:

	composer global require froiden/php_standard

Always use the latest version of the repository.

## Setup

The project will be installed in global composer folder on your PC. 

* **Mac**: `.composer/vendor` folder in your home directory

* **Windows**: `AppData/Roaming/Composer/vendor` folder in your user directory

* **Ubuntu**: `.config/composer/vendor` folder in your home directory

You follow the steps respective to your favourite IDE to configure PHP CodeSniffer and PHP MessDetector and point to the two rulesets in the installation folder.

* **ruleset.xml** - For CodeSniffer

* **rulesetmd.xml** - For MessDetector

## Attribution

Some sniffs in this repository have been derived from original PHP_CodeSniffer project. Credits for those go to the respective developers.

## VS Code SETUP

Install the extension name **PHP Sniffer** by **wongjn**

![N|Solid](https://public.froid.works/php-snif.png)

After Activation add the below file to settings.json file

For Mac

	"phpSniffer.standard": "~/.composer/vendor/froiden/php_standard/ruleset.xml",

For Linux

	"phpSniffer.standard": "~/.config/composer/vendor/froiden/php_standard/ruleset.xml",

For Windows

	"phpSniffer.standard": "%userprofile%/AppData/Roaming/Composer/vendor/froiden/php_standard/ruleset.xml",

  ![N|Solid](https://public.froid.works/vs-settings-1.png) 

To check 

	phpcs --standard=  

TO fix

	phpcbf --standard=  

Ignoring a file

	// @codingStandardsIgnoreFile

	// phpcs:ignoreFile

Ignoring a line

	// @codingStandardsIgnoreLine

	// phpcs:ignore

Ignoring a block

	// @codingStandardsIgnoreStart

	// phpcs:disable

	// @codingStandardsIgnoreEnd

	// phpcs:enable