mirror of
https://gh.wpcy.net/https://github.com/WordPress/WordPress-Coding-Standards.git
synced 2026-04-24 23:58:18 +08:00
e98fffac96
_Based on a similar workflow previously added to PHPCSUtils._ Remark offers a number of "rules" which are useful, such as checking that links and link definitions match up, verifying all used links work and some formatting checks. The rule configuration is contained in the .remarkrc file. Files/directories to be ignored can be listed in the .remarkignore file which supports glob syntax, like .gitignore. Note: .-prefixed files and directories are excluded by default. To include those in the scan, they have to be passed explicitly on the command-line. To run locally, follow the same steps as per the GitHub actions workflow. Note: the workflow contains a double-run of remark-lint to allow viewing the results both in a human readable way in the actions transscripts, as well as getting annotations for found issue in PRs. Refs: * https://github.com/remarkjs/remark/tree/main/packages/remark-cli * https://github.com/remarkjs/remark-lint * https://github.com/remarkjs/remark-gfm * https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-consistent * https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-recommended * https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-markdown-style-guide Additional (external) plugins included: * https://github.com/vhf/remark-lint-heading-whitespace * https://github.com/wemake-services/remark-lint-list-item-punctuation * https://github.com/laysent/remark-lint-plugins/tree/HEAD/packages/remark-lint-match-punctuation * https://github.com/olizilla/remark-lint-no-hr-after-heading * https://github.com/wemake-services/remark-lint-are-links-valid * https://github.com/remarkjs/remark-validate-links
36 lines
1.4 KiB
Text
36 lines
1.4 KiB
Text
{
|
|
"plugins": [
|
|
"remark-gfm",
|
|
["remark-lint-checkbox-character-style", "consistent"],
|
|
["remark-lint-checkbox-content-indent", "consistent"],
|
|
"remark-lint-definition-spacing",
|
|
"remark-lint-file-extension",
|
|
["remark-lint-linebreak-style", "unix"],
|
|
["remark-lint-link-title-style", "\""],
|
|
["remark-lint-ordered-list-marker-style", "."],
|
|
"remark-lint-no-duplicate-defined-urls",
|
|
"remark-lint-no-duplicate-definitions",
|
|
"remark-lint-no-empty-url",
|
|
"remark-lint-no-file-name-consecutive-dashes",
|
|
"remark-lint-no-file-name-irregular-characters",
|
|
"remark-lint-no-file-name-outer-dashes",
|
|
"remark-lint-no-heading-like-paragraph",
|
|
"remark-lint-no-literal-urls",
|
|
"remark-lint-no-reference-like-url",
|
|
"remark-lint-no-shortcut-reference-image",
|
|
"remark-lint-no-table-indentation",
|
|
"remark-lint-no-undefined-references",
|
|
"remark-lint-no-unneeded-full-reference-image",
|
|
"remark-lint-no-unneeded-full-reference-link",
|
|
"remark-lint-no-unused-definitions",
|
|
["remark-lint-strikethrough-marker", "~~"],
|
|
["remark-lint-table-cell-padding", "consistent"],
|
|
"remark-lint-heading-whitespace",
|
|
"remark-lint-list-item-punctuation",
|
|
"remark-lint-match-punctuation",
|
|
"remark-lint-no-hr-after-heading",
|
|
"remark-lint-are-links-valid-alive",
|
|
"remark-lint-are-links-valid-duplicate",
|
|
"remark-validate-links"
|
|
]
|
|
}
|
