README

PHP

Camelot 尝试遵循基于PSR-2和Symfony2编码标准的编码风格。

CodeSniffer

要使用，请运行

composer require camleot/codingstyle --dev

如果您想全局安装，请在require之前添加一个global。

全局安装时，还需要配置installed_paths

phpcs --config-set installed_paths "$(composer config --global data-dir)"

然后在项目根目录中创建一个名为phpcs.xml.dist的CodeSniffer配置文件

<?xml version="1.0"?>
<ruleset>
    <!-- Add color to output...umm duh -->
    <arg name="colors"/>

    <!-- Files or folders to sniff -->
    <file>src</file>
    <file>tests</file>

    <!-- Path to our coding standard folder -->
    <rule ref="vendor/camelot/codingstyle/Camelot"/>
</ruleset>

在此处可以进行其他修改。有关更多信息，请参阅CodeSniffer的注释规则集。

phpcs.xml.dist应提交给所有开发者使用。
还可以创建一个phpcs.xml文件，该文件将覆盖phpcs.xml.dist以进行本地更改。此文件应从git中忽略。

Code Fixer

要使用，请运行

composer require camelot/codingstyle --dev

如果您想全局安装，请在require之前添加一个global。

然后在项目根目录中创建一个名为.php_cs.dist的配置文件

<?php

return Camelot\CsFixer\Config::create()
    // addRules() accepts arrays and traversable objects.
    ->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')
;

请访问他们的网站以获取规则列表和附加配置选项。

.php_cs.dist应提交给所有开发者使用。
还可以创建一个.php_cs文件，该文件将覆盖.php_cs.dist以进行本地更改。此文件应从git中忽略。

JavaScript

尚未明确编写风格，但在使用grunt工具链创建Camelot所需文件时，有一个针对JavaScript代码的linting目标。