Download the PHP package gskema/phpcs-type-sniff without Composer
On this page you can find all versions of the php package gskema/phpcs-type-sniff. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gskema/phpcs-type-sniff
More information about gskema/phpcs-type-sniff
Files in gskema/phpcs-type-sniff
Package phpcs-type-sniff
Short Description PHPCS sniff to enforce PHP7 types and array types
License MIT
Homepage https://github.com/gskema/phpcs-type-sniff
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 phpcs-type-sniff
PHPCS Type Sniff
Custom phpcs CodeSniffer rule that:
- Enforces usage of PHP8, PHP7 type declarations (where possible)
- Enforces documenting array types with more specific types (e.g.
int[]) - Checks for useless PHPDoc blocks (no repeated information)
- Many more other checks
Example PHP class (comments on the right = phpcs warnings):
Install
Via Composer
Usage
This is a standalone sniff file, you need to add it to your phpcs.xml file.
Usage Without Reflection
Inspections for methods with @inheritdoc tag are skipped.
If a method does not have this tag, it is inspected. This is the recommended setup.
Usage With Reflection
With reflection enabled, this sniff can assert if @inheritoc tag
is needed. Inspections for extended/implemented methods are skipped.
Reflections need to load actual classes, which is why we need to include
the autoloader. This option is good for inspecting extended methods, however using ReflectionClass may
cause phpcs crashes while editing (not possible to catch FatalError).
PHPCS Baseline
It may be hard to integrate new rules/standards into old projects because too many warnings may be detected. If you would like to fix them later, but use the standard for all new code, you can "save" warnings detected on current code, then ignore them on subsequent builds. The code standard remains the same, but on subsequent builds you "subtract" the old (baseline) warnings:
Note: By default all baseline warnings are tracked by filename + line + column + message hash.
By default, all warnings detected by this sniff (CompositeCodeElementSniff) will have a violation ID,
which is used to track and compare baseline warnings independently of line and column.
This allows you to change other things in the same file where these warnings are detected, the violation ID does
not change because of line numbers / code style.
Configuration
Sniffs are registered and saved by their short class name.
This allows easily specifying configuration options for a specific code element sniff,
e.g. FqcnMethodSniff.invalidTags. All custom code sniff classes must have unique
short class names.
String true/false values are automatically converted to booleans.
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
License
The MIT License (MIT). Please see License File for more information.
