webdevstudios / wds-coding-standards
此包已被废弃,不再维护。未建议替代包。
此包最新版本(2.0.1)没有提供许可证信息。
WebDevStudios 内部代码风格和编码规范
2.0.1
2019-06-21 17:28 UTC
Requires
- squizlabs/php_codesniffer: 3.3.1
- wp-coding-standards/wpcs: 2.1.0
This package is not auto-updated.
Last update: 2020-08-22 06:56:43 UTC
README
为您的首选编辑器提供 WebDevStudios 内部代码风格和编码规范。
领导团队
- Aubrey Portwood(高级 BED 开发者)
- 编写与集成编码规范/维护规范
- Greg Rickaby(工程总监)
- 高级批准/领导
如何安装
只需拿一杯 ☕ 然后按照这里的说明操作。
想要贡献?
请参阅CONTRIBUTING.md。
变更日志
2.0.1
- 修复了最新
eslint
中getFilename
错误的问题 PR
2.0.0
PHPCS 升级指南: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Version-3.0-Upgrade-Guide
此版本更新到新的 WPCS ^2.x
。
- 重写了我们所有的自定义嗅探器,以使用新的
PHP_CodeSniffer
结构 a210b73
1.2.0
- WordPress 编码规范更新到
1.2.1
- 通过 composer 安装 PHPCS 3.3.2
- JS 中的函数赋值需要文档注释(请参阅发行说明)
- 在 PHP 和 JS 的文档注释中建议使用
@author
(请参阅发行说明) - 在抽象方法上文档化
@return
将不再显示缺失@return
的警告
发行说明
此安装需要您额外执行一步操作才能使 eslint
正常工作
npm install -g "/path/to/WebDevStudios/eslint-plugin-webdevstudios"
这将安装通过 eslint-plugin-webdevstudios/*
添加的附加 ES Lint 规则,现在需要自定义 ES Lint 规则。
1.1.1
- WDSCS 现在需要 WPCS 0.14.1 #34;归功于 @jrfoell
@since
现在是警告 #39@since
不会为wp-content/themes/**
中的文件显示警告 #39
1.1.0
@return
和@since
规则是 #27- 在此处找到 VIM PHPCS 配置 here #28
- 从 wd_s 带来 eslint 规则并改进,使其更类似于 WordPress.org 编码标准中的旧 jshint 规则 #10 #22
- 如何在CONTRIBUTING.md中投票更清晰
- 新增Sass linting#26
此次发布使WDS的大部分内容与当前建立的编码标准相匹配,而这些标准以前在我们的linting中缺失。感谢@aubreypwd、@gregrickaby、@JayWood、@jrfoell和@phatsk的所有有帮助性的工作!
1.0.1
- 将
WebDevStudios-phpcs
更改为WebDevStudios
以提高与命名空间的兼容性并添加了后续的新sniffs#12 - 包含
WordPress-Docs
规则集
注意,此次发布可能会破坏一些功能。当您更新到此版本时,您需要将编码标准更新为WebDevStudios
,而不是旧的WebDevStudios-phpcs
,后者现在应该不再工作。
1.0.0
- 初始规则集基于WordPress-Extra