README.md

Pre-Commit Hook: Convert indents (from spaces) to tabs

Usage

This project is intended to be used via pre-commit and the .pre-commit-config.yaml file.

The code below demonstrates a minimal configuration for usage in .pre-commit-config.yaml.

- repo: https://github.com/jambonrose/pre-commit-indents-to-tabs
  rev: v0.0.1
  hooks:
      - id: indents-to-tabs

The configuration below will run the terraform fmt -write command before replacing spaces with tabs in the indents of Terraform files. The configuration below also demonstrats the use of the --spaces flag, although it is technically redundant as 2 is the default.

- repo: https://github.com/jambonrose/pre-commit-indents-to-tabs
  rev: v0.0.1
  hooks:
      - id: indents-to-tabs
        args: ["--fmt=terraform,fmt,-write", "--spaces=2"]
        types: ["terraform"]

Project Rationale

I created this project as a reaction to the Terraform autoformatter. However, the project can be used in other circumstances.

Autoformatters are great. However, Terraform's fmt command indents code using two-spaces. I have a mild visual impairment, and a two-space indent is difficult for me.

I want to benefit from all of the other work the autoformatter is doing for me, and I simply want to replace the space indents with tabs. I don't want to create my own autoformatter. This pre-commit hook is meant to be run after the autoformatter to achieve these goals.

Philosophically speaking: Tabs are for indents. Spaces are for alignment. Tabs allow people to set their own preference, a necessity for those with different needs.

I hope this helps others with eye issues.