php cs fixer switch,PSR规范代工厂之 php-cs-fixer 的代码合规之路
前言
编程语言都有一套专属的语法,循其法而编其码,方能被该语言的编译器识别,从而编译成低级语言,被机器识别。而语法规范不了编码风格,编码风格是由程序员决定的,程序员的思想的天马行空,也造就了风格迥异的代码。程序员秉承着开放的精神,挥舞着民主自由的大旗,在编码的世界里驰骋、翱翔。
这样的代码不可谓之不好,只是长此以往,会产生一些声音,“这样写更好”,“那样写更棒”,“你写的太乱了”,“我写的是标准化”,“太难维护了”,“不够优雅”等等。诸如此类,在历经岁月的长河之后,《最佳实践》便出现了,本着百尺竿头更近一步的方针,顺其自然的上升到了业界标准,由一群致力于简洁、优雅、美观、大方的程序员维护着,并矢志不渝的遵守着,也给后来人一些方向。
它虽然限制了编码风格,但因此编码风格统一了,也就让代码变得更加优雅、易读、易维护、易开发。无论对于个人以及团队而言,它都是一剂温和的修正药。你服用了这剂药,那么也意味着你开源的代码中,多了一些人能够读懂;让你团队代码审核员更加明白你的思绪,让你的代码能够被多数人认可,让你的代码让多数人读懂。
编码规范的出现,也促生了相应的格式化工具,可能仅需一条命令,你的代码就可以符合编码规范,也就成了编码风格的最佳实践,也就是说,在编码的过程中你可以不必纠结于编码中排版、缩进等等繁琐的约束,而开心愉悦编码。
类似的工具有php-cs-fixer、es-lint等等。
闲言少叙,书归正传。今天要讲的是 PHP 编码规范以及 php-cs-fixer 格式化工具。
对于PHP而言,有一套编码规范供大家参考,也就是PSR(PHP Standard Recommendations ),由 PHP FIG 组织制定的 PHP 规范,是 PHP 开发的实践标准。
php-cs-fixer 是一个开源的 PSR 编码规范的格式化工具。
依托 Laravel 框架,安装 php-cs-fixer
你可以在 Packagist 或者 Github 查找 php-cs-fixer 工具。
安装
composer require friendsofphp/php-cs-fixer --dev
一般情况下,仅在开发环境使用
创建配置文件
image.png
如果你安装完成了,你在 vendor/friendsofphp/php-cs-fixer 下会发现一个 .php_cs.dist 文件,它是默认的格式化配置,将其复制到项目根目录下 。
配置信息解读
如果你阅读文档了,你会知道在该文件中应该返回一个 PhpCsFixer\ConfigInterface,它提供了相关的接口去设置验证规则 (setRules)、需要排除的文件(notPath)、忽略的目录(exclude)等。在规则中,你可以设置一些自定义的规则,比如生成注释头信息(header-comment)等。
更多使用规则请查阅 文档
执行格式化命令
在你安装完成之后,会自动在你的 vendor/bin/php-cs-fixer 命令,你就可以使用该命令去格式化你的项目了。
vendor/bin/php-cs-fixer fix
image.png
该命令会自动生成一个 .php_cs.cache 文件,为配置缓存文件。
效果
此时你可能会发现它更改了较多的文件,而被莫名其妙的加入一些注释信息,不用担心,这是配置文件中配置的,这些配置你都可以通过修改配置文件调整。
image.png
.gitignore
.php_cs.dist 或 .php_cs 文件应该是要被添加到版本控制之中,因为它就是用来规范代码风格。而 .php_cs.cache 文件你就可以排除版本控制之外,加入到 .gitignore 文件之中。
命令的提炼
你可以能对 vendor/bin/php-cs-fixer 命令感觉不是很方便,我们更容易理解的是composer或artisan 命令,那么就可以对其进行封装一下。
composer run-script
此时你需要的在 composer.json 的 scripts 增加一个脚本,就像下面这样。
"scripts": {
"phpcs": "vendor/bin/php-cs-fixer fix",
...
},
此时,你就可以这样使用了。
composer run-script phpcs
image.png
artisan
Artisan 命令需要使用到 shell_exce() 函数,它能够支持执行 shell 命令。
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier
* Dariusz Rumiński
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace App\Console\Commands;
use Illuminate\Console\Command;
class PHPCs extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'php:cs';
/**
* The console command description.
*
* @var string
*/
protected $description = '格式化代码';
/**
* Create a new command instance.
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return mixed
*/
public function handle()
{
shell_exec('vendor/bin/php-cs-fixer fix');
}
}
写在后面
其实一直没对编码风格这块做一些研究,经常是以 Laravel 作者的风格作为编码的风格。该篇文章是受开源项目 一刻社区 启发,发现其引用的该组件,于是做了一番学习,才有了此篇文章,如果你感觉有一点点收获,那么请不要吝惜你的赞赏,哈哈哈。
php cs fixer switch,PSR规范代工厂之 php-cs-fixer 的代码合规之路相关推荐
- PHP 规范之PSR规范
概述 PSR 不是PHP官方标准,而是从如Zend.Symfony2等知名PHP项目中提炼出来的一系列标准,目前有越来越多的社区项目加入并遵循该标准. 参考:http://psr.phphub.org ...
- PHP规范之PSR规范
参考:http://psr.phphub.org/ PSR 不是PHP官方标准,而是从如Zend.Symfony2等知名PHP项目中提炼出来的一系列标准,目前有越来越多的社区项目加入并遵循该标准. P ...
- php rfc3986规范,「PSR 规范」PSR-7 HTTP 消息接口规范
「PSR 规范」PSR-7 HTTP 消息接口规范 HTTP消息接口 此文档描述了 RFC 7230 和 RFC 7231 HTTP 消息传递的接口,还有 RFC 3986 里对 HTTP 消息的 U ...
- 「PSR 规范」PSR-2 编码风格规范
所有 PSR 规范请见:https://learnku.com/docs/psr https://learnku.com/laravel/t/2079/psr-specification-psr-2- ...
- 全球第三的晶圆代工厂 也要被卖了?
今日,据外媒报道,全球第三大晶圆代工厂格罗方德可能将面临被出售的命运. 目前为止,它仍然是全球第三大晶圆代工厂,市场份额占据8.4%,仅次于台积电和三星电子,但近几个月陆续传出来的消息都在暗示其已经步 ...
- 苹果降价背后的代工厂之殇
代工厂的消亡史,这似乎是几十年都不能改写的结局. iPhone降价了,几个字的背后,牵扯的却是几百万人的营生. 2019,注定是命途多舛的一年,而苹果危机背后的代工厂也岌岌可危.毕竟是一条绳上的蚂蚱, ...
- 台积电和三星成半导体代工厂恶战主角 受谁影响?
早前台积电公布了今年二季度的业绩,营收达到23亿美元,比业界预期高了5.2%,并顺势提高今年的资本支出,从原预估的90~100亿美元提升到95~105亿美元,正不断的加强它在半导体代工市场的竞争优势. ...
- 走访近20家代工厂后:近千块的大牌T恤,成本只要几十块
▲ 点击查看 "很多人都知道大牌有溢价 但是不知道大牌溢价逼近900% 打个比方 一件1000块的T恤,T恤成本如果是100 那么剩下的900,算是买了个大牌logo" 这是我们上 ...
- 中国代工厂的困惑:把大牌t恤卖到99块3件,还会有人买吗?
▲ 点击查看 "很多人都知道大牌有溢价 但是不知道大牌溢价逼近900% 打个比方 一件1000块的T恤,T恤成本如果是100 那么剩下的900,算是买了个大牌logo" 这是我们上 ...
最新文章
- Eclipse 4.9 正式发布,支持 Java 11
- java职业技能了解精通_如何通过精通数字分析来提升职业生涯的发展,第8部分...
- ROS语音识别科大讯飞语音SDK
- Cadence导出带有书签和链接的PDF原理图
- 广告投放类型以及各大平台计费准则+推广常用评价指标
- 使用百度OCR做答题软件辅助
- Win10下载和安装FPGA软件:Quartus Prime( Standard 版本18.1)
- MT2625 NB IoT_RF资料分享
- 数仓模型设计详细讲解
- linux输入密码后提示密码错误,用sudo命令没有提示输入密码,而是出现sudo:3次错误密码尝试的解决...
- 【转】西门子数控系统中MMC、PCU、NCU、CCU简略介绍
- 深入理解LINUX内核 第三版2.6 笔记
- Python制作日历
- 【号外】支付宝道歉,错了就是错了,马云回话
- GAMES101作业6及课程总结(重点解决SAH扩展作业)
- Keras如何保存、加载Keras模型
- Android开发之歪门邪道给 文本选中追加第三方软件入口
- 四大游览器兼容问题综合实例
- 【产品】一次完整的产品需求分析及设计流程分享
- Project 2007下的关键路径计算设置