包简介

Geniem Oy (WordPress) CodeSniffer Rules

README 文档

README

Geniem (WordPress) PHP_CodeSniffer Rules

A custom set of rules to check styles for a Geniem WP projects.

Extends WordPress, WordPress-Docs, WordPress-Extra, and others, but makes some convenience changes to the rules.

Adds to the mix some of our own rules:

Geniem.ControlStructures.ElseCatchNewline
- Make else and catch blocks to start from new line

The Geniem standard contains over 250 rules. Check them out.

Installation

composer require --dev devgeniem/geniem-rules-codesniffer
cp vendor/devgeniem/geniem-rules-codesniffer/phpcs.xml.dist-project phpcs.xml.dist

Usage

Use vendor/bin/phpcs --standard=phpcs.xml.dist web/app/ config/ to make sure you are using the phpcs command from this package.

You could add to your project composer.json file the following:

{
    "scripts": {
        "lint": "vendor/bin/phpcs --standard=phpcs.xml.dist web/app/ config/ -s --warning-severity=0",
        "lint-all": "vendor/bin/phpcs --standard=phpcs.xml.dist web/app/ config/",
        "lint-fix": "vendor/bin/phpcbf --standard=phpcs.xml.dist --basepath=. ./web/app/ ./config/"
    }
}

After that has been added to your composer.json file, you can run composer lint to check for all the errors and warnings.

Development

This project contains few helpers to make the development experience easier and faster.

These commands are available in the composer.json file, and are used composer [command]. The composer part has been omitted for brevity.

Command	Description
`used-rules-list-update`	Updates `USED_RULES.md`
`cl-bump`	Create new version in `CHANGELOG.md`
`cl-change [message]`	Add an entry to Changed -section.
`cl-add [message]`	Add an entry to Added -section.
`cl-fix [message]`	Add an entry to Fixed -section.
`cl-remove [message]`	Add an entry to Removed -section.
`cl-ready`	Mark the version ready for release.
`cl-version`	Show the current version.
`changelog-tag-and-release [version]`	REQUIRES GPG Tag and release the version.

Developers

See contributors

License

MIT

devgeniem/geniem-rules-codesniffer 适用场景与选型建议

devgeniem/geniem-rules-codesniffer 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 59.62k 次下载、GitHub Stars 达 2，最近一次更新时间为 2020 年 06 月 04 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「wordpress」「tooling」「standards」「phpcs」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 devgeniem/geniem-rules-codesniffer 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 devgeniem/geniem-rules-codesniffer 我们能提供哪些服务？

定制开发 / 二次开发

基于 devgeniem/geniem-rules-codesniffer 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发