sspooky13/yaml-standards

Standards for yaml files

5.1.2 2020-02-02 08:58 UTC

README

Total Downloads Build Status Codacy Badge Scrutinizer Code Quality Code Coverage Quality Gate Status PHPStan level

This library is primarily intended to help you to keep observe standards for YAML files, but some standards can be used for other files, e.g. YamlEmptyLineAtEnd standard

Installation

Install the latest version with Composer command:

composer require --dev sspooky13/yaml-standards

Usage

  1. Create config file in project root directory with allowed standards and files/directories to check. You can copy config file ./example/yaml-standards.yml and edit it according to your needs.
  2. Run vendor/bin/yaml-standards

Tips:

  • If your config file has different name or it's located in different directory as root you can run command with argument where is wried path to config file with name, e.g. vendor/bin/yaml-standards ./path/to/your/configFile.yaml
  • You can create target for Phing build tool, e.g.
<property name="path.yaml-standards" value="./vendor/bin/yaml-standards"/>

<target name="check-yaml-standards" description="Run yaml standards checks">
    <exec
        executable="${path.yaml-standards}"
        logoutput="true"
        passthru="true"
        checkreturn="true"
    >
        <arg value="./path/to/your/configFile.yaml" />
    </exec>
</target>

Options for run

  • ./path/to/your/configFile.yaml Path to your config file. Default is ./yaml-standards.yaml.
  • --fix Automatically fix allowed standards problems.

Implemented checkers

  • YamlAlphabeticalChecker - Check yaml file is alphabetically sorted to selected level.
  • YamlIndentChecker - Check yaml has right count of indents. This checker has fixer.
  • YamlSpacesBetweenGroupsChecker - Check yaml file has empty line between every group to selected level. This checker has fixer.
  • YamlInlineChecker - Check yaml file observe standards by symfony yaml parser.
  • YamlEmptyLineAtEnd - Check yaml file has empty line at end of file. This checker has fixer. Note: This standard can be used on every file, not only yaml files.
  • YamlServiceAliasing - Check yaml service file observe short or long code style aliasing. This checker has fixer.

PHPStorm Integration

You can integrate YAML standards into PHPStorm by using File Watcher.

  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-standards.bat
  6. Arguments: absolute path to your config file
  7. In config file path to check and excluded paths must have absolute path too

Now, file watcher check your YAML files by config file and notify you if they have errors

How create your own standards

  1. Create class with your own check/fix logic
  2. Checker has to extend class YamlStandards\Model\AbstractChecker.php and class name have to end with Checker word, e.g. YamlLineChecker
  3. Fixer has to be in same directory as checker class, extend class YamlStandards\Model\AbstractFixer.php and name have to be same as checker class except name must end with Fixer word, e.g. YamlLineFixer. Warning! checker class must exist too.
  4. Both classes must return class \YamlStandards\Result\Result
  5. Add your checker class with namespace to your config file to checkers array
  6. done :)

If you think your checker/fixer can be helpful for others, you can create pull request with your code to make it available to everyone :)

Exit codes

Exit code is built using following bit flags:

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