chrisdbrown/yaml-standardiser

Yaml Standardiser

dev-master 2019-05-01 17:52 UTC

Requires

• php: ^7.1, <7.3
• symfony/console: ~3.4 || ~4.0
• symfony/finder: ~3.4 || ~4.0
• symfony/yaml: ~3.4 || ~4.0

Requires (Dev)

• consistence/coding-standard: ~2.0
• phpstan/phpstan: ^0.11.4
• phpunit/phpunit: ^7
• symfony/var-dumper: ~3.4 || ~4.0

GPL-3.0-only

README

Apply some basic standards to your yaml files

Add to your project with composer require --dev chrisdbrown/yaml-standardiser

Run with vendor/bin/yaml-standardiser file-to-edit.yaml file2.yaml

Passing a directory will analyse all files with .yml or .yaml extensions in that directory and any subdirectories

Currently implemented

• top level key alphabetisation on single file
• multi-file support

Todo

• prioritise certain keys in ordering
• multi-level key alphabetisation
• indentation
• spacing between key blocks
• object standards
• set config by file
• improved reporting
• human-readable diff generation
• patch file generation