sunray/coding-standard

Sunray 开发编码标准

维护者

详细信息

github.com/sunray/coding-standard

源代码

问题

安装: 45

依赖项: 0

建议者: 0

安全: 0

星标: 1

关注者: 3

分支: 0

公开问题: 0

dev-master 2019-03-07 20:59 UTC

Requires

MIT 0b0737d54d6bc1dfd6c890bc4a2b2f006d066d23

This package is auto-updated.

Last update: 2024-09-08 08:58:19 UTC

README

Downloads License

这是一个用于常见PHP和JavaScript模块的编码标准。

本标准的宗旨在Sunray 编码哲学中概述，旨在通过可读、可调试和可维护的代码创建一个高效的开发工作流程。基本原则包括

PHP

PHP特定的编码标准在单独的文档中概述。

要求

  • PHP 7.1+
  • Composer

安装

  1. 将"sunray/coding-standard": "dev-master"添加到应用程序composer.json文件的require-dev块中，如下所示
    {
    "require-dev": {
        "sunray/coding-standard": "dev-master"
    }
}
    或自动添加
    composer require --dev sunray/coding-standard:dev-master

使用方法

  1. 在应用程序根目录下创建一个phpcs.xml文件，如下所示
    <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<ruleset name="ProjectName">
    <!-- Configure Project Paths -->

    <!-- PHPCS Settings -->
    <arg value="p" />
    <arg value="s" />
    <arg name="basepath" value="." />
    <arg name="colors" />
    <arg name="cache" />
    <arg name="extensions" value="php" />
    <arg name="encoding" value="utf-8"/>
    <arg name="report-width" value="80" />

    <!-- Include the Sunray coding standard -->
    <rule ref="vendor/sunray/coding-standard/ruleset.xml" />
</ruleset>
  2. 从应用程序根目录执行以下操作
    vendor/bin/phpcs

JavaScript