Download the PHP package singular-it/php-codesniffer-base-config without Composer
On this page you can find all versions of the php package singular-it/php-codesniffer-base-config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download singular-it/php-codesniffer-base-config
More information about singular-it/php-codesniffer-base-config
Files in singular-it/php-codesniffer-base-config
Package php-codesniffer-base-config
Short Description Base configuration for PHP Codesniffer
License
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 php-codesniffer-base-config
PHP Codesniffer Base Config
Basic Information:
About the PHP Codesniffer Package:
PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
=> Documentation: https://github.com/squizlabs/PHP_CodeSniffer/wiki
About this Project:
This Project basically provides a set of predefined php coding standard rules that can be used and extended as described below.
Installation:
-
Make the following additions to the composer.json file
-
Add repository:
- Add the package:
-
- Run
composer installorcomposer updateto install the new dependency. -
Create a file in your projects root directory called
phpcs.xmlwith the following content:Alternatively, for php versions smaller than 8, the rule should look like this:
<rule ref="./vendor/singular-it/php-codesniffer-base-config/src/phpcs-before-php8.xml"/>
CLI Usage:
- You can now run phpcs via
vendor/bin/phpcs path/to/checkand are able to extend the phpcs.xml file to add project-specific rules. - As PHP Codesniffer also includes the "PHP Code Beautifier and Fixer", you can use
vendor/bin/phpcbf path/to/fixto automatically fix some smells.
PhpStorm Setup:
Find the official description here: https://www.jetbrains.com/help/phpstorm/using-php-code-sniffer.html . Basically:
- In the Settings under PHP > Quality Tools > PHP_Codesniffer click on the three dots after the "Configuration"-field, which opens a separate view. Here you will find the "PHP_CodeSniffer path" field and the "Path to phpcbf" field. The path to phpcs should be set to something like this
C:\...\vendor\bin\phpcs.batand the path to phpcbf to something like thisC:\...\vendor\bin\phpcbf.bat. - Go back to PHP > Quality Tools > PHP_Codesniffer and choose "custom" as coding standard, which causes an input field to appear. If the option "custom" is not available, try closing and re-opening the settings. In this input field enter the path to your own phpcs.xml file in your project's root directory.
- Go to PHP > Quality Tools > External Formatters and code PHP Code Beautifier and Fixer.
=> You should now be able to see IDE highlighting for code smells and hovering should give you the option to fix them, if they are automatically fixable.
