https://github.com/bolt/codingstyle
PHP_CodeSniffer rule set for Bolt
https://github.com/bolt/codingstyle
Last synced: about 1 month ago
JSON representation
PHP_CodeSniffer rule set for Bolt
- Host: GitHub
- URL: https://github.com/bolt/codingstyle
- Owner: bolt
- License: mit
- Created: 2015-04-11T08:07:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-04T08:33:18.000Z (over 6 years ago)
- Last Synced: 2025-03-30T19:22:16.468Z (2 months ago)
- Language: PHP
- Homepage: http://bolt.cm
- Size: 69.3 KB
- Stars: 2
- Watchers: 14
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Bolt coding style standard
==========================
PHP
---
[Bolt](https://github.com/bolt) tries to adhere a coding style based on PSR-2
and the Symfony2 coding standard.
### [CodeSniffer][phpcs]
To use run:
```
composer require bolt/codingstyle squizlabs/php_codesniffer escapestudios/symfony2-coding-standard:^3.0@dev --dev
```
Add a `global` before `require` if you want to install it globally.
If installing globally you also need to configure the `installed_paths`:
```
phpcs --config-set installed_paths "$(composer config --global data-dir)"
```
Then create a CodeSniffer config file named `phpcs.xml.dist` in your project root:
```xml
src
tests
```
Additional changes can be made here. See [CodeSniffer's annotated ruleset][phpcs_ruleset] for more information.
`phpcs.xml.dist` should be committed for all developers to use.
An `phpcs.xml` file can also be create which takes precedence over `phpcs.xml.dist` for local
changes. This file should be ignored from git.
### [Code Fixer][code_fixer]
To use run:
```bash
composer require bolt/codingstyle friendsofphp/php-cs-fixer --dev
```
Add a `global` before `require` if you want to install it globally.
Then create a config file named `.php_cs.dist` in your project root:
```php
addRules(
// Create Bolt's standard rules.
Bolt\CsFixer\Rules::create()
// Enable risky rules.
->risky()
// Enable PHP 5.6, 7.0, and 7.1 rules. Methods exist for each version.
//->php71()
)
// Modify existing rules or add new ones.
->addRules([
'heredoc_to_nowdoc' => false,
'mb_str_functions' => true,
])
// Add directories to scan.
->in('src', 'tests')
;
```
See their [website][code_fixer] for a list of rules and additional configuration options.
`.php_cs.dist` should be committed for all developers to use.
An `.php_cs` file can also be create which takes precedence over `.php_cs.dist` for local
changes. This file should be ignored from git.
JavaScript
----------
There's no explicitly written style yet, but when creating the files needed for
Bolt using the grunt toolchain there's a target linting the javascript code.
[phpcs]: http://pear.php.net/package/PHP_CodeSniffer
[phpcs_ruleset]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
[code_fixer]: http://cs.sensiolabs.org