Skip to content

Commit

Permalink
Describe how to use this
Browse files Browse the repository at this point in the history
  • Loading branch information
josephscott committed May 23, 2024
1 parent 2f790e4 commit 267cc45
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
# phpcsfixer-config
# phpcsfixer-config

### Install

```
composer require --dev josephscott/phpcsfixer-config
```

Create a `.php-cs-fixer.dist.php` in the top level directory of your
repo with:

```
<?php
declare( strict_types = 1 );
require __DIR__ . '/vendor/autoload.php';
$fixer_config = new JosephScott\PHPCSFixer_Config( __DIR__ );
return $fixer_config->get_config();
```

If you want to make alterations, all of the rules and options are available
via public attributes on the `JosephScott\PHPCSFixer_Config()` object. Here
is how you would alter the `array_indention` rule and the indent config
option:

```
$fixer_config = new JosephScott\PHPCSFixer_Config( __DIR__ );
$fixer_config->config_indent = ' ';
$fixer_config->rules['array_indention'] = false;
return $fixer_config->get_config();
```

0 comments on commit 267cc45

Please sign in to comment.