README

此仓库未维护且已弃用。我推荐yaml standards 仓库

这个库可以帮助你保持YAML文件的字母顺序。

要求

最小要求

• PHP 5.6 或更高版本
• symfony/console 版本 3.0
• symfony/yaml 版本 3.0
• sebastian/diff 版本 1.4

安装

如果你更喜欢使用 Composer，你可以使用以下命令轻松安装：

composer require --dev sspooky13/yaml-alphabetical-checker

或者，在你的 composer.json 文件中包含 sspooky13/yaml-alphabetical-checker 的依赖项。例如

{
    "require-dev": {
        "sspooky13/yaml-alphabetical-checker": "~2.0"
    }
}

运行选项

• --exclude=text 排除包含 text 的文件名。可以使用多次。

用法

从命令行运行

./bin/yaml-alphabetical-checker ./app ./src/path/to/config/file.yml ./src --exclude=serv --exclude=conf

如果你需要排除要检查的文件，你可以打印命令 --exclude=NAME，数量不限。

或者为 ANT 设置

<property name="path.yaml-alphabetical-checker" value="./vendor/bin/yaml-alphabetical-checker"/>

<target name="yaml-alphabetical-checker" description="Run yaml alphabetical checker">
    <exec 
        executable="${path.yaml-alphabetical-checker}"
        logoutput="true"
        passthru="true"
        checkreturn="true"
    >
        <arg value="./app" />
        <arg value="./src/path/to/config/file.yml" />
        <arg value="./src" />
        <arg value="--exclude=serv" />
        <arg value="--exclude=conf" />
    </exec>
</target>

PHPStorm 集成

你可以通过使用文件监视器将 YAML 字母顺序检查器集成到 PHPStorm 中。

1. 打开设置 -> 工具 -> 文件监视器
2. 添加新监视器 -> 自定义
3. 给它起个名字
4. 选择文件类型：YAML
5. 程序：\vendor\bin\yaml-alphabetical-checker.bat
6. 参数：$FilePath$ 用于检查当前打开的文件，或 $SourcepathEntry$ 用于检查所有源文件等。

现在，文件监视器将检查 YAML 文件是否正确按字母顺序排序，如果存在错误将打开控制台

退出代码

退出代码是通过以下位标志构建的

0 OK.
1 Some file is unsorted.
2 General error (file is not readable, error with parse yaml file).