https://github.com/brackets-by-triad/code-style-fixer

Composer package to fix code style of php application.
https://github.com/brackets-by-triad/code-style-fixer

Last synced: 3 months ago
JSON representation

Composer package to fix code style of php application.

• Host: GitHub
• URL: https://github.com/brackets-by-triad/code-style-fixer
• Owner: BRACKETS-by-TRIAD
• Created: 2019-04-24T21:08:24.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-10T13:17:10.000Z (almost 3 years ago)
• Last Synced: 2024-09-29T11:45:38.010Z (3 months ago)
• Language: PHP
• Size: 37.1 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PhpCsFixer and Git Hooks

This repository is the source for Php Cs Fixer installation to your project. It uses brainmaestro/composer-git-hooks and friendsofphp/php-cs-fixer for its purpose and creates only wrapper for this packages.

First you need to require this composer package: 

```

composer require --dev brackets/code-style-fixer

```

Next you have to add this to script section of `composer.json`

```

"scripts": {

    ...

    "post-install-cmd": [

        ...

        "[ $COMPOSER_DEV_MODE -eq 0 ] || ./vendor/bin/code-style-fixer.sh git-hooks-add --ignore-lock"

    ],

    "post-update-cmd": [

        ...

        "[ $COMPOSER_DEV_MODE -eq 0 ] || ./vendor/bin/code-style-fixer.sh git-hooks-update"

    ]

}

```

And then you have to install the package

```

./vendor/bin/code-style-fixer.sh install

```

Now you should have installed the package and on every pre-commit the fixer will run. On every pre-push the fixer will run, but only to check if everything is ok. If not, push will fail.

## Additional commands

### Git Hooks

You can manipulate the git hooks by

 

```

./vendor/bin/code-style-fixer.sh git-hooks-add | git-hooks-update | git-hooks-remove | git-hooks-list

```

This commands are just wrapper for brainmaestro/composer-git-hooks package, so see https://github.com/BrainMaestro/composer-git-hooks for readme.

### Php Cs Fixer

To manually run phpCsFixer script use

```

./vendor/bin/code-style-fixer.sh fix

```

You can use all parameters defined in https://github.com/FriendsOfPHP/PHP-CS-Fixer, the fix command is just a wrapper for php-cs-fixer.