Markdownlint: Add custom rule "Use full language name for fenced code blocks" #27723
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.
Because
#27720 will have the layout style guide specify that any code block with languages set must use the full language name if there is both a full and abbreviated form that work. For example, using
javascript
instead ofjs
, even ifjs
will work fine.There is no built-in rule for this, other than an array of languages to accept, which is much clunkier than an option to exclude specific languages.
Therefore, it would be better to write a custom rule that detects abbreviated languages for those we might expect to see in our lesson files (
rb
,js
,md
,txt
) and flags, advising the use of the respective full name instead (ruby
,javascript
,markdown
,text
).Languages like
html
andcss
, which do not have a valid full name option (and would be hell to type anyway), are exempt from this rule.This PR
Issue
Closes #27721
Additional Information
N/A
Pull Request Requirements
location of change: brief description of change
format, e.g.Intro to HTML and CSS lesson: Fix link text
Because
section summarizes the reason for this PRThis PR
section has a bullet point list describing the changes in this PRIssue
section