开始
最近在看 PHP 之道,看到 代码风格指南 章节的 PHP-cs-fixer。
PHP-cs-fixer 是能够自动帮你修证代码风格,不仅仅是格式化。
如果只需要代码保存时自动格式化的,PHPStorm 可以开启这个:
之前看别人发的项目,很多都是没有格式化的,至少以上 PHPStorm 保存时自动格式化也没有开启吧。
接下来开始讲下,开启保存自动 PHP-cs-fixer 修正代码的方法。
环境PHPStormPHP 8安装 PHP-cs-fixer这边使用全局安装
composer global require frIEndsofPHP/PHP-cs-fixer
参见 https://cs.symfony.com/doc/installation.HTML
在项目根路径下,新建文件:.PHP-cs-fixer.PHP,内容如下:
<?PHPuse PHPCsFixer\Config;use PHPCsFixer\Finder;$rules = [ '@PHP80Migration' => true, 'ordered_imports' => [ 'sort_algorithm' => 'Alpha', ], 'class_attributes_separation' => [ 'elements' => [ 'const' => 'one', 'method' => 'one', 'property' => 'one', ], ],];$finder = Finder::create() ->in([ __DIR__.'/app', __DIR__.'/config', __DIR__.'/database', __DIR__.'/resources', __DIR__.'/routes', __DIR__.'/tests', ]) ->name('*.PHP') ->notname('*.blade.PHP') ->ignoreDotfiles(true) ->ignoreVCS(true);return (new Config()) ->setFinder($finder) ->setRules($rules) ->setRiskyAllowed(true) ->setUsingCache(true);
然后在 PHPStorm 设置
名称:PHP-cs-fixer(自己喜欢的即可)文件类型:PHP程序:PHP-cs-fixer参数:fix $fileDir$/$filename$ -vvv –diff要刷新的输出路径:$fileDir$/$filename$工作目录:$ProjectfileDir$自动保存编辑的文件以触发观察程序:去掉默认的勾选显示控制台:改为始终讲下可能需要讲的
参数:这边使用了调试模式 -vvv,显示的东西比较多,后面觉得烦可以去掉–diff 能够显示修改了什么,见文章下的《开启控制台显示后》要刷新的输出路径:这个抄来的,目前效果还要验证自动保存编辑的文件以触发观察程序:就是说,只要我们输入什么,它自动保存,不需要 command + s 进行保存就可以触发 PHP-cs-fixer。个人比较习惯手动保存,请根据喜好进行设置。显示控制台:配合 –diff,显示修改了什么东西效果举例当我们进行保存时,它就会自动修正代码,在这里是修正为 PHP 7 以上的风格。
在控制台就显示以下:
开启控制台显示后/Users/dogeow/.composer/vendor/bin/PHP-cs-fixer fix /Users/dogeow/PHPstormProjects/antic-API/routes/console.PHP -vvv --diffCannot load XdeBUG - it was already loadedPHP CS Fixer 3.3.2 Trinacria by FabIEn PotencIEr and Dariusz RuminskiRuntime: PHP 8.0.8Loaded config default from "/Users/dogeow/PHPstormProjects/antic-API/.PHP-cs-fixer.PHP".Using cache file ".PHP-cs-fixer.cache".Paths from configuration file have been overrIDden by paths provIDed as command arguments.F 1 / 1 (100%)Legend: ?-unkNown, I-invalID file Syntax (file ignored), S-skipped (cached or empty file), .-no changes, F-fixed, E-error 1) routes/console.PHP (assign_null_coalescing_to_coalesce_equal) ---------- begin diff ------------- /Users/dogeow/PHPstormProjects/antic-API/routes/console.PHP+++ /Users/dogeow/PHPstormProjects/antic-API/routes/console.PHP@@ -90,5 +90,5 @@ }); Artisan::command('test', function () {- $taskTag['name'] = $taskTag['name'] ?? 'url';+ $taskTag['name'] ??= 'url'; }); ----------- end diff -----------Fixed all files in 0.024 seconds, 14.000 MB memory used进程已结束,退出代码为 0
当然也可以手动在命令行执行来批量修正整个app 目录。或者使用 git 的,提交前自动修正等。
推荐学习:《PHP视频教程》 总结
以上是内存溢出为你收集整理的php-cs-fixer大有用处!能自动修证代码风格~全部内容,希望文章能够帮你解决php-cs-fixer大有用处!能自动修证代码风格~所遇到的程序开发问题。
如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)