10up/10up-code-review

此软件包已被废弃,不再维护。未建议替代软件包。

专门的规则集,有助于协助进行10up WordPress项目的代码审查。

v0.2.0 2016-02-10 23:31 UTC

This package is not auto-updated.

Last update: 2022-02-01 12:55:15 UTC


README

Packagist License

此软件包是一系列标准,用于PHP_CodeSniffer,以帮助10up的工程师在进行或执行代码审查时。

这并不能替代实际的代码审查,但它可以帮助审查员和工程师 alike 发现一些显而易见的问题,以便他们可以专注于更困难的部分!

68747470733a2f2f31307570646f74636f6d2d7770656e67696e652e73332e616d617a6f6e6177732e636f6d2f75706c6f6164732f323031362f31302f313075702d4769746875622d42616e6e65722e706e67

安装

安装此软件包的最简单方法是在全局范围内使用Composer

$ composer global require 10up/10up-code-review
$ ~/.composer/vendor/bin/10up-code-review-install

您也可以根据项目安装此软件包

$ composer require --dev 10up/10up-code-review
$ ./vendor/bin/10up-code-review-install

用法

在命令行中,运行以下命令

$ phpcs --standard=10up-Code-Review path/to/your/project

由于这只是一个自定义规则集的集合,因此仍然适用常规PHP_CodeSniffer命令。

标准

此软件包包含以下PHP_CodeSniffer规则集

10up-Base

这是一个基础规则集,其他所有10up规则集都应该扩展。

此规则集基于10up工程最佳实践generator-wp-make指定的路径设置了一些默认的<ignore-pattern />路径。

10up-Code-Review

应用WordPress编码标准,关注诸如清理、延迟转义等问题,但不针对文档、空白等发出警告。

这可能是您在执行代码审查时将使用的默认编码标准;它基于WordPress-Extra标准,但删除了关于空白和一般格式的投诉,让您专注于重要问题,如性能、清理、延迟转义等。

10up-Third-Party

扩展10up-Code-Review标准,以忽略在审查第三方代码时常见的(但相对无害的)错误。

10up在将第三方代码实现到项目中之前会对其进行审查,但有时即使代码功能完善且安全,也会触发PHP_CodeSniffer,因为即使伟大的插件也往往缺乏遵守WordPress编码标准。此标准从10up-Code-Review标准中删除了一些更严格的代码检查,同时继续标记潜在的不安全代码。

许可证

MIT许可证(MIT)版权所有(c)2016 10up,LLC

特此授权,免费向任何获得本软件及其相关文档副本(以下简称“软件”)的个人,在不限制的情况下处理软件,包括但不限于使用、复制、修改、合并、发布、分发、许可和/或出售软件副本,并允许获得软件的个人进行此类操作,但须遵守以下条件:

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

软件按“现状”提供,不提供任何形式的保证,无论是明示的、暗示的,包括但不限于适销性、适用于特定目的和未经授权的保证。在任何情况下,作者或版权所有者不对任何索赔、损害或其他责任承担责任,无论基于合同、侵权或其他行为,均源于、产生于或与软件或软件的使用或其他使用有关。