Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcrowe/cakephp-codesniffer-plugin
CakePHP CodeSniffer plugin - for finding and auto-correcting coding standard issues.
https://github.com/bcrowe/cakephp-codesniffer-plugin
Last synced: 25 days ago
JSON representation
CakePHP CodeSniffer plugin - for finding and auto-correcting coding standard issues.
- Host: GitHub
- URL: https://github.com/bcrowe/cakephp-codesniffer-plugin
- Owner: bcrowe
- Created: 2013-10-13T18:14:52.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2013-10-16T00:52:08.000Z (about 11 years ago)
- Last Synced: 2024-10-29T18:31:44.984Z (2 months ago)
- Language: PHP
- Homepage:
- Size: 1.08 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CakePHP CodeSniffer Plugin
Author: Mark Scherer
License: MIT
The plugin provides a quick way to run your (default) sniffer rules on your app - or part (Plugin for example) of it.
It comes with good default settings for Cake apps and works out of the box as self-contained system.
By default it
- ignores webroot and Vendor folders (in app or plugin)
- creates a log file in TMP for larger error reports where the console screen can't hold that much information)
- NEW: Can now also auto-correct most standard CS issues using the phpcs-fixer branch.
It is also quite helpful when creating new sniffer rules (using tokenizer command).
## Requirements
CakePHP 2.x
This is a self-contained plugin shipped with everything including phpcs and sniffs.
Drag and drop it. Run it. Enjoy.
## How to use
1. Download the plugin and place it at `APP/Plugin/CodeSniffer` (or ROOT/plugins/ folder).
```bash
cd APP/Plugin
git clone git://github.com/dereuromark/cakephp-codesniffer.git CodeSniffer
```
2. Load the plugin by adding this line to the bottom of your app's `Config/bootstrap.php`:
```php
CakePlugin::load('CodeSniffer'); // or just CakePlugin::loadAll();
```
3. That's all! CodeSniffer is ready for use.
```bash
cake CodeSniffer.CodeSniffer run [path]
```
If you do not provide a path, it will automatically run the sniffer for your APP path.
You can also quickly sniff one of your plugins:
cake CodeSniffer.CodeSniffer run -p Tools
And by providing a path, as well, it will use it as sub path of your plugin:
cake CodeSniffer.CodeSniffer run Model -p Tools
Note that it will also create a full debug log file in your TMP folder. This is useful if there are a lot
of errors and warnings.
If you want to display a list of available standards, use the "standards" command:
cake CodeSniffer.Codesniffer standards
You can also check only a specific sniff:
cake CodeSniffer.CodeSniffer run /folder/to/check --standard=MyCakePHP
--sniffs=MyCakePHP.ControlStructures.ReturnEarly
NEW: Upgrading the vendor phpcs package to "phpcs-fixer" branch, you can now leverage auto-correction
for some found errors using `--fix` or `-f`:
cake CodeSniffer.Codesniffer run -f
It will also display a diff on old made changes afterwards.
Using the APP itself, a relative path inside the APP or `-p PluginName` it will by default skip any "Vendor"
and "webroot" folders found. Using an absolute custom path it will not skip anything:
cake CodeSniffer.Codesniffer run /folder/to/check -f
### Settings/Options
By default it uses the CakePHP rules.
You can overwrite the default at runtime or globally using your APP configs:
// Use our own standards "MyCakePHP" as default
Configure::write('CodeSniffer.standard', 'MyCakePHP');
// A "Custom" standard that is somewhere else on your file system
Configure::write('CodeSniffer.standard', '/absolute/path/to/Custom');
### Tokenizer
You can use the tokenizer command to debug your PHP files. This can be very useful when writing
your own rules. You can output just the token name list, but it is usually better to use the verbose
output:
cake CodeSniffer.Codesniffer tokenize /path/to/file.ext -v
This will create a file `/path/to/file.ext.token` with all token names added in comment lines.
### MyCakePHP improvements (optional)
* Detect Yoda conditions.
* Added IsNull sniff
* Added Type casting sniff
* Added @return doc block sniff
* Added Ternary (incl. short ternary) sniff
* ReturnEarly sniff to detect if a return statement is followed by an ELSE block.
* Doc blocks / comments on correct indentation level (as their subsequent code).
* Line endings on Windows are allowed to be \r\n (default for GIT on Windows for example).
* Make Squiz sniff not falsely report whitespace issues in Windows.
For details see the ruleset.xml in the `Standards` dir.
Most of those added sniffs also have auto-correction included. Use it :)
Note: The "correct" indentation is APP and plugin specific for me. This is the only exception from the official CakePHP
standards and applies to all my (non core) code.
You are free to stick to the official version using the "CakePHP" standard!
### MyCakePHPCore improvements (optional)
* Line endings on Windows are allowed to be \r\n (default for GIT on Windows for example)
* Detect Yoda conditions.
## TODOS
Installing via composer or some more generic approach? This would avoid the hardwiring of PHPCS and the standards
in this plugin.
Also: The main goal is to push forward automated code correction using the CodeFixer.
Using the same rules to "find" violations we should also be able to "fix" them right away in almost all cases.
Last but not least there is also some more work to be done on the SmellDetector and other tools.