Download the PHP package mhujer/yaml-sort-checker without Composer

On this page you can find all versions of the php package mhujer/yaml-sort-checker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package yaml-sort-checker

YAML file sort checker Build Status

Latest Stable Version Total Downloads License

This library helps you to keep YAML file sorted to prevent unnecessary merge conflicts.

Check out the article I've written about the tool: Keep your YAML files sorted with YAML sort checker

Typical example is when two developers register a new service in services.yml. If they both add it to the end, it unevitably will lead to a merge conflict. However, when the services are alphabetically sorted, the probability of merge conflict is much lower (because the added services probably won't clash).

Usage

  1. Install the latest version with composer require --dev mhujer/yaml-sort-checker
  2. Create a configuration file yaml-sort-checker.yml in project root with list of the files for checking, see the example configuration for Symfony app.
  3. Run vendor/bin/yaml-sort-checker (depends on where you have your Composer bin directory)
  4. Exclude the yaml keys (or even whole sections) you don't want to sort - e.g. it makes more sense to have them unsorted (see the example configuration)

PHPStorm Integration

Until WI-35271 is resolved, YAML sort checker can be integrated into PHPStorm by using File Watcher feature.

  1. Open Settings -> Tools -> File Watchers
  2. Add new
  3. File type: YAML
  4. Program: PATH_TO_YOUR_PROJECT\vendor\bin\yaml-sort-checker.bat
  5. Open Other Options and enter: $ProjectFileDir$ to Working directory
  6. Now, when you are editing YAML files, it will run the checker on every file save and will open the console if there are errors

Requirements

Works with PHP 7.2 or higher and Symfony 3.4 or higher.

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub

Author

Martin Hujer

Changelog

See CHANGELOG.md for latest changes.

All versions of yaml-sort-checker with dependencies

PHP Build Version
Package Version
Requires php Version ~7.3 | ^8.0
symfony/console Version ~3.4|~4.3|~5.0
symfony/yaml Version ~3.4|~4.3|~5.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mhujer/yaml-sort-checker contains the following files

Loading the files please wait ....