Skip to content

Normalize variables with CRLF line ending in heredoc #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 13, 2020
Merged

Normalize variables with CRLF line ending in heredoc #307

merged 1 commit into from
Aug 13, 2020

Conversation

khos2ow
Copy link
Member

@khos2ow khos2ow commented Aug 13, 2020 •
edited
Loading

Prerequisites

Put an x into the box(es) that apply:

  • This pull request fixes a bug.
  • This pull request adds a feature.
  • This pull request enhances existing functionality.
  • This pull request introduces breaking change.

For more information, see the Contributing Guide.

Description

This PR normalizes input variables which has CRLF as line ending in multi-line heredoc style description. It will convert them internally to LF early on and continue parsing and rendering them as usual.

Issues Resolved

Fixes #305

Checklist

Put an x into all boxes that apply:

Tests

  • I have added tests to cover my changes.
  • All tests pass when I run make test.

Documentation

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Code Style

  • My code follows the code style of this project.

@khos2ow khos2ow added this to the v0.10.0 milestone Aug 13, 2020
@codecov
Copy link

codecov bot commented Aug 13, 2020 •
edited
Loading

Codecov Report

Merging #307 into master will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #307   +/-   ##
=======================================
  Coverage   74.61%   74.61%           
=======================================
  Files          39       39           
  Lines        2139     2139           
=======================================
  Hits         1596     1596           
  Misses        487      487           
  Partials       56       56
Impacted Files Coverage Δ
internal/module/module.go 90.94% <100.00%> (ø)

@khos2ow khos2ow merged commit 9729ec8 into terraform-docs:master Aug 13, 2020
@khos2ow khos2ow deleted the fix-crlf branch August 13, 2020 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
bug format/asciidoc/table format/markdown/table section/inputs
Projects
None yet
Milestone
v0.10.0
Development

Successfully merging this pull request may close these issues.

Using heredoc with CRLF encoding breaks markdown output
1 participant
@khos2ow