https://github.com/camelotproject/coding-style
https://github.com/camelotproject/coding-style
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/camelotproject/coding-style
- Owner: CamelotProject
- License: mit
- Created: 2018-08-21T09:12:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T15:19:27.000Z (about 1 year ago)
- Last Synced: 2025-02-14T14:51:47.537Z (4 months ago)
- Language: PHP
- Size: 43 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Camelot coding style standard
=============================
PHP
---
[Camelot](https://github.com/CamelotProject) tries to adhere a coding style based on PSR-2
and the Symfony2 coding standard.
### [CodeSniffer][phpcs]
To use run:
```
composer require camleot/codingstyle --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 camelot/codingstyle --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 Camelot's standard rules.
Camelot\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
Camelot 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