2 "name": "coc-markdownlint",
4 "description": "Markdownlint extension for coc.nvim",
5 "author": "Heyward Fann <fannheyward@gmail.com>",
7 "main": "lib/index.js",
15 "clean": "rimraf lib",
16 "lint": "eslint src --ext ts",
17 "schema": "node generate-config-schema.js",
18 "build": "node esbuild.js",
19 "prepare": "node esbuild.js"
23 "url": "https://github.com/fannheyward/coc-markdownlint.git"
26 "@types/deep-extend": "^0.4.31",
27 "@types/js-yaml": "^3.12.5",
28 "@types/node": "10.12.0",
29 "@types/rc": "^1.1.0",
30 "@typescript-eslint/eslint-plugin": "^4.3.0",
31 "@typescript-eslint/parser": "^4.3.0",
32 "coc.nvim": "^0.0.81-next.2",
33 "deep-extend": "^0.6.0",
37 "markdownlint": "^0.23.1",
38 "markdownlint-rule-helpers": "^0.14.0",
41 "typescript": "^4.0.2"
44 "onLanguage:markdown",
45 "onCommand:markdownlint.fixLine"
50 "fileMatch": ".markdownlint.json",
51 "url": "./schemas/markdownlint-config-schema.json"
56 "language": "markdown",
57 "path": "./snippets/snippets.json"
62 "title": "coc-markdownlint configuration",
64 "markdownlint.onOpen": {
67 "description": "Lint on open a file"
69 "markdownlint.onSave": {
72 "description": "Lint on saving a file"
74 "markdownlint.onChange": {
77 "description": "Lint on changing a file"
79 "markdownlint.config": {
82 "description": "Default state for all rules",
87 "description": "Path to configuration file to extend",
95 "description": "JSON Schema URI (used by some editors)",
97 "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json"
100 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
104 "heading-increment": {
105 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
109 "header-increment": {
110 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
115 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
123 "description": "Heading level",
128 "additionalProperties": false
130 "first-heading-h1": {
131 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
139 "description": "Heading level",
144 "additionalProperties": false
147 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
155 "description": "Heading level",
160 "additionalProperties": false
163 "description": "MD003/heading-style/header-style - Heading style",
171 "description": "Heading style",
179 "setext_with_atx_closed"
181 "default": "consistent"
184 "additionalProperties": false
187 "description": "MD003/heading-style/header-style - Heading style",
195 "description": "Heading style",
203 "setext_with_atx_closed"
205 "default": "consistent"
208 "additionalProperties": false
211 "description": "MD003/heading-style/header-style - Heading style",
219 "description": "Heading style",
227 "setext_with_atx_closed"
229 "default": "consistent"
232 "additionalProperties": false
235 "description": "MD004/ul-style - Unordered list style",
243 "description": "List style",
252 "default": "consistent"
255 "additionalProperties": false
258 "description": "MD004/ul-style - Unordered list style",
266 "description": "List style",
275 "default": "consistent"
278 "additionalProperties": false
281 "description": "MD005/list-indent - Inconsistent indentation for list items at the same level",
286 "description": "MD005/list-indent - Inconsistent indentation for list items at the same level",
291 "description": "MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line",
296 "description": "MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line",
301 "description": "MD007/ul-indent - Unordered list indentation",
309 "description": "Spaces for indent",
314 "description": "Whether to indent the first level of the list",
319 "additionalProperties": false
322 "description": "MD007/ul-indent - Unordered list indentation",
330 "description": "Spaces for indent",
335 "description": "Whether to indent the first level of the list",
340 "additionalProperties": false
343 "description": "MD009/no-trailing-spaces - Trailing spaces",
351 "description": "Spaces for line break",
355 "list_item_empty_lines": {
356 "description": "Allow spaces for empty lines in list items",
361 "description": "Include unnecessary breaks",
366 "additionalProperties": false
368 "no-trailing-spaces": {
369 "description": "MD009/no-trailing-spaces - Trailing spaces",
377 "description": "Spaces for line break",
381 "list_item_empty_lines": {
382 "description": "Allow spaces for empty lines in list items",
387 "description": "Include unnecessary breaks",
392 "additionalProperties": false
395 "description": "MD010/no-hard-tabs - Hard tabs",
403 "description": "Include code blocks",
408 "additionalProperties": false
411 "description": "MD010/no-hard-tabs - Hard tabs",
419 "description": "Include code blocks",
424 "additionalProperties": false
427 "description": "MD011/no-reversed-links - Reversed link syntax",
431 "no-reversed-links": {
432 "description": "MD011/no-reversed-links - Reversed link syntax",
437 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
445 "description": "Consecutive blank lines",
450 "additionalProperties": false
452 "no-multiple-blanks": {
453 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
461 "description": "Consecutive blank lines",
466 "additionalProperties": false
469 "description": "MD013/line-length - Line length",
477 "description": "Number of characters",
481 "heading_line_length": {
482 "description": "Number of characters for headings",
486 "code_block_line_length": {
487 "description": "Number of characters for code blocks",
492 "description": "Include code blocks",
497 "description": "Include tables",
502 "description": "Include headings",
507 "description": "Include headings",
512 "description": "Strict length checking",
517 "description": "Stern length checking",
522 "additionalProperties": false
525 "description": "MD013/line-length - Line length",
533 "description": "Number of characters",
537 "heading_line_length": {
538 "description": "Number of characters for headings",
542 "code_block_line_length": {
543 "description": "Number of characters for code blocks",
548 "description": "Include code blocks",
553 "description": "Include tables",
558 "description": "Include headings",
563 "description": "Include headings",
568 "description": "Strict length checking",
573 "description": "Stern length checking",
578 "additionalProperties": false
581 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
585 "commands-show-output": {
586 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
591 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
595 "no-missing-space-atx": {
596 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
601 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
605 "no-multiple-space-atx": {
606 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
611 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
615 "no-missing-space-closed-atx": {
616 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
621 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
625 "no-multiple-space-closed-atx": {
626 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
631 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
639 "description": "Blank lines above heading",
644 "description": "Blank lines below heading",
649 "additionalProperties": false
651 "blanks-around-headings": {
652 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
660 "description": "Blank lines above heading",
665 "description": "Blank lines below heading",
670 "additionalProperties": false
672 "blanks-around-headers": {
673 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
681 "description": "Blank lines above heading",
686 "description": "Blank lines below heading",
691 "additionalProperties": false
694 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
698 "heading-start-left": {
699 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
703 "header-start-left": {
704 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
709 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
716 "allow_different_nesting": {
717 "description": "Only check sibling headings",
722 "description": "Only check sibling headings",
727 "additionalProperties": false
729 "no-duplicate-heading": {
730 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
737 "allow_different_nesting": {
738 "description": "Only check sibling headings",
743 "description": "Only check sibling headings",
748 "additionalProperties": false
750 "no-duplicate-header": {
751 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
758 "allow_different_nesting": {
759 "description": "Only check sibling headings",
764 "description": "Only check sibling headings",
769 "additionalProperties": false
772 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
780 "description": "Heading level",
784 "front_matter_title": {
785 "description": "RegExp for matching title in front matter",
787 "default": "^\\s*title\\s*[:=]"
790 "additionalProperties": false
793 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
801 "description": "Heading level",
805 "front_matter_title": {
806 "description": "RegExp for matching title in front matter",
808 "default": "^\\s*title\\s*[:=]"
811 "additionalProperties": false
814 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
822 "description": "Heading level",
826 "front_matter_title": {
827 "description": "RegExp for matching title in front matter",
829 "default": "^\\s*title\\s*[:=]"
832 "additionalProperties": false
835 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
843 "description": "Punctuation characters",
845 "default": ".,;:!。,;:!"
848 "additionalProperties": false
850 "no-trailing-punctuation": {
851 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
859 "description": "Punctuation characters",
861 "default": ".,;:!。,;:!"
864 "additionalProperties": false
867 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
871 "no-multiple-space-blockquote": {
872 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
877 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
881 "no-blanks-blockquote": {
882 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
887 "description": "MD029/ol-prefix - Ordered list item prefix",
895 "description": "List style",
903 "default": "one_or_ordered"
906 "additionalProperties": false
909 "description": "MD029/ol-prefix - Ordered list item prefix",
917 "description": "List style",
925 "default": "one_or_ordered"
928 "additionalProperties": false
931 "description": "MD030/list-marker-space - Spaces after list markers",
939 "description": "Spaces for single-line unordered list items",
944 "description": "Spaces for single-line ordered list items",
949 "description": "Spaces for multi-line unordered list items",
954 "description": "Spaces for multi-line ordered list items",
959 "additionalProperties": false
961 "list-marker-space": {
962 "description": "MD030/list-marker-space - Spaces after list markers",
970 "description": "Spaces for single-line unordered list items",
975 "description": "Spaces for single-line ordered list items",
980 "description": "Spaces for multi-line unordered list items",
985 "description": "Spaces for multi-line ordered list items",
990 "additionalProperties": false
993 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
1001 "description": "Include list items",
1006 "additionalProperties": false
1008 "blanks-around-fences": {
1009 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
1017 "description": "Include list items",
1022 "additionalProperties": false
1025 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
1029 "blanks-around-lists": {
1030 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
1035 "description": "MD033/no-inline-html - Inline HTML",
1042 "allowed_elements": {
1043 "description": "Allowed elements",
1051 "additionalProperties": false
1054 "description": "MD033/no-inline-html - Inline HTML",
1061 "allowed_elements": {
1062 "description": "Allowed elements",
1070 "additionalProperties": false
1073 "description": "MD034/no-bare-urls - Bare URL used",
1078 "description": "MD034/no-bare-urls - Bare URL used",
1083 "description": "MD035/hr-style - Horizontal rule style",
1091 "description": "Horizontal rule style",
1093 "default": "consistent"
1096 "additionalProperties": false
1099 "description": "MD035/hr-style - Horizontal rule style",
1107 "description": "Horizontal rule style",
1109 "default": "consistent"
1112 "additionalProperties": false
1115 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1123 "description": "Punctuation characters",
1125 "default": ".,;:!?。,;:!?"
1128 "additionalProperties": false
1130 "no-emphasis-as-heading": {
1131 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1139 "description": "Punctuation characters",
1141 "default": ".,;:!?。,;:!?"
1144 "additionalProperties": false
1146 "no-emphasis-as-header": {
1147 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1155 "description": "Punctuation characters",
1157 "default": ".,;:!?。,;:!?"
1160 "additionalProperties": false
1163 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1167 "no-space-in-emphasis": {
1168 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1173 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1177 "no-space-in-code": {
1178 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1183 "description": "MD039/no-space-in-links - Spaces inside link text",
1187 "no-space-in-links": {
1188 "description": "MD039/no-space-in-links - Spaces inside link text",
1193 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1197 "fenced-code-language": {
1198 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1203 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1211 "description": "Heading level",
1215 "front_matter_title": {
1216 "description": "RegExp for matching title in front matter",
1218 "default": "^\\s*title\\s*[:=]"
1221 "additionalProperties": false
1223 "first-line-heading": {
1224 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1232 "description": "Heading level",
1236 "front_matter_title": {
1237 "description": "RegExp for matching title in front matter",
1239 "default": "^\\s*title\\s*[:=]"
1242 "additionalProperties": false
1245 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1253 "description": "Heading level",
1257 "front_matter_title": {
1258 "description": "RegExp for matching title in front matter",
1260 "default": "^\\s*title\\s*[:=]"
1263 "additionalProperties": false
1266 "description": "MD042/no-empty-links - No empty links",
1271 "description": "MD042/no-empty-links - No empty links",
1276 "description": "MD043/required-headings/required-headers - Required heading structure",
1284 "description": "List of headings",
1292 "description": "List of headings",
1300 "additionalProperties": false
1302 "required-headings": {
1303 "description": "MD043/required-headings/required-headers - Required heading structure",
1311 "description": "List of headings",
1319 "description": "List of headings",
1327 "additionalProperties": false
1329 "required-headers": {
1330 "description": "MD043/required-headings/required-headers - Required heading structure",
1338 "description": "List of headings",
1346 "description": "List of headings",
1354 "additionalProperties": false
1357 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1365 "description": "List of proper names",
1373 "description": "Include code blocks",
1378 "additionalProperties": false
1381 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1389 "description": "List of proper names",
1397 "description": "Include code blocks",
1402 "additionalProperties": false
1405 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1410 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1415 "description": "MD046/code-block-style - Code block style",
1423 "description": "Block style",
1430 "default": "consistent"
1433 "additionalProperties": false
1435 "code-block-style": {
1436 "description": "MD046/code-block-style - Code block style",
1444 "description": "Block style",
1451 "default": "consistent"
1454 "additionalProperties": false
1457 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1461 "single-trailing-newline": {
1462 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1467 "description": "MD048/code-fence-style - Code fence style",
1475 "description": "Code fence syle",
1482 "default": "consistent"
1485 "additionalProperties": false
1487 "code-fence-style": {
1488 "description": "MD048/code-fence-style - Code fence style",
1496 "description": "Code fence syle",
1503 "default": "consistent"
1506 "additionalProperties": false
1509 "description": "headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1514 "description": "headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1519 "description": "bullet - MD004, MD005, MD006, MD007, MD032",
1524 "description": "ul - MD004, MD005, MD006, MD007, MD030, MD032",
1529 "description": "indentation - MD005, MD006, MD007, MD027",
1534 "description": "whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039",
1539 "description": "hard_tab - MD010",
1544 "description": "links - MD011, MD034, MD039, MD042",
1549 "description": "blank_lines - MD012, MD022, MD031, MD032, MD047",
1554 "description": "line_length - MD013",
1559 "description": "code - MD014, MD031, MD038, MD040, MD046, MD048",
1564 "description": "atx - MD018, MD019",
1569 "description": "spaces - MD018, MD019, MD020, MD021, MD023",
1574 "description": "atx_closed - MD020, MD021",
1579 "description": "blockquote - MD027, MD028",
1584 "description": "ol - MD029, MD030, MD032",
1589 "description": "html - MD033",
1594 "description": "url - MD034",
1599 "description": "hr - MD035",
1604 "description": "emphasis - MD036, MD037",
1609 "description": "language - MD040",
1614 "description": "spelling - MD044",
1619 "description": "accessibility - MD045",
1624 "description": "images - MD045",
1634 "command": "markdownlint.fixAll",
1635 "title": "Fix all errors found by markdownlint"