Update YAML filename matching pattern reference link #598
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
Several significant files use the YAML language, but not the standard `.yml` or `.yaml` file extensions. In order to provide full coverage, "yamllint" and the paths filter of the "Check YAML" workflow must be configured with the patterns for these files. A list of filename patterns for the YAML language is maintained in the "Linguist" project. Even though Linguist is not used by this infrastructure, the data from the Linguist source code serves as a reference from which the list of patterns was derived. In order to facilitate maintenance of the list of file patterns, comments were added to the yamllint configuration file and the "Check YAML" workflow providing a link to the reference. In the Linguist project, the data for all programming languages is stored in a single data file, which makes that file less useful as a reference for a specific language, as is needed here. The linguist-languages package is generated from the Linguist language data file, with a separate file for each language, so it serves as a more convenient reference. The linguist-languages package is automatically generated, and is used by Prettier, so it is likely to be actively maintained. For these reasons, previously that package was used in the reference link. However, during a recent review of the reference links it was found that it no longer worked. For this reason, it was replaced with a link to the less useful Linguist source code. I have now performed an investigation into the situation with the linguist-languages package and found the new location of the content. So it is now possible to go back to using this superior reference. Several factors have resulted in the reference URL being different than before: * Repository transferred to a new owner * Default branch renamed * Data format changed from JSON to JavaScript
per1234
added
type: enhancement
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.
Several significant files use the YAML language, but not the standard
.ymlor.yamlfile extensions. In order to provide full coverage, "yamllint" and the paths filter of the "Check YAML" workflow must be configured with the patterns for these files.A list of filename patterns for the YAML language is maintained in the "Linguist" project. Even though Linguist is not used by this infrastructure, the data from the Linguist source code serves as a reference from which the list of patterns was derived. In order to facilitate maintenance of the list of file patterns, comments were added to the yamllint configuration file and the "Check YAML" workflow providing a link to the reference.
In the Linguist project, the data for all programming languages is stored in a single data file, which makes that file less useful as a reference for a specific language, as is needed here.
The linguist-languages package is generated from the Linguist language data file, with a separate file for each language, so it serves as a more convenient reference. The linguist-languages package is automatically generated, and is used by Prettier, so it is likely to be actively maintained. For these reasons, previously that package was used in the reference link. However, during a recent review of the reference links it was found that it no longer worked. For this reason, it was replaced with a link to the less useful Linguist source code.
I have now performed an investigation into the situation with the linguist-languages package and found the new location of the content. So it is now possible to go back to using this superior reference. Several factors have resulted in the reference URL being different than before: