Editor Integration

For a smoother experience, you can run yamlfix automatically each time each time you save your file in your editor or when you run git commit.

Vim¶

To integrate yamlfix into Vim, I recommend using the ale plugin.

ale is configured to run yamlfix automatically by default.

pre-commit¶

You can run yamlfix before we do a commit using the pre-commit framework. If you don't know how to use it, follow these guidelines.

You'll need to add the following lines to your project's .pre-commit-config.yaml file.

repos:
  - repo: https://github.com/lyz-code/yamlfix/
    rev: main
    hooks:
      - id: yamlfix