Remove Dockerfile_ file glob from Docker lexer #1550
Merged
Conversation
This file contains 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
|
@sethbergman As described in the OP, it was my mistake not to suggest using |
It's not a problem, we're already using a different format for Dockerfile anyway, so I have implemented the |
|
This change has now been merged into |
mattt
pushed a commit
to NSHipster/rouge
that referenced
this pull request
May 19, 2021
In addition to adding the `*.Dockerfile` file glob, rouge-ruby#1059 added a file glob for `Dockerfile_*` to address rouge-ruby#1070. However, as noted by rouge-ruby#1539, this causes issues for files that begin with `dockerfile_` but that are not Dockerfiles. Adding the `Dockerfile_*` file glob was an error and this commit removes it. It is a non-standard name and is not recognised by other syntax highlighting libraries (e.g. Pygments, Chroma, Linguist). The correct fix for the issue that precipitated rouge-ruby#1070 is to use a `.gitattributes` file.
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.
In addition to adding the
*.Dockerfilefile glob, #1059 added a file glob forDockerfile_*to address #1070. However, as noted by #1539, this causes issues for files that begin withdockerfile_but that are not Dockerfiles.While I am the one that merged #1059, I now believe it was a mistake to add the
Dockerfile_*file glob and it should be removed. This is a non-standard name and is not recognised by other lexing libraries (see Pygments, Chroma, Linguist). I was not aware of this feature at the time but the correct fix for the issue that precipitated #1070 is to use a.gitattributesfile as explained here.While this is technically a breaking change and should wait for the Rouge 4.0 release, I think it makes sense to characterise it as a bug that can be fixed as part of the next release of Rouge 3.0.
This fixes #1539.