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 工具。

  1. 安装
composer require friendsofphp/php-cs-fixer --dev

一般情况下,仅在开发环境使用

  1. 创建配置文件


    image.png

如果你安装完成了,你在 vendor/friendsofphp/php-cs-fixer 下会发现一个 .php_cs.dist 文件,它是默认的格式化配置,将其复制到项目根目录下 。

  1. 配置信息解读
    如果你阅读文档了,你会知道在该文件中应该返回一个 PhpCsFixer\ConfigInterface,它提供了相关的接口去设置验证规则 (setRules)、需要排除的文件(notPath)、忽略的目录(exclude)等。在规则中,你可以设置一些自定义的规则,比如生成注释头信息(header-comment)等。

更多使用规则请查阅 文档

  1. 执行格式化命令
    在你安装完成之后,会自动在你的 vendor/bin/php-cs-fixer 命令,你就可以使用该命令去格式化你的项目了。
vendor/bin/php-cs-fixer fix
image.png

该命令会自动生成一个 .php_cs.cache 文件,为配置缓存文件。

  1. 效果
    此时你可能会发现它更改了较多的文件,而被莫名其妙的加入一些注释信息,不用担心,这是配置文件中配置的,这些配置你都可以通过修改配置文件调整。
image.png

.gitignore

.php_cs.dist.php_cs 文件应该是要被添加到版本控制之中,因为它就是用来规范代码风格。而 .php_cs.cache 文件你就可以排除版本控制之外,加入到 .gitignore 文件之中。

命令的提炼

你可以能对 vendor/bin/php-cs-fixer 命令感觉不是很方便,我们更容易理解的是composerartisan 命令,那么就可以对其进行封装一下。

composer run-script

此时你需要的在 composer.jsonscripts 增加一个脚本,就像下面这样。

    "scripts": {
        "phpcs": "vendor/bin/php-cs-fixer fix",
        ...
    },

此时,你就可以这样使用了。

composer run-script phpcs
image.png

artisan

Artisan 命令需要使用到 shell_exce() 函数,它能够支持执行 shell 命令。

<?php

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * 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 作者的风格作为编码的风格。该篇文章是受开源项目 一刻社区 启发,发现其引用的该组件,于是做了一番学习,才有了此篇文章,如果你感觉有一点点收获,那么请不要吝惜你的赞赏,哈哈哈。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容