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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

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

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:

Available Standards

Custom Ruleset

You can override the default ruleset for your project in two ways:

  1. Project-specific ruleset (Recommended): Create a phpcs.xml or phpcs.xml.dist in your project root:

  2. Command-line Override:

IDE Integration

Visual Studio Code

  1. Install the PHP Sniffer & Beautifier extension
  2. Configure settings.json:

PhpStorm

  1. Go to Settings → PHP → Quality Tools → PHP_CodeSniffer
  2. Set PHP_CodeSniffer path to your vendor/bin/phpcs
  3. Go to Settings → Editor → Inspections
  4. Enable PHP → Quality Tools → PHP_CodeSniffer validation
  5. Set 'Coding Standard' to Uncanny-Owl

CI/CD Integration

Buddy

GitHub Actions

Troubleshooting

Common Issues

  1. Standards Not Found

    • Ensure Composer installation was successful
    • Try running composer install again
    • Check if the standard is listed in vendor/bin/phpcs -i
  2. 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

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. 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

  1. Install the PHP Sniffer & Beautifier extension
  2. Configure settings.json:

PhpStorm

  1. Go to Settings → PHP → Quality Tools → PHP_CodeSniffer
  2. Set PHP_CodeSniffer path to the uocs binary
  3. In Editor → Inspections → PHP → Quality Tools
  4. Enable PHP_CodeSniffer and select "Uncanny-Owl" standard

Troubleshooting

Common Issues

  1. Standards Not Found

  2. Permission Issues

  3. Path Issues

Debug Mode

For detailed output about paths and configuration:

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Make your changes
  4. Run tests and ensure coding standards:

  5. Submit a pull request

License

MIT License - see LICENSE file for details.

Support


All versions of uncanny-owl-coding-standards with dependencies

PHP Build Version
Package Version
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package uocs/uncanny-owl-coding-standards contains the following files

Loading the files please wait ....