Download the PHP package uocs/uncanny-owl-coding-standards without Composer
On this page you can find all versions of the php package uocs/uncanny-owl-coding-standards. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package uncanny-owl-coding-standards
Uncanny Owl Coding Standards (UOCS)
PHP_CodeSniffer rules and sniffs to enforce Uncanny Owl coding conventions.
Requirements
- PHP 7.4 or higher
- Composer
Installation
Global Installation (Recommended)
Project Installation
Usage
After installation, you can use the standards in several ways:
Using Composer Scripts (Recommended)
Using PHPCS Directly
Standards
The UOCS includes and extends the following standards:
- WordPress Coding Standards
- PHP Compatibility
- PHPCSExtra
- Custom Uncanny Owl rules
Available Standards
Uncanny-Owl
: Default standard with common rulesUncanny-Owl-Strict
: Stricter version with additional checks
Custom Ruleset
You can override the default ruleset for your project in two ways:
-
Project-specific ruleset (Recommended): Create a
phpcs.xml
orphpcs.xml.dist
in your project root: - Command-line Override:
IDE Integration
Visual Studio Code
- Install the PHP Sniffer & Beautifier extension
- Configure settings.json:
PhpStorm
- Go to Settings → PHP → Quality Tools → PHP_CodeSniffer
- Set PHP_CodeSniffer path to your vendor/bin/phpcs
- Go to Settings → Editor → Inspections
- Enable PHP → Quality Tools → PHP_CodeSniffer validation
- Set 'Coding Standard' to Uncanny-Owl
CI/CD Integration
Buddy
GitHub Actions
Troubleshooting
Common Issues
-
Standards Not Found
- Ensure Composer installation was successful
- Try running
composer install
again - Check if the standard is listed in
vendor/bin/phpcs -i
- Path Issues
- Use relative paths from your project root
- Ensure the path exists and is readable
Debug Mode
For detailed output, add -v
to the composer command:
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Support
For support, please open an issue in the GitHub repository or contact the Uncanny Owl development team.
IDE Integration
Visual Studio Code
- Install the PHP Sniffer & Beautifier extension
- Configure settings.json:
PhpStorm
- Go to Settings → PHP → Quality Tools → PHP_CodeSniffer
- Set PHP_CodeSniffer path to the
uocs
binary - In Editor → Inspections → PHP → Quality Tools
- Enable PHP_CodeSniffer and select "Uncanny-Owl" standard
Troubleshooting
Common Issues
-
Standards Not Found
-
Permission Issues
- Path Issues
Debug Mode
For detailed output about paths and configuration:
Contributing
- Fork the repository
- Create your feature branch
- Make your changes
-
Run tests and ensure coding standards:
- Submit a pull request
License
MIT License - see LICENSE file for details.
Support
All versions of uncanny-owl-coding-standards with dependencies
squizlabs/php_codesniffer Version ^3.10.1
dealerdirect/phpcodesniffer-composer-installer Version ^0.7.2
wp-coding-standards/wpcs Version ^3.1.0
phpcompatibility/php-compatibility Version ^9.3
phpcompatibility/phpcompatibility-wp Version ^2.1
phpcompatibility/phpcompatibility-paragonie Version ^1.3
phpcsstandards/phpcsutils Version ^1.0
phpcsstandards/phpcsextra Version ^1.1