Make module source urls clickable in Markdown output #571
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The main reason this was not already implemented, as outlined in terraform-docs#504 and linked discussions, was that modules sourced from git repositories, with urls like `[email protected]:...`, was rendered by Markdown as URL to an email address, if the url was just shown as `[.source](.source)`. The approach here is to detect if the module source starts with "git@", and, if so, replace that prefix with "https://", as well as replacing the first ":" with a "/". Signed-off-by: Tomas Aschan <[email protected]>
1c0ad4f to
ced2aed
Compare
Signed-off-by: Tomas Aschan <[email protected]>
c54f2a3 to
3dbb1a9
Compare
Signed-off-by: Tomas Aschan <[email protected]>
52bb210 to
cc9569e
Compare
AmirStha
pushed a commit
to AmirStha/terraform-docs
that referenced
this pull request
Jan 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main reason this was not already implemented, as outlined in #504 and linked discussions, was that modules sourced from git repositories, with urls like
[email protected]:..., was rendered by Markdown as URL to an email address, if the url was just shown as[.source](.source).The approach here is to detect if the module source starts with "git@", and, if so, replace that prefix with "https://", as well as replacing the first ":" with a "/".
Fixes #504.
I have:
make test.How has this code been tested
The change includes updates to test data, that show case the new behavior and ensure it stays correct.