https://github.com/xenforo-ltd/xf-cs-fixer

A PHP Coding Standards Fixer configuration for XenForo
https://github.com/xenforo-ltd/xf-cs-fixer

php-cs-fixer xenforo

Last synced: 4 months ago
JSON representation

A PHP Coding Standards Fixer configuration for XenForo

• Host: GitHub
• URL: https://github.com/xenforo-ltd/xf-cs-fixer
• Owner: xenforo-ltd
• License: mit
• Created: 2024-05-01T22:30:12.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2026-01-23T00:33:22.000Z (5 months ago)
• Last Synced: 2026-01-25T17:59:10.377Z (5 months ago)
• Topics: php-cs-fixer, xenforo
• Language: PHP
• Homepage: https://xenforo.com
• Size: 55.7 KB
• Stars: 6
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# XenForo Coding Standards Fixer

[![XenForo](https://img.shields.io/badge/XenForo-%230F578A)](https://xenforo.com)

[![License](https://img.shields.io/packagist/l/xenforo-ltd/xf-cs-fixer?label=license)](https://packagist.org/packages/xenforo-ltd/xf-cs-fixer)

[![Version](https://img.shields.io/packagist/v/xenforo-ltd/xf-cs-fixer?label=version)](https://packagist.org/packages/xenforo-ltd/xf-cs-fixer)

[![Status](https://img.shields.io/github/check-runs/xenforo-ltd/xf-cs-fixer/main?label=status)](https://github.com/xenforo-ltd/xf-cs-fixer/actions)

A [PHP Coding Standards Fixer](https://cs.symfony.com) configuration for [XenForo](https://xenforo.com).

This library provides a configuration helper and a handful of additional rules

which supplement the built-in [PER-CS](https://cs.symfony.com/doc/ruleSets/PER-CS.html)

rule set to automatically format code according to the XenForo code style.

## Installing

To use our configuration or rules, install them with [Composer](https://getcomposer.org):

```

composer require --dev xenforo-ltd/xf-cs-fixer

```

## Usage

Create a `.php-cs-fixer.dist.php` configuration file in your project directory:

```php

in(__DIR__)

	->ignoreVCSIgnored(true)

	->notPath([

		// you may set paths or path patterns to exclude here

	]);

$helper = new ConfigHelper($finder);

// you may customize the rules or configuration further here

return $helper->getConfig();

```

For more information, consult the [PHP Coding Standards Fixer documentation](https://cs.symfony.com/#usage).