sspooky13/yaml-alphabetical-checker

YAML alphabetical checker

YAML alphabetical checker

, _(*1)

This repository is unmaintained and deprecated. I recommend yaml standards repository

This library helps you to keep YAML files alphabetically sorted., _(*2)

Requirements

Works with minimal requirement: - PHP 5.6 or higher - symfony/console version 3.0 - symfony/yaml version 3.0 - sebastian/diff version 1.4, _(*3)

Installation

If you prefer using Composer you can easily install with the following command:, _(*4)

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

Or alternatively, include a dependency for sspooky13/yaml-alphabetical-checker in your composer.json file. For example:, _(*5)

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

Options for run

• --exclude=text Exclude file contains the text in name. Can be used more times.

Usage

For run from command line:, _(*6)

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

If you need exclude a files from check, you can print command --exclude=NAME how much you want., _(*7)

or setting for ANT:, _(*8)

<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 Integration

You can integrate YAML alphabetical checker into PHPStorm by using File Watcher., _(*9)

1. Open Settings -> Tools -> File Watchers
2. Add new -> custom
3. Give it a name
4. Select file type: YAML
5. Program: \vendor\bin\yaml-alphabetical-checker.bat
6. Arguments: $FilePath$ for check actual opened file or $SourcepathEntry$ for check all source file, etc.

Now, file watcher check YAML files, whether is right alphabetically sorted and will open the console if they have errors, _(*10)

Exit codes

Exit code is built using following bit flags:, _(*11)

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