Download the PHP package danbettles/codesniffer-standard without Composer
On this page you can find all versions of the php package danbettles/codesniffer-standard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download danbettles/codesniffer-standard
More information about danbettles/codesniffer-standard
Files in danbettles/codesniffer-standard
Package codesniffer-standard
Short Description A PHP_CodeSniffer standard that mainly looks for abandoned debugging code.
License ISC
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package codesniffer-standard
PHP_CodeSniffer Standard
:bangbang: This version of my PHP_CodeSniffer standard is for PHP_CodeSniffer 3 and PHP 7.3+. If you're running older code then consider using version 1.0.0.
:bangbang: See the section entitled "The Unit Tests" for info on how to unit-test a custom PHPCS standard without having to 'install' it.
The Sniffs
Errors
- PHP debugging functions (
print_randvar_dump) are forbidden because I never use them for anything other than debugging.
Warnings
-
PHP output functions (
printandecho) are considered suspect because I rarely - if ever - use them for anything other than debugging in object-oriented code, and since I tend to use short-echo tags (<?= ?>) in output templates, I don't expect to see them elsewhere either. -
PHP script termination functions (
exitanddie) are considered suspect because they needn't be used in well-structured code; I use them only when debugging. I consider it bad-form to use these functions in a framework because they will likely prevent an application shutting-down cleanly, which, for one thing, can make it difficult to find out why output filters - or the like - are not being applied. -
JavaScript's
alertfunction (window.alert()) is considered suspect because it's probably used more for debugging than anything else. -
Comments appearing to contain debugging code will be the subject of warnings. Debugging code should never be committed, even if it's commented. At the very least, commented debugging code is garbage, unwanted noise, and there's no sense in making your code more difficult to follow by leaving it lying around.
- One way or another,
TODOandFIXMEtags signal potential problems on the road ahead.
Installation Instructions
-
Download and unzip, or Git clone, the project into
DanBettles. - Use it: pass
--standard=DanBettlesif you put the code in the PHPCS standards directory; or--standard=/path/to/DanBettlesif it lives elsewhere.
The Unit Tests
I had some difficulty upgrading the unit-tests for PHP_CodeSniffer 3 and I still didn't like that you have to 'install' your custom standard as part of the usual PHPCS approach. After some investigation, I tried Payton Swick's solution, https://payton.codes/2017/12/15/creating-sniffs-for-a-phpcs-standard/#writing-tests, which worked out well. Thank you, Payton.
Payton Swick's solution enables you to test your custom standard in isolation, within the project. I developed his idea a little further, creating a sensibly opinionated test-case base class that makes it straightforward to test your sniffs: straightforward if you follow usual PHPUnit conventions; and straightforward because it involves using PHPUnit in a more natural way.
