mementohub/coding-standards

Coding Standards used within the Memento Hub team.

Maintainers

Details

github.com/mementohub/coding-standards

Source

Issues

Installs: 10

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

0.0.3 2022-01-19 13:50 UTC

Requires

MIT 27ca898f47352f34a036866a9e5ea22c7916c92a

  • Bogdan Cismariu <bogdan.cismariu.woop@gmail.com>

This package is auto-updated.

Last update: 2024-04-25 15:20:44 UTC

README

The development of this package has been greatly inspired by this Laravel News article

Installation

# install package
composer require --dev mementohub/coding-standards

# set php-cs-fixer config file if not present
cp -n vendor/mementohub/coding-standards/stubs/.php-cs-fixer.dist.php .php-cs-fixer.dist.php

# set git pre-commit hook if not present
cp -n vendor/mementohub/coding-standards/stubs/pre-commit .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

# add .php-cs-fixer.cache file to .gitignore if not already present
grep -qxF '/.php-cs-fixer.cache' .gitignore || echo '/.php-cs-fixer.cache' >> .gitignore

# run a global fix on your project and commit the changes
# it has to run twice for some rules to take effect
vendor/bin/php-cs-fixer fix --using-cache=no
vendor/bin/php-cs-fixer fix --using-cache=no
git add . && git commit -m "Fixed code styling"

VS Code configuration

Install the calebporzio.simple-php-cs-fixer extension.

Add the following entries to your settings file:

{
    "simple-php-cs-fixer.useConfig": true,
    "simple-php-cs-fixer.config": ".php-cs-fixer.dist.php",
    "simple-php-cs-fixer.save": true,
    "simple-php-cs-fixer.usingCache": false
}