ATOM基础教程一php-cs-fixer配置(13)

本文是ATOM基础教程的一部分,介绍了php-cs-fixer插件的配置和使用。php-cs-fixer用于自动规范化PHP代码,遵循PSR编码规范,提高代码可读性和团队协作效率。文中详细讲解了PSR规范、php-cs-fixer的安装、配置以及使用中可能出现的警告处理。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

php-cs-fixer简介

php-cs-fixer是自动规范化php代码插件,良好的代码规范可以提高代码可读性,减少团队沟通维护成本,推荐大家遵守的php代码规范是php-fig(PHP Framework Interop Group)组织定义的PSR-1PSR-2

php代码规范PSR简介

Framework Interoperability Group(框架可互用性小组),简称 FIG,FIG 提出了 PSR-0 到 PSR-4 五套 PHP 非官方规范:

  1. PSR-0 (Autoloading Standard) 自动加载标准
  2. PSR-1 (Basic Coding Standard) 基础编码标准
  3. PSR-2 (Coding Style Guide) 编码风格向导
  4. PSR-3 (Logger Interface) 日志接口
  5. PSR-4 (Improved Autoloading) 自动加载优化标准

php-cs-fixer配置

  1. 安装依赖php-cs-fixer.phar文件(需要翻墙):
    这里写图片描述
    详细安装可以去PHP-CS-Fixer官网查看,推荐以下三种安装方式:
 1、wget https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/download/v1.11.5/php-cs-fixer.phar -O php-cs-fixer
 2、curl -L https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/download/v1.11.5/php-cs-fixer.phar -o php-cs-fixer
 3./composer.phar global require fabpot/php-cs-fixer(需安装composer)

分享我下载的php-cs-fixer

将下载好的php-cs-fixer的路径粘贴到配置项处即可
这里写图片描述
2、配置php代码所遵循的代码规范,我选择的是常用的psr2
这里写图片描述
3、配置代码规范检查执行效率检查(不建议勾选)
这里写图片描述
4、配置格式化选项(Fixers)

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]//每个属性和方法都必须指定作用域是 public、protected 还是 private,abstract 和 final 必须位于作用域关键字之前,static 必须位于作用域之后

我的配置如下:
这里写图片描述

php-cs-fixer使用演示

这里写图片描述

php-cs-fixer执行时弹出的警告框

内容如下:
You are running php-cs-fixer with xdebug enabled. This has a major impact on runtime performance
这个抛出的警告是说:当php.ini开启了debug模式时php-cs-fixer执行速度会变慢。这个其实并不影响php-cs-fixer的使用,实际执行速度是可以接受的,如果想关闭这个警告弹窗,可以关闭php.ini文件的debug模式(不推荐)
这里写图片描述
PS:如果你的php代码实际上是运行在虚拟机上的,完全可以关闭本机安装的php的配置文件php.ini的debug模式。
关闭debug模式后演示如下:
这里写图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值