Add support to print Markdown files with underscored variable names escaped (#48)

[sjauld]

Note: this will cause a conflict with #43 but I'll rebase whichever one needs it...

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 introduces breaking change.

For more information, see the Contributing Guide.

Description

Adds a flag to escape underscored variables / outputs when printing markdown.

Issues Resolved

#48

Checklist

Put an x into all boxes that apply:

• I have read the Contributing Guidelines.

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.

[metmajer]

Hi @sjauld and thanks for another valuable contribution! There are some things we should adjust, and I'll get back to you with feedback very soon!

[metmajer]

@sjauld can you please do a git merge on your branch so that we can start the review. Let me know if you need help.

[sjauld]

Yes, I'll rebase today.

[sjauld]

Should be good to go now!

[metmajer]

Thanks, @sjauld. Here's some feedback, let's discuss!

1. You've created an option --escape-underscores, but should we really design proper escaping as a feature? Here's how I see this: if a user creates a variable with a _, he or she doesn't want it to show up as format change in the output, but as what it is. Hence, I strongly suggest you remove the option again and treat this as a bug fix.
2. In your variables.tf and your tests, please rename the variable from string_number_3 to input_with_underscores to reflect it's purpose. Also, please make sure to keep the variable names in these files in the intended order (we do follow an ascending or descending sort order depending on the use-case). This is intended to help upcoming contributions and generally, make insertions easier and the look more consistent.

As a result of these changes...

• escapeUnderscoresIfSet can be removed and its call can be replaced with the call to strings.Replace
• markdown-WithEscapedUnderscores.golden can be removed, as input_with_underscores will already be tested in all other .golden files, since we're creating a fix, not an optional feature.

Overall, this would greatly simplify things. Cheers!

[sjauld]

@metmajer this approach seems sensible, I'll try to close out today.

[metmajer]

No worries, @sjauld, we all have other things to do. Thanks for staying at it 👍

[sjauld]

Ok should be good to go now!