Skip to content

Optional CRLF line endings #722

@timothy-mcroy

Description

@timothy-mcroy

What problem are you facing?

terraform-docs always generates LF endings. When running terraform-docs --output-check when a README was downloaded from a VCS with CRLF line endings, this output check fails. This means that any post commit checks that run with CRLF checkouts cannot properly verify the output with --output-check, because the line endings are inconsistent with what terraform-docs is hardcoded to produce.

We are using terraform-docs on windows in a situation where having the files checked out with CRLF is preferable. We're configuring windows systems and that consistency in tooling is preferable over using linux runners for this one aspect of our tech stack.

How could terraform-docs help solve your problem?

Add a flag to use CRLF line endings in the output README. This will allow anyone facing as similar problem to specify the expected line endings for any VCS.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions