搜索
首页后端开发php教程这个php-cs-fixer编码格式化工具,你还不会用吗?

php-cs-fixer - PHP 编码格式化工具

php-cs-fixer 是个代码格式化工具,格式化的标准是 PSR-1、PSR-2 以及一些 symfony 的标准。这个工具也和 symfony、twig 等优秀的 PHP 库出自同门。

安装与更新

需要使用 PHP 5.3.6 以上的版本。

你可以直接下载封装好的 phar 包:php-cs-fixer.phar;

或者通过 wget 下载(下面的都是 OSX 和 Linux 上的用法):

wget http://get.sensiolabs.org/php-cs-fixer.phar -O php-cs-fixer

或者通过 curl 下载:

curl http://get.sensiolabs.org/php-cs-fixer.phar -o php-cs-fixer

下载完成后给可执行的权限,然后移动到 bin 目录下面即可:

sudo chmod a+x php-cs-fixer
sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer

这样就可以在任何地方直接使用 php-cs-fixer 命令来调用了。

也可以用过 Composer 来安装:

composer global require fabpot/php-cs-fixer

如果你是 Mac 用户、homebrew 用户并且已经 tap 过 homebrew/php 的话,也可以直接:

brew install php-cs-fixer

或者:

brew install homebrew/php/php-cs-fixer

如果后续需要更新的话:

php-cs-fixer self-update

如果是通过 homebrew 安装的:

brew upgrade php-cs-fixer

如果没有将执行文件放到 bin 目录下或者在 Windows需要使用 php php-cs-fixer.phar 代替 php-cs-fixer

用法

用法也很简单,最基本的命令参数就是 fix,直接执行时会尽可能多的根据默认标准格式化代码:

# 格式化目录 如果是当前目录的话可以省略目录
php-cs-fixer fix /path/to/dir
# 格式化文件
php-cs-fixer.phar fix /path/to/file

--verbose 选项用于展示应用了的规则,默认是文本(txt)格式。

--level 选项用于控制需要使用的规则层级:

php-cs-fixer fix /path/to/project --level=psr0
php-cs-fixer fix /path/to/project --level=psr1
php-cs-fixer fix /path/to/project --level=psr2
php-cs-fixer fix /path/to/project --level=symfony

默认情况下执行的是 PSR-2 的所有选项以及一些附加选项(主要是 symfony 相关的)。还有一些属于『贡献级别』的选项,你可以通过 --fixers 选择性的添加,--fixers 的多个条件要用逗号分开:

php-cs-fixer fix /path/to/dir --fixers=linefeed,short_tag,indentation

如果有需要的话也可以使用 -name_of_fixer 采取黑名单的方式设定禁用哪些选项。如果同时设定了 --fixers-name_of_fixer,前者的优先级更高。

同时使用 --dry-run--diff 命令可以显示出需要修改的汇总,但是并不实际修改。

通过以下方式也可以查看有哪些内容是会修改的,但是并不实际改动文件:

cat foo.php | php-cs-fixer fix --diff -

自定义配置

--config 选项可以用来设置选取目录以及文件进行分析并格式化,但是这个选项只能设置一些常见的已知的项目,比如 symfony:

# For the Symfony 2.3+ branch
php-cs-fixer fix /path/to/sf23 --config=sf23

已有选项:

  • default 默认配置

  • magento magento 项目

  • sf23 symfony 的项目

更多时候,我们可以通过配置文件来自定义格式化选项以及搜索的目录和文件。自定义配置通过在项目根目录添加一个 .php_cs 文件的方式实现。

设置本身就是 PHP 代码,最后返回一个 Symfony\CS\ConfigInterface 的实例即可。你可以设置格式化的选项、级别、文件以及目录。

下面是一个简单的例子:

<?php

$finder = Symfony\CS\Finder\DefaultFinder::create()
    ->exclude('somedir') // 忽略 somedir
    ->in(__DIR__) // 当前目录
;

return Symfony\CS\Config\Config::create()
    ->fixers(['strict_param', 'short_array_syntax']) // 添加两个选项
    ->finder($finder)
;

如果你想完全自定义格式化选项,就需要将格式化级别清空,并指定好所有需要的选项:

<?php

$finder = Symfony\CS\Finder\DefaultFinder::create()
    ->in(__DIR__)
;

return Symfony\CS\Config\Config::create()
    ->level(Symfony\CS\FixerInterface::NONE_LEVEL)
    ->fixers(['trailing_spaces', 'encoding'])
    ->finder($finder)
;

你也可以通过在选项前面添加 - 的方式来禁用某些选项,比如下面这个例子不采用 PSR-0:

<?php

$finder = Symfony\CS\Finder\DefaultFinder::create()
    ->exclude('somedir')
    ->in(__DIR__)
;

return Symfony\CS\Config\Config::create()
    ->fixers(['-psr0'])
    ->finder($finder)
;

默认条件下的格式化级别是 symfony (最严格),你可以修改这个级别:

<?php

return Symfony\CS\Config\Config::create()
    ->level(Symfony\CS\FixerInterface::PSR2_LEVEL)
;

通过这些设置选项的组合,可以很轻易的定制出自己想要的效果。

你也可以通过 --config-file 选项指定 .php_cs 文件的位置。

启用缓存可以在后续的执行中加快速度,通过以下方法设置:

<?php

return Symfony\CS\Config\Config::create()
    ->setUsingCache(true)
;

编辑器插件

下面这些编辑器/IDE 的插件可以帮你简化格式化的工作:

  • Atom

  • NetBeans

  • PhpStorm

  • Sublime Text

  • Vim

格式化选项

  • psr0 [PSR-0]
      PSR-0 的路径和命名空间标准

  • encoding [PSR-1]
      文件必须是不带 BOM 的 UTF-8 编码;

  • short_tag [PSR-1]
      只能使用 <?php ?><?= ?> 两种 PHP 代码标签;

  • braces [PSR-2]
      所有语句块都必须包含在花括号内,且位置以及缩进是符合标准的;

  • class_definition [PSR-2]
      class、trait、interfaces 关键字和名称之间只能有一个空格;

  • elseif [PSR-2]
      使用 elseif 替代 else if

  • eof_ending [PSR-2]
      文件必须以空白行结尾;

  • function_call_space [PSR-2]
      调用函数和方法时,函数名和方法名与参数扩展之间不能有空格;

  • function_declaration [PSR-2]
      函数声明时空格的使用需要符合 PSR-2;

  • indentation [PSR-2]
      代码必须使用四个空格缩进而不是制表符;

  • line_after_namespace [PSR-2]
      命名空间的声明后必须有一个空白行;

  • linefeed [PSR-2]
      所有 PHP 文件都只能使用 LF(Unix) 结尾;

  • lowercase_constants [PSR-2]
      PHP 常量 true、false 和 null 必须使用小写;

  • lowercase_keywords [PSR-2]
      PHP 关键字必须都是小写;

  • method_argument_space [PSR-2]
      方法声明及调用时,参数之间的逗号前不能有空格,逗号后必须有一个空格;

  • multiple_use [PSR-2]
      每个 use 只能声明一个元素;

  • parenthesis [PSR-2]
      圆括号内两侧不能有空格;

  • php_closing_tag [PSR-2]
      纯 PHP 文件必须省略 ?> 标签;

  • single_line_after_imports [PSR-2]
      每个 use 声明独立一行,且 use 语句块之后要有一个空白行;

  • trailing_spaces [PSR-2]
      删除非空行之后多余的空格;

  • visibility [PSR-2]
      每个属性和方法都必须指定作用域是 publicprotected 还是 privateabstractfinal 必须位于作用域关键字之前,static 必须位于作用域之后;

  • array_element_no_space_before_comma [symfony]
      数组声明中,逗号之前不能有空格;

  • array_element_white_space_after_comma [symfony]
      数组声明中,逗号之后必须有一个人空格;

  • blankline_after_open_tag [symfony]
      PHP 开始标签的同一行不能有代码,且下面必须有一个空白行;

  • concat_without_spaces [symfony]
      点连接符左右两边不能有多余的空格;

  • double_arrow_multiline_whitespaces [symfony]
    => 操作符两端不能有多个空白行;

  • duplicate_semicolon [symfony]
      删除重复的分号;

  • empty_return [symfony]
      return 语句如果没有任何返回的话直接写 return 即可(不用 return null);

  • extra_empty_lines [symfony]
      删除多余的空白行;

  • function_typehint_space [symfony]
      修正函数参数和类型提示之间的缺失的空格问题;

  • include [symfony]
    include 和文件路径之间需要有一个空格,文件路径不需要用括号括起来;

  • join_function [symfony]
      使用 join 替换 implode 函数;

  • list_commas [symfony]
      删除 list 语句中多余的逗号;

  • method_argument_default_value [symfony]
      函数参数中有默认值的参数不能位于无默认值的参数之前;

  • multiline_array_trailing_comma [symfony]
      多行数组最后一个元素应该也有一个逗号;

  • namespace_no_leading_whitespace [symfony]
      命名空间前面不应该有空格;

  • new_with_braces [symfony]
      使用 new 新建实例时后面都应该带上括号;

  • no_blank_lines_after_class_opening [symfony]
      类开始标签后不应该有空白行;

  • no_empty_lines_after_phpdocs [symfony]
      PHP 文档块开始开始元素下面不应该有空白行;

  • object_operator [symfony]
    T_OBJECT_OPERATOR (->) 两端不应有空格;

  • operators_spaces [symfony]
      二进制操作符两端至少有一个空格;

  • phpdoc_indent [symfony]
      phpdoc 应该保持缩进;

  • phpdoc_inline_tag [symfony]
      修正 phpdoc 内联标签格式,使标签与后续内容始终位于一行;

  • phpdoc_no_access [symfony]
    @access 不应该出现在 phpdoc 中;

  • phpdoc_no_empty_return [symfony]
    @return void@return null 不应该出现在 phpdoc 中;

  • phpdoc_no_package [symfony]
    @package@subpackage 不应该出现在 phpdoc 中;

  • phpdoc_params [symfony]
    @param, @throws, @return, @var, 和 @type 等 phpdoc 标签都要垂直对齐;

  • phpdoc_scalar [symfony]
      phpdoc 标量类型声明时应该使用 int 而不是 integerbool 而不是 booleanfloat 而不是 real 或者 double

  • phpdoc_separation [symfony]
      phpdoc 中注释相同的属性应该放在一起,不同的属性之间应该有一个空白行分割;

  • phpdoc_short_description [symfony]
      phpdoc 的简要描述应该以 .!? 结尾;

  • phpdoc_to_comment [symfony]
      文档块应该都是结构化的元素;

  • phpdoc_trim [symfony]
      除了文档块最开始的部分和最后的部分,phpdoc 开始和结束都应该是有内容的;

  • phpdoc_type_to_var [symfony]
    @type 需要使用 @var 代替;

  • phpdoc_types [symfony]
      phpdoc 中应该正确使用大小写;

  • phpdoc_var_without_name [symfony]
    @var@type 注释中不应该包含变量名;

  • pre_increment [symfony]
      不应该使用 ++i--i 的用法;

  • print_to_echo [symfony]
      如果可能的话,使用 echo 代替 print 语句;

  • remove_leading_slash_use [symfony]
      删除 use 前的空行;

  • remove_lines_between_uses [symfony]
      删除 use 语句块中的空行;

  • return [symfony]
    return 之前应该有一个空行;

  • self_accessor [symfony]
      在当前类中使用 self 代替类名;

  • short_bool_cast [symfony]
    bool 类型数据前不应该试用两个感叹号;

  • single_array_no_trailing_comma [symfony]
      PHP 单行数组最后一个元素后面不应该有空格;

  • single_blank_line_before_namespace [symfony]
      命名空间声明前应该有一个空白行;

  • single_quote [symfony]
      简单字符串应该使用单引号代替双引号;

  • spaces_after_semicolon [symfony]
      修复分号后面的空格;

  • spaces_before_semicolon [symfony]
      禁止只有单行空格和分号的写法;

  • spaces_cast [symfony]
      变量和修饰符之间应该有一个空格;

  • standardize_not_equal [symfony]
      使用 <> 代替 !=

  • ternary_spaces [symfony]
      三元运算符之间的空格标准化;

  • trim_array_spaces [symfony]
      数组需要格式化成和函数/方法参数类似,上下没有空白行;

  • unalign_double_arrow [symfony]
      不对其 =>

  • unalign_equals [symfony]
      不对其等号;

  • unary_operators_spaces [symfony]
      一元运算符和运算数需要相邻;

  • unneeded_control_parentheses [symfony]
      删除控制结构语句中多余的括号;

  • unused_use [symfony]
      删除没有用到的 use 语句;

  • whitespacy_lines [symfony]
      删除空白行中多余的空格;

除了以上这些选项以外,还有一些用户贡献的选项,这里就不再一一介绍了。

对于代码风格是否统一,执行什么样的标准,每个人、每个团队可能都有自己的看法。这里只是介绍一下这个工具,至于如何选用,还在于大家自己。如果是开源项目,你也可以试用一下 StyleCI。

推荐学习:《PHP视频教程

以上是这个php-cs-fixer编码格式化工具,你还不会用吗?的详细内容。更多信息请关注PHP中文网其他相关文章!

声明
本文转载于:segmentfault。如有侵权,请联系admin@php.cn删除
PHP和Python:解释了不同的范例PHP和Python:解释了不同的范例Apr 18, 2025 am 12:26 AM

PHP主要是过程式编程,但也支持面向对象编程(OOP);Python支持多种范式,包括OOP、函数式和过程式编程。PHP适合web开发,Python适用于多种应用,如数据分析和机器学习。

PHP和Python:深入了解他们的历史PHP和Python:深入了解他们的历史Apr 18, 2025 am 12:25 AM

PHP起源于1994年,由RasmusLerdorf开发,最初用于跟踪网站访问者,逐渐演变为服务器端脚本语言,广泛应用于网页开发。Python由GuidovanRossum于1980年代末开发,1991年首次发布,强调代码可读性和简洁性,适用于科学计算、数据分析等领域。

在PHP和Python之间进行选择:指南在PHP和Python之间进行选择:指南Apr 18, 2025 am 12:24 AM

PHP适合网页开发和快速原型开发,Python适用于数据科学和机器学习。1.PHP用于动态网页开发,语法简单,适合快速开发。2.Python语法简洁,适用于多领域,库生态系统强大。

PHP和框架:现代化语言PHP和框架:现代化语言Apr 18, 2025 am 12:14 AM

PHP在现代化进程中仍然重要,因为它支持大量网站和应用,并通过框架适应开发需求。1.PHP7提升了性能并引入了新功能。2.现代框架如Laravel、Symfony和CodeIgniter简化开发,提高代码质量。3.性能优化和最佳实践进一步提升应用效率。

PHP的影响:网络开发及以后PHP的影响:网络开发及以后Apr 18, 2025 am 12:10 AM

PHPhassignificantlyimpactedwebdevelopmentandextendsbeyondit.1)ItpowersmajorplatformslikeWordPressandexcelsindatabaseinteractions.2)PHP'sadaptabilityallowsittoscaleforlargeapplicationsusingframeworkslikeLaravel.3)Beyondweb,PHPisusedincommand-linescrip

PHP类型提示如何起作用,包括标量类型,返回类型,联合类型和无效类型?PHP类型提示如何起作用,包括标量类型,返回类型,联合类型和无效类型?Apr 17, 2025 am 12:25 AM

PHP类型提示提升代码质量和可读性。1)标量类型提示:自PHP7.0起,允许在函数参数中指定基本数据类型,如int、float等。2)返回类型提示:确保函数返回值类型的一致性。3)联合类型提示:自PHP8.0起,允许在函数参数或返回值中指定多个类型。4)可空类型提示:允许包含null值,处理可能返回空值的函数。

PHP如何处理对象克隆(克隆关键字)和__clone魔法方法?PHP如何处理对象克隆(克隆关键字)和__clone魔法方法?Apr 17, 2025 am 12:24 AM

PHP中使用clone关键字创建对象副本,并通过\_\_clone魔法方法定制克隆行为。1.使用clone关键字进行浅拷贝,克隆对象的属性但不克隆对象属性内的对象。2.通过\_\_clone方法可以深拷贝嵌套对象,避免浅拷贝问题。3.注意避免克隆中的循环引用和性能问题,优化克隆操作以提高效率。

PHP与Python:用例和应用程序PHP与Python:用例和应用程序Apr 17, 2025 am 12:23 AM

PHP适用于Web开发和内容管理系统,Python适合数据科学、机器学习和自动化脚本。1.PHP在构建快速、可扩展的网站和应用程序方面表现出色,常用于WordPress等CMS。2.Python在数据科学和机器学习领域表现卓越,拥有丰富的库如NumPy和TensorFlow。

See all articles

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

AI Hentai Generator

AI Hentai Generator

免费生成ai无尽的。

热门文章

R.E.P.O.能量晶体解释及其做什么(黄色晶体)
1 个月前By尊渡假赌尊渡假赌尊渡假赌
R.E.P.O.最佳图形设置
1 个月前By尊渡假赌尊渡假赌尊渡假赌
威尔R.E.P.O.有交叉游戏吗?
1 个月前By尊渡假赌尊渡假赌尊渡假赌

热工具

MinGW - 适用于 Windows 的极简 GNU

MinGW - 适用于 Windows 的极简 GNU

这个项目正在迁移到osdn.net/projects/mingw的过程中,你可以继续在那里关注我们。MinGW:GNU编译器集合(GCC)的本地Windows移植版本,可自由分发的导入库和用于构建本地Windows应用程序的头文件;包括对MSVC运行时的扩展,以支持C99功能。MinGW的所有软件都可以在64位Windows平台上运行。

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

WebStorm Mac版

WebStorm Mac版

好用的JavaScript开发工具

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

功能强大的PHP集成开发环境

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器