Prettier hooks

Using pre-commit with Prettier is a good way to provide automated linting to your YAML files. With pre-commit, you also get the benefit of only linting/fixing the files that changed.

This makes the formatting process more efficient and ensures consistent YAML styling across your project without unnecessarily processing unmodified files.

Pre-commit Hook · Prettier

prettier

What it does Automatically formats YAML files according to Prettier's style rules, ensuring consistent formatting across all YAML files in your project.

When to use it Use this hook when you want to maintain consistent YAML formatting across your project.

Arguments

• --write: Write changes directly to files

• --check: Check if files are formatted without modifying them

• --tab-width: Number of spaces per indentation level

• --use-tabs: Use tabs instead of spaces for indentation

• --prose-wrap: Control wrapping of prose (preserve, always, never)

Example

repos:
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v3.1.0
    hooks:
      - id: prettier
        types: [yaml]  # Only run on YAML files
        additional_dependencies:
          - [email protected]
        args: [--write]

Using rules in your .prettierrc file

To point pre-commit to use your custom .prettierrc rules file, you need to put the .prettierrc file in your repository root.

See also:

Prettier