Download the PHP package phpcsstandards/phpcsdevcs without Composer
On this page you can find all versions of the php package phpcsstandards/phpcsdevcs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download phpcsstandards/phpcsdevcs
More information about phpcsstandards/phpcsdevcs
Files in phpcsstandards/phpcsdevcs
Package phpcsdevcs
Short Description Sane ruleset for the code in external standards for PHP_CodeSniffer.
License LGPL-3.0-or-later
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 phpcsdevcs
PHPCSDevCS for developers of PHP_CodeSniffer sniffs
:construction:
This is an external ruleset for PHP CodeSniffer intended for use by sniff developers.
- Installation
- Composer Project-based Installation
- Composer Global Installation
- PHPCSDev ruleset for sniff repos
- Using the ruleset from the command line
- Using the ruleset from within a project based ruleset
- Contributing
- License
Installation
Composer Project-based Installation
Run the following from the root of your project:
Composer Global Installation
If you work on several different sniff repos, you may want to install this toolset globally:
Composer will automatically install dependencies and register the PHPCSDev and other external standards with PHP_CodeSniffer using the Composer PHPCS plugin.
PHPCSDev ruleset for sniff repos
Once this project is installed, you will see a new PHPCSDev ruleset in the list of installed standards when you run phpcs -i.
Important: This ruleset currently requires PHP_CodeSniffer >= 3.6.2+.
As sniffs developers will mostly work with the latest version of PHP_CodeSniffer, this shouldn't cause any problems.
Similarly, the CS check in automated CI runs should normally be run on a high PHPCS version for the best results.
The PHPCSDev standard can be used by sniff developers to check the code style of their sniff repo code.
Often, sniff repos will use the code style of the standard they are adding. However, not all sniff repos are actually about code style.
So for those repos which need a basic standard which will still keep their code-base consistent, this standard should be useful.
The standard checks your code against the following:
- Compliance with PSR-12, with a few exceptions.
- Use of camelCase variable and function names.
- Use of normalized arrays.
- All files, classes, functions and properties are documented with a docblock and contain the minimally needed information.
- A number of arbitrary additional code style and QA checks.
- PHP cross-version compatibility, while allowing for the tokens back-filled by PHPCS itself.
Note: for optimal results, the project custom ruleset should set the
testVersionconfig variable. This is not done by default as config variables are currently difficult to overrule.
The ruleset can be used like any other ruleset and specific sniffs and settings can be added to or overruled from a custom project based ruleset.
Using the ruleset from the command line
Using the ruleset from within a project based ruleset
Add the following line to your project's phpcs.xml.dist file:
Contributing
Contributions to this project are welcome. Just clone the repo, branch off from main, make your changes, commit them and send in a pull request.
If unsure whether the changes you are proposing would be welcome, open an issue first to discuss your proposal.
License
This code is released under the GNU Lesser General Public License (LGPLv3). For more information, visit http://www.gnu.org/copyleft/lesser.html
All versions of phpcsdevcs with dependencies
squizlabs/php_codesniffer Version ^3.6.2
phpcompatibility/php-compatibility Version ^9.0.0 || ^10.0.0
dealerdirect/phpcodesniffer-composer-installer Version ^0.4.1 || ^0.5 || ^0.6.2 || ^0.7 || ^1.0