hitechnix/php-cs-fixer

Automatically configuration PHP CS Fixer for projects.

v3.0.0 2024-01-30 08:39 UTC

Requires

• php: ^8.0
• friendsofphp/php-cs-fixer: ^3.0

BSD-3-Clause

• Hi-Technix, Inc.

• php
• php-cs-fixer
• hitechnix

README

This repository provides a base configuration for friendsofphp/php-cs-fixer, which we use to verify and enforce a single coding standard for PHP code.

📦 Requirements

The package requires PHP 8.0+ and follows the FIG standard PSR-4 to ensure a high level of interoperability between shared PHP code.

📋 Features

• Defining your rules.
• Sharing your rules.
• Minimize risk rules.
• Scaffolding the repository.
• And much more!

🔧 Installation

Install the package with the below command:

composer require hitechnix/php-cs-fixer

📝 Usage

Now that the package is installed, create a configuration file called .php_cs, .php_cs.php or .php-cs-fixer.php at the root of your project with the following contents:

<?php

// Create a new CS Fixer Finder instance
$finder = PhpCsFixer\Finder::create()->in(__DIR__);

return Hitechnix\PhpCsFixer\Config::create()
    ->setFinder($finder);

Ignoring files and/or directories

• There will be certain situations where you might want to ignore certain files or directories to not be linted.
• Luckily, this is quite easy to achieve and all you need to do is to perform some calls on the CS Fixer Finder instance :)
• Here's a simple example where we ignore both files and directories:

<?php

// Directories to not scan
$excludeDirs = [
    'vendor/',
];

// Files to not scan
$excludeFiles = [
    'config/app.php',
];

// Create a new CS Fixer Finder instance
$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__)
    ->exclude($excludeDirs)
    ->ignoreDotFiles(true)
    ->ignoreVCS(true)
    ->filter(function (\SplFileInfo $file) use ($excludeFiles) {
        return ! in_array($file->getRelativePathName(), $excludeFiles);
    });

return Hitechnix\PhpCsFixer\Config::create()->setFinder($finder);

📨 Message

I hope you find this useful. If you have any questions, please create an issue.

🔐 Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

📖 License

This software is released under the BSD 3-Clause License. Please see the LICENSE file or https://opensource.hitechnix.com/LICENSE.txt for more information.

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Son Tran Thanh 🔧 🚇 🚧 💻 📖 👀

This project follows the all-contributors specification. Contributions of any kind welcome!