ctrl+shift+p filters: :st2 :st3 :win :osx :linux
浏览

PHP CS Fixer

adael 全部

使用你的文本编辑器运行php-cs-fixer代码格式化器来格式化PHP代码

标签 php, 格式化

详细信息

安装

  • 总数 28K
  • Win 14K
  • Mac 8K
  • Linux 6K
8月6日 8月5日 8月4日 8月3日 8月2日 8月1日 7月31日 7月30日 7月29日 7月28日 7月27日 7月26日 7月25日 7月24日 7月23日 7月22日 7月21日 7月20日 7月19日 7月18日 7月17日 7月16日 7月15日 7月14日 7月13日 7月12日 7月11日 7月10日 7月9日 7月8日 7月7日 7月6日 7月5日 7月4日 7月3日 7月2日 7月1日 6月30日 6月29日 6月28日 6月27日 6月26日 6月25日 6月24日 6月23日 6月22日
Windows 5 2 5 2 3 5 5 2 1 2 1 4 2 4 3 1 1 0 8 5 1 3 2 2 1 2 2 2 3 3 0 0 5 5 3 0 5 2 0 7 0 1 1 3 2 2
Mac 1 1 1 1 2 2 2 2 1 0 0 3 1 0 0 0 1 0 0 0 0 2 1 0 0 0 0 1 2 1 1 0 3 1 1 1 0 0 1 3 0 0 0 0 3 0
Linux 1 0 0 0 1 1 1 1 0 2 1 0 0 0 1 0 2 1 2 1 2 1 3 2 0 2 0 0 0 2 1 0 1 0 0 2 1 1 1 2 1 1 1 3 0 0

读我

源代码
raw.​githubusercontent.​com

Sublime PHP CS Fixer

这是Sublime Text ¾的一个插件,可以通dpah-cs-fixer命令在任意视图中格式化PHP代码。

特性

  • 它支持临时视图(即在新的、未保存的文件中)
  • 快速
  • 简单
  • 可通过规则或配置文件进行配置
  • 已在Windows和Linux上测试

配置

您必须安装实际的php-cs-fixer(由sensiolabs制作的实际工具,而非此插件)

您可以直接使用composer安装php-cs-fixer,运行

composer global require friendsofphp/php-cs-fixer

您还可以创建一个配置文件,如这里所述 https://github.com/FriendsOfPHP/PHP-CS-Fixer

例如: $HOME/.php-cs-fixer.php

<?php

return (new PhpCsFixer\Config)
    ->setRules([
        '@Symfony' => true,
        'array_syntax' => ['syntax' => 'short'],
    ]);

如果您已创建配置文件,您必须在插件设置中配置其路径。

在菜单 -> Preferences -> 包设置 -> PHP CS Fixer -> 设置 - 用户

{
    "config": "/path/to/.php-cs-fixer.php"
}

当使用具有不同配置的多个项目时,您可以根据Sublime项目文件夹的相对路径进行配置

{
    "config": "${folder}/.php-cs-fixer.php",
    "php": "${packages}/User/php",
    "path": "${packages}/User/php-cs-fixer.php"
}

您还可以指定多个配置路径。在这种情况下,使用第一个可读的文件

{
    "config": [
        "${file_path}/.php-cs-fixer.php",
        "${folder}/.php-cs-fixer.php",
        "/path/to/.php-cs-fixer.php"
    ]
}

有关支持的替换变量的信息,请参阅 extract_variables在Sublime API参考中。${folder}的值指向Sublime API的第一个项目的路径。在这里,它事先替换为目标文件所属项目的路径。

注意

  • _规则config 指令是排除的。
  • 此插件不会尝试自动查找配置文件。如果您想创建一个配置文件,您必须在插件设置中指定其路径。

规则

{
    "rules": {
        "@PhpCsFixer": true,
    },
    // or
    "rules": "@PhpCsFixer",
    // or
    "rules": [
        "@PhpCsFixer"
    ]
}

请注意,rulesconfig指令被排除。

更多信息见:https://github.com/FriendsOfPHP/PHP-CS-Fixer#usage

排除文件

由于所有php文件都直接传递给php-cs-fixer可执行文件,因此配置的 PhpCsFixer\Finder 被忽略。要从php-cs-fixer中排除文件,您可以使用“exclude”设置。

{
    "exclude": [
        ".*[\\\\/]vendor[\\\\/].*", // vendor-path (used by Composer)
        ".*\\.phtml$" // files ending with ".phtml"
    ]
}

排除过滤器使用Python正则表达式。更多信息见:https://docs.pythonlang.cn/2/library/re.html

在Windows上

插件会尝试在以下位置查找可执行文件:

%APPDATA%\composer\vendor\bin\php-cs-fixer.bat

如果不起作用,您可以通过运行以下命令查找您的composer全局包路径:

composer config -g home

在Linux上

安装php-cs-fixer后,您必须在配置页面上指定可执行文件的全路径。

插件会尝试在以下位置查找可执行文件:

$HOME/.composer/vendor/bin/php-cs-fixer

但是,如果不起作用,您可以创建到php-cs-fixer可执行文件的符号链接。

ln -s $HOME/.composer/vendor/bin/php-cs-fixer $HOME/bin/php-cs-fixer

注意

我已在Linux和Windows上检查过此内容,但无法在OSX上检查。如果有人告诉我在OSX上是否起作用,并给我一些关于如何配置的详细信息,我将不胜感激。

致谢

我想感谢sensiolabs和贡献者提供的出色包。它运行得非常完美。这里所有的工作都属于他们。

可以在以下位置查看它们:

我还从以下内容学习了部分Sublime包结构: