Skip to content

Commit

Permalink
fix(ci): Reuse markdownlint config files for 'files' and 'docs' hiera… (
Browse files Browse the repository at this point in the history 
#15106)

* fix(ci): Reuse markdownlint config files for 'files' and 'docs' hierarchies

* Fix a Prettier  issue
  • Loading branch information
@OnkarRuikar
OnkarRuikar authored Aug 15, 2023
1 parent 8fe7231 commit 13d2ced
Show file tree
Hide file tree
Showing 9 changed files with 402 additions and 397 deletions.
226 changes: 1 addition & 225 deletions .markdownlint-cli2.jsonc
View file
Original file line number Diff line number Diff line change
@@ -1,230 +1,6 @@
// This file defines our configuration for Markdownlint. See
// https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
// for more details on each rule.

{
"config": {
"default": true,
// Disabled, as some callouts include headings.
"header-increment": false,
"ul-style": {
"style": "dash"
},
"ul-indent": {
"indent": 2
},
"no-hard-tabs": {
"spaces_per_tab": 2
},
"line-length": false,
"no-duplicate-header": false,
// XXX Replace with the following when ready:
// "no-duplicate-header": {
// "allow_different_nesting": true
// },
"single-title": {
"front_matter_title": "^\\s*title\\s*[:=]"
},
"no-trailing-punctuation": {
"punctuation": ".,;:"
},
// Consecutive Notes/Callouts currently don't conform with this rule
"no-blanks-blockquote": false,
// Force ordered numbering to catch accidental list ending from indenting
"ol-prefix": {
"style": "ordered"
},
"no-inline-html": {
"allowed_elements": [
"a",
"abbr",
"annotation",
"br",
"caption",
"code",
"col",
"colgroup",
"dd",
"details",
"div",
"dl",
"dt",
"em",
"h4",
"h5",
"img",
"kbd",
"li",
"math",
"menclose",
"mfenced",
"mfrac",
"mfrac",
"mi",
"mmultiscripts",
"mn",
"mo",
"mover",
"mphantom",
"mprescripts",
"mroot",
"mrow",
"ms",
"mspace",
"mspace",
"msqrt",
"mstyle",
"msub",
"msubsup",
"msup",
"mtable",
"mtd",
"mtext",
"mtr",
"munder",
"munderover",
"none",
"ol",
"p",
"pre",
"q",
"section",
"semantics",
"strong",
"sub",
"summary",
"sup",
"table",
"tbody",
"td",
"tfoot",
"th",
"thead",
"tr",
"ul",
"var",
"dfn", // XXX Still used in some translated content
"ruby", // Used in some Korean documents
"rp", // Used in some Korean documents
"rt", // Used in some Korean documents
"i", // French translations use this for English literal text
"h2", // XXX Not always converted currently because of live samples using English IDs
"h3", // XXX Not always converted currently because of live samples using English IDs
"h6" // XXX Not always converted currently because of live samples using English IDs
]
},
"no-bare-urls": false,
// XXX Fixed upstream, remove next line when fixed here
"no-emphasis-as-header": false,
// Produces too many false positives
"no-space-in-emphasis": false,
"fenced-code-language": false,
// See https://github.com/mdn/content/pull/20026, as macros currently break this
"no-empty-links": false,
// XXX Fixed upstream, remove next line when fixed here
"no-alt-text": false,
"code-block-style": {
"style": "fenced"
},
"emphasis-style": false,
// XXX Replace with the following when ready:
// "emphasis-style": {
// "style": "underscore"
// },
"strong-style": {
"style": "asterisk"
},
// Disabled, as yari generates link fragments by replacing spaces with underscores, not dashes.
"link-fragments": false,
// XXX Fixed upstream, remove next line when fixed here
"reference-links-images": false,

// https://github.com/OnkarRuikar/markdownlint-rule-search-replace
"search-replace": {
"rules": [
// XXX Many instances still found in translated content
// {
// // Does not apply to zh-cn
// "name": "curly-double-quotes",
// "message": "Don't use curly double quotes",
// "searchPattern": "/“|”/g",
// "replace": "\"",
// "searchScope": "text"
// },
// {
// // Does not apply to zh-cn
// "name": "curly-single-quotes",
// "message": "Don't use curly single quotes",
// "searchPattern": "/‘|’/g",
// "replace": "'",
// "searchScope": "text"
// },
{
"name": "nbsp",
"message": "Don't use no-break spaces",
"searchPattern": "/ /g",
"replace": " ",
"searchScope": "all"
},
{
// zh-cn/zh-tw prefers double em-dash instead
"name": "em-dash",
"message": "Don't use '--'. Use em-dash (—) instead",
"search": " -- ",
"replace": " — ",
"searchScope": "text"
},
{
"name": "relative-link",
"message": "Internal links should start with '/'",
"searchPattern": "/([\\(\"])([\\w\\-]+)\\/docs/g",
"replace": "$1/$2/docs",
"searchScope": "text"
},
{
"name": "relative-link-path",
"message": "Don't use relative paths",
"search": "](..",
"searchScope": "text"
},
{
"name": "trailing-spaces",
"message": "Avoid trailing spaces",
"searchPattern": "/ +$/gm",
"replace": "",
"searchScope": "all"
},
{
"name": "double-spaces",
"message": "Avoid double spaces",
"searchPattern": "/([^\\s>]) ([^\\s|])/g",
"replace": "$1 $2",
"searchScope": "text"
},
{
"name": "stuck-definition",
"message": "Character is stuck to definition description marker",
"searchPattern": "/- :(\\w)/g",
"replace": "- : $1",
"searchScope": "text"
},
{
"name": "fqdn-moz-links",
"message": "Don't use developer.mozilla.org for links, except for blog posts",
"searchPattern": "/\\]\\(https:\\/\\/developer.mozilla.org\\/(?!en-US\\/blog\\/)/g",
"replace": "](/",
"searchScope": "text"
}
// XXX Many instances still found in translated content
// {
// "name": "localhost-links",
// "message": "Don't use localhost for links",
// "searchPattern": "/\\]\\(https?:\\/\\/localhost:\\d+\\//g",
// "replace": "](/",
// "searchScope": "text"
// }
]
}
"extends": "./.markdownlint.jsonc"
},
"customRules": ["markdownlint-rule-search-replace"],
"ignores": [
Expand Down
Loading

0 comments on commit 13d2ced

Please sign in to comment.