@alexlit/lint-kit 107.3.0 → 108.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (247) hide show
  1. package/.eslintrc.cjs +7 -1
  2. package/.linthtmlrc.cjs +3 -1
  3. package/{.commitlintrc.cjs → commitlint.config.js} +1 -1
  4. package/package.json +6 -6
  5. package/packages/config-commitlint/LICENSE +20 -0
  6. package/packages/config-commitlint/README.md +5 -9
  7. package/packages/config-commitlint/index.js +1 -1
  8. package/packages/config-commitlint/package.json +4 -3
  9. package/packages/config-eslint/LICENSE +20 -0
  10. package/packages/config-eslint/index.js +12 -2
  11. package/packages/config-eslint/package.json +25 -25
  12. package/packages/config-eslint/plugins/typescript/index.js +1 -1
  13. package/packages/config-eslint/plugins/unicorn.js +2 -0
  14. package/packages/config-eslint/plugins/vue.js +34 -2
  15. package/packages/config-hooks/LICENSE +20 -0
  16. package/packages/config-hooks/README.md +18 -12
  17. package/packages/config-hooks/index.js +2 -0
  18. package/packages/config-hooks/lint-staged.js +1 -1
  19. package/packages/config-hooks/package.json +6 -5
  20. package/packages/config-htmllint/LICENSE +20 -0
  21. package/packages/config-markdownlint/LICENSE +20 -0
  22. package/packages/config-markdownlint/package.json +3 -3
  23. package/packages/config-npmlint/LICENSE +20 -0
  24. package/packages/config-npmlint/package.json +2 -2
  25. package/packages/config-prettier/LICENSE +20 -0
  26. package/packages/config-prettier/README.md +8 -3
  27. package/packages/config-prettier/index.js +14 -10
  28. package/packages/config-prettier/package.json +16 -12
  29. package/packages/config-prettier/plugins/jsdoc.js +1 -1
  30. package/packages/config-prettier/plugins/pug.js +1 -1
  31. package/packages/config-prettier/plugins/sort-json.js +1 -1
  32. package/packages/config-prettier/plugins/svelte.js +1 -1
  33. package/packages/config-prettier/plugins/tailwindcss.js +1 -1
  34. package/packages/config-prettier/plugins/xml.js +1 -1
  35. package/packages/config-stylelint/LICENSE +20 -0
  36. package/packages/config-stylelint/README.md +5 -4
  37. package/packages/config-stylelint/index.js +28 -27
  38. package/packages/config-stylelint/package.json +23 -19
  39. package/packages/config-stylelint/plugins/a11y.js +1 -1
  40. package/packages/config-stylelint/plugins/at-rule-no-children.js +2 -2
  41. package/packages/config-stylelint/plugins/color-format.js +1 -1
  42. package/packages/config-stylelint/plugins/declaration-block-no-ignored-properties.js +1 -1
  43. package/packages/config-stylelint/plugins/high-performance-animation.js +1 -1
  44. package/packages/config-stylelint/plugins/no-nested-media.js +1 -1
  45. package/packages/config-stylelint/plugins/no-unresolved-module.js +1 -1
  46. package/packages/config-stylelint/plugins/no-unsupported-browser-features.js +1 -1
  47. package/packages/config-stylelint/plugins/optional/gamut.js +1 -1
  48. package/packages/config-stylelint/plugins/optional/logical-css.js +1 -1
  49. package/packages/config-stylelint/plugins/optional/no-indistinguishable-colors.js +1 -1
  50. package/packages/config-stylelint/plugins/order.js +1 -1
  51. package/packages/config-stylelint/plugins/prettier.js +1 -1
  52. package/packages/config-stylelint/plugins/scss.js +3 -1
  53. package/packages/config-stylelint/plugins/selector-no-empty.js +1 -1
  54. package/packages/config-stylelint/plugins/use-nesting.js +1 -1
  55. package/packages/config-stylelint/plugins/vue.js +1 -1
  56. package/prettier.config.js +5 -0
  57. package/stylelint.config.js +14 -0
  58. package/.huskyrc.cjs +0 -3
  59. package/.lintstagedrc.cjs +0 -3
  60. package/.prettierrc.cjs +0 -3
  61. package/.stylelintrc.cjs +0 -4
  62. package/packages/config-hooks/husky.js +0 -6
  63. package/packages/config-markdownlint/node_modules/markdown-it/LICENSE +0 -22
  64. package/packages/config-markdownlint/node_modules/markdown-it/README.md +0 -309
  65. package/packages/config-markdownlint/node_modules/markdown-it/bin/markdown-it.js +0 -117
  66. package/packages/config-markdownlint/node_modules/markdown-it/dist/markdown-it.js +0 -8441
  67. package/packages/config-markdownlint/node_modules/markdown-it/dist/markdown-it.min.js +0 -3
  68. package/packages/config-markdownlint/node_modules/markdown-it/index.js +0 -4
  69. package/packages/config-markdownlint/node_modules/markdown-it/lib/common/entities.js +0 -6
  70. package/packages/config-markdownlint/node_modules/markdown-it/lib/common/html_blocks.js +0 -70
  71. package/packages/config-markdownlint/node_modules/markdown-it/lib/common/html_re.js +0 -28
  72. package/packages/config-markdownlint/node_modules/markdown-it/lib/common/utils.js +0 -317
  73. package/packages/config-markdownlint/node_modules/markdown-it/lib/helpers/index.js +0 -7
  74. package/packages/config-markdownlint/node_modules/markdown-it/lib/helpers/parse_link_destination.js +0 -80
  75. package/packages/config-markdownlint/node_modules/markdown-it/lib/helpers/parse_link_label.js +0 -48
  76. package/packages/config-markdownlint/node_modules/markdown-it/lib/helpers/parse_link_title.js +0 -55
  77. package/packages/config-markdownlint/node_modules/markdown-it/lib/index.js +0 -582
  78. package/packages/config-markdownlint/node_modules/markdown-it/lib/parser_block.js +0 -131
  79. package/packages/config-markdownlint/node_modules/markdown-it/lib/parser_core.js +0 -61
  80. package/packages/config-markdownlint/node_modules/markdown-it/lib/parser_inline.js +0 -192
  81. package/packages/config-markdownlint/node_modules/markdown-it/lib/presets/commonmark.js +0 -81
  82. package/packages/config-markdownlint/node_modules/markdown-it/lib/presets/default.js +0 -41
  83. package/packages/config-markdownlint/node_modules/markdown-it/lib/presets/zero.js +0 -63
  84. package/packages/config-markdownlint/node_modules/markdown-it/lib/renderer.js +0 -341
  85. package/packages/config-markdownlint/node_modules/markdown-it/lib/ruler.js +0 -352
  86. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/blockquote.js +0 -226
  87. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/code.js +0 -34
  88. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/fence.js +0 -98
  89. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/heading.js +0 -55
  90. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/hr.js +0 -45
  91. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/html_block.js +0 -74
  92. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/lheading.js +0 -83
  93. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/list.js +0 -362
  94. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/paragraph.js +0 -51
  95. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/reference.js +0 -198
  96. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/state_block.js +0 -231
  97. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_block/table.js +0 -221
  98. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/block.js +0 -16
  99. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/inline.js +0 -13
  100. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/linkify.js +0 -142
  101. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/normalize.js +0 -21
  102. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/replacements.js +0 -105
  103. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/smartquotes.js +0 -201
  104. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/state_core.js +0 -20
  105. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_core/text_join.js +0 -45
  106. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/autolink.js +0 -76
  107. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/backticks.js +0 -63
  108. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/balance_pairs.js +0 -130
  109. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/emphasis.js +0 -130
  110. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/entity.js +0 -55
  111. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/escape.js +0 -71
  112. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/fragments_join.js +0 -41
  113. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/html_inline.js +0 -58
  114. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/image.js +0 -152
  115. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/link.js +0 -150
  116. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/linkify.js +0 -62
  117. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/newline.js +0 -46
  118. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/state_inline.js +0 -158
  119. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/strikethrough.js +0 -130
  120. package/packages/config-markdownlint/node_modules/markdown-it/lib/rules_inline/text.js +0 -89
  121. package/packages/config-markdownlint/node_modules/markdown-it/lib/token.js +0 -201
  122. package/packages/config-markdownlint/node_modules/markdown-it/package.json +0 -87
  123. package/packages/config-markdownlint/node_modules/markdownlint/CHANGELOG.md +0 -428
  124. package/packages/config-markdownlint/node_modules/markdownlint/CONTRIBUTING.md +0 -92
  125. package/packages/config-markdownlint/node_modules/markdownlint/LICENSE +0 -21
  126. package/packages/config-markdownlint/node_modules/markdownlint/README.md +0 -1026
  127. package/packages/config-markdownlint/node_modules/markdownlint/demo/markdownlint-browser.js +0 -6814
  128. package/packages/config-markdownlint/node_modules/markdownlint/doc/CustomRules.md +0 -376
  129. package/packages/config-markdownlint/node_modules/markdownlint/doc/Prettier.md +0 -27
  130. package/packages/config-markdownlint/node_modules/markdownlint/doc/ReleaseProcess.md +0 -20
  131. package/packages/config-markdownlint/node_modules/markdownlint/doc/Rules.md +0 -2335
  132. package/packages/config-markdownlint/node_modules/markdownlint/doc/md001.md +0 -37
  133. package/packages/config-markdownlint/node_modules/markdownlint/doc/md003.md +0 -59
  134. package/packages/config-markdownlint/node_modules/markdownlint/doc/md004.md +0 -49
  135. package/packages/config-markdownlint/node_modules/markdownlint/doc/md005.md +0 -53
  136. package/packages/config-markdownlint/node_modules/markdownlint/doc/md007.md +0 -52
  137. package/packages/config-markdownlint/node_modules/markdownlint/doc/md009.md +0 -51
  138. package/packages/config-markdownlint/node_modules/markdownlint/doc/md010.md +0 -56
  139. package/packages/config-markdownlint/node_modules/markdownlint/doc/md011.md +0 -30
  140. package/packages/config-markdownlint/node_modules/markdownlint/doc/md012.md +0 -38
  141. package/packages/config-markdownlint/node_modules/markdownlint/doc/md013.md +0 -57
  142. package/packages/config-markdownlint/node_modules/markdownlint/doc/md014.md +0 -54
  143. package/packages/config-markdownlint/node_modules/markdownlint/doc/md018.md +0 -27
  144. package/packages/config-markdownlint/node_modules/markdownlint/doc/md019.md +0 -28
  145. package/packages/config-markdownlint/node_modules/markdownlint/doc/md020.md +0 -29
  146. package/packages/config-markdownlint/node_modules/markdownlint/doc/md021.md +0 -31
  147. package/packages/config-markdownlint/node_modules/markdownlint/doc/md022.md +0 -52
  148. package/packages/config-markdownlint/node_modules/markdownlint/doc/md023.md +0 -33
  149. package/packages/config-markdownlint/node_modules/markdownlint/doc/md024.md +0 -47
  150. package/packages/config-markdownlint/node_modules/markdownlint/doc/md025.md +0 -49
  151. package/packages/config-markdownlint/node_modules/markdownlint/doc/md026.md +0 -40
  152. package/packages/config-markdownlint/node_modules/markdownlint/doc/md027.md +0 -24
  153. package/packages/config-markdownlint/node_modules/markdownlint/doc/md028.md +0 -40
  154. package/packages/config-markdownlint/node_modules/markdownlint/doc/md029.md +0 -98
  155. package/packages/config-markdownlint/node_modules/markdownlint/doc/md030.md +0 -82
  156. package/packages/config-markdownlint/node_modules/markdownlint/doc/md031.md +0 -50
  157. package/packages/config-markdownlint/node_modules/markdownlint/doc/md032.md +0 -55
  158. package/packages/config-markdownlint/node_modules/markdownlint/doc/md033.md +0 -27
  159. package/packages/config-markdownlint/node_modules/markdownlint/doc/md034.md +0 -50
  160. package/packages/config-markdownlint/node_modules/markdownlint/doc/md035.md +0 -42
  161. package/packages/config-markdownlint/node_modules/markdownlint/doc/md036.md +0 -45
  162. package/packages/config-markdownlint/node_modules/markdownlint/doc/md037.md +0 -37
  163. package/packages/config-markdownlint/node_modules/markdownlint/doc/md038.md +0 -40
  164. package/packages/config-markdownlint/node_modules/markdownlint/doc/md039.md +0 -21
  165. package/packages/config-markdownlint/node_modules/markdownlint/doc/md040.md +0 -52
  166. package/packages/config-markdownlint/node_modules/markdownlint/doc/md041.md +0 -49
  167. package/packages/config-markdownlint/node_modules/markdownlint/doc/md042.md +0 -32
  168. package/packages/config-markdownlint/node_modules/markdownlint/doc/md043.md +0 -69
  169. package/packages/config-markdownlint/node_modules/markdownlint/doc/md044.md +0 -35
  170. package/packages/config-markdownlint/node_modules/markdownlint/doc/md045.md +0 -40
  171. package/packages/config-markdownlint/node_modules/markdownlint/doc/md046.md +0 -40
  172. package/packages/config-markdownlint/node_modules/markdownlint/doc/md047.md +0 -34
  173. package/packages/config-markdownlint/node_modules/markdownlint/doc/md048.md +0 -41
  174. package/packages/config-markdownlint/node_modules/markdownlint/doc/md049.md +0 -32
  175. package/packages/config-markdownlint/node_modules/markdownlint/doc/md050.md +0 -32
  176. package/packages/config-markdownlint/node_modules/markdownlint/doc/md051.md +0 -61
  177. package/packages/config-markdownlint/node_modules/markdownlint/doc/md052.md +0 -40
  178. package/packages/config-markdownlint/node_modules/markdownlint/doc/md053.md +0 -38
  179. package/packages/config-markdownlint/node_modules/markdownlint/doc/md054.md +0 -100
  180. package/packages/config-markdownlint/node_modules/markdownlint/helpers/LICENSE +0 -21
  181. package/packages/config-markdownlint/node_modules/markdownlint/helpers/README.md +0 -70
  182. package/packages/config-markdownlint/node_modules/markdownlint/helpers/helpers.js +0 -1025
  183. package/packages/config-markdownlint/node_modules/markdownlint/helpers/micromark.cjs +0 -426
  184. package/packages/config-markdownlint/node_modules/markdownlint/helpers/package.json +0 -26
  185. package/packages/config-markdownlint/node_modules/markdownlint/helpers/shared.js +0 -10
  186. package/packages/config-markdownlint/node_modules/markdownlint/lib/cache.js +0 -21
  187. package/packages/config-markdownlint/node_modules/markdownlint/lib/configuration.d.ts +0 -1152
  188. package/packages/config-markdownlint/node_modules/markdownlint/lib/constants.js +0 -14
  189. package/packages/config-markdownlint/node_modules/markdownlint/lib/markdownlint.d.ts +0 -406
  190. package/packages/config-markdownlint/node_modules/markdownlint/lib/markdownlint.js +0 -1476
  191. package/packages/config-markdownlint/node_modules/markdownlint/lib/md001.js +0 -22
  192. package/packages/config-markdownlint/node_modules/markdownlint/lib/md003.js +0 -42
  193. package/packages/config-markdownlint/node_modules/markdownlint/lib/md004.js +0 -76
  194. package/packages/config-markdownlint/node_modules/markdownlint/lib/md005.js +0 -73
  195. package/packages/config-markdownlint/node_modules/markdownlint/lib/md007.js +0 -86
  196. package/packages/config-markdownlint/node_modules/markdownlint/lib/md009.js +0 -86
  197. package/packages/config-markdownlint/node_modules/markdownlint/lib/md010.js +0 -60
  198. package/packages/config-markdownlint/node_modules/markdownlint/lib/md011.js +0 -46
  199. package/packages/config-markdownlint/node_modules/markdownlint/lib/md012.js +0 -32
  200. package/packages/config-markdownlint/node_modules/markdownlint/lib/md013.js +0 -96
  201. package/packages/config-markdownlint/node_modules/markdownlint/lib/md014.js +0 -53
  202. package/packages/config-markdownlint/node_modules/markdownlint/lib/md018.js +0 -34
  203. package/packages/config-markdownlint/node_modules/markdownlint/lib/md019.js +0 -39
  204. package/packages/config-markdownlint/node_modules/markdownlint/lib/md020.js +0 -62
  205. package/packages/config-markdownlint/node_modules/markdownlint/lib/md021.js +0 -62
  206. package/packages/config-markdownlint/node_modules/markdownlint/lib/md022.js +0 -108
  207. package/packages/config-markdownlint/node_modules/markdownlint/lib/md023.js +0 -38
  208. package/packages/config-markdownlint/node_modules/markdownlint/lib/md024.js +0 -38
  209. package/packages/config-markdownlint/node_modules/markdownlint/lib/md025.js +0 -32
  210. package/packages/config-markdownlint/node_modules/markdownlint/lib/md026.js +0 -50
  211. package/packages/config-markdownlint/node_modules/markdownlint/lib/md027.js +0 -56
  212. package/packages/config-markdownlint/node_modules/markdownlint/lib/md028.js +0 -30
  213. package/packages/config-markdownlint/node_modules/markdownlint/lib/md029.js +0 -67
  214. package/packages/config-markdownlint/node_modules/markdownlint/lib/md030.js +0 -61
  215. package/packages/config-markdownlint/node_modules/markdownlint/lib/md031.js +0 -40
  216. package/packages/config-markdownlint/node_modules/markdownlint/lib/md032.js +0 -78
  217. package/packages/config-markdownlint/node_modules/markdownlint/lib/md033.js +0 -39
  218. package/packages/config-markdownlint/node_modules/markdownlint/lib/md034.js +0 -79
  219. package/packages/config-markdownlint/node_modules/markdownlint/lib/md035.js +0 -24
  220. package/packages/config-markdownlint/node_modules/markdownlint/lib/md036.js +0 -56
  221. package/packages/config-markdownlint/node_modules/markdownlint/lib/md037.js +0 -91
  222. package/packages/config-markdownlint/node_modules/markdownlint/lib/md038.js +0 -97
  223. package/packages/config-markdownlint/node_modules/markdownlint/lib/md039.js +0 -67
  224. package/packages/config-markdownlint/node_modules/markdownlint/lib/md040.js +0 -37
  225. package/packages/config-markdownlint/node_modules/markdownlint/lib/md041.js +0 -42
  226. package/packages/config-markdownlint/node_modules/markdownlint/lib/md042.js +0 -49
  227. package/packages/config-markdownlint/node_modules/markdownlint/lib/md043.js +0 -64
  228. package/packages/config-markdownlint/node_modules/markdownlint/lib/md044.js +0 -107
  229. package/packages/config-markdownlint/node_modules/markdownlint/lib/md045.js +0 -60
  230. package/packages/config-markdownlint/node_modules/markdownlint/lib/md046.js +0 -33
  231. package/packages/config-markdownlint/node_modules/markdownlint/lib/md047.js +0 -28
  232. package/packages/config-markdownlint/node_modules/markdownlint/lib/md048.js +0 -30
  233. package/packages/config-markdownlint/node_modules/markdownlint/lib/md049-md050.js +0 -89
  234. package/packages/config-markdownlint/node_modules/markdownlint/lib/md051.js +0 -172
  235. package/packages/config-markdownlint/node_modules/markdownlint/lib/md052.js +0 -39
  236. package/packages/config-markdownlint/node_modules/markdownlint/lib/md053.js +0 -59
  237. package/packages/config-markdownlint/node_modules/markdownlint/lib/md054.js +0 -125
  238. package/packages/config-markdownlint/node_modules/markdownlint/lib/rules.js +0 -65
  239. package/packages/config-markdownlint/node_modules/markdownlint/package.json +0 -109
  240. package/packages/config-markdownlint/node_modules/markdownlint/schema/.markdownlint.jsonc +0 -297
  241. package/packages/config-markdownlint/node_modules/markdownlint/schema/.markdownlint.yaml +0 -266
  242. package/packages/config-markdownlint/node_modules/markdownlint/schema/markdownlint-config-schema.json +0 -1762
  243. package/packages/config-markdownlint/node_modules/markdownlint/style/all.json +0 -5
  244. package/packages/config-markdownlint/node_modules/markdownlint/style/cirosantilli.json +0 -22
  245. package/packages/config-markdownlint/node_modules/markdownlint/style/prettier.json +0 -26
  246. package/packages/config-markdownlint/node_modules/markdownlint/style/relaxed.json +0 -12
  247. /package/packages/config-eslint/plugins/{security.js → optional/security.js} +0 -0
@@ -1,14 +0,0 @@
1
- // @ts-check
2
-
3
- "use strict";
4
-
5
- module.exports.deprecatedRuleNames = [];
6
- module.exports.fixableRuleNames = [
7
- "MD004", "MD005", "MD007", "MD009", "MD010", "MD011",
8
- "MD012", "MD014", "MD018", "MD019", "MD020", "MD021",
9
- "MD022", "MD023", "MD026", "MD027", "MD030", "MD031",
10
- "MD032", "MD034", "MD037", "MD038", "MD039", "MD044",
11
- "MD047", "MD049", "MD050", "MD051", "MD053", "MD054"
12
- ];
13
- module.exports.homepage = "https://github.com/DavidAnson/markdownlint";
14
- module.exports.version = "0.32.1";
@@ -1,406 +0,0 @@
1
- export = markdownlint;
2
- /**
3
- * Lint specified Markdown files.
4
- *
5
- * @param {Options | null} options Configuration options.
6
- * @param {LintCallback} callback Callback (err, result) function.
7
- * @returns {void}
8
- */
9
- declare function markdownlint(options: Options | null, callback: LintCallback): void;
10
- declare namespace markdownlint {
11
- export { markdownlintSync as sync, readConfig, readConfigSync, getVersion, promises, RuleFunction, RuleParams, MarkdownItToken, RuleOnError, RuleOnErrorInfo, RuleOnErrorFixInfo, Rule, Options, Plugin, ToStringCallback, LintResults, LintError, FixInfo, LintContentCallback, LintCallback, Configuration, RuleConfiguration, ConfigurationParser, ReadConfigCallback, ResolveConfigExtendsCallback };
12
- }
13
- /**
14
- * Configuration options.
15
- */
16
- type Options = {
17
- /**
18
- * Configuration object.
19
- */
20
- config?: Configuration;
21
- /**
22
- * Configuration parsers.
23
- */
24
- configParsers?: ConfigurationParser[];
25
- /**
26
- * Custom rules.
27
- */
28
- customRules?: Rule[] | Rule;
29
- /**
30
- * Files to lint.
31
- */
32
- files?: string[] | string;
33
- /**
34
- * Front matter pattern.
35
- */
36
- frontMatter?: RegExp | null;
37
- /**
38
- * File system implementation.
39
- */
40
- fs?: any;
41
- /**
42
- * True to catch exceptions.
43
- */
44
- handleRuleFailures?: boolean;
45
- /**
46
- * Additional plugins.
47
- */
48
- markdownItPlugins?: Plugin[];
49
- /**
50
- * True to ignore HTML directives.
51
- */
52
- noInlineConfig?: boolean;
53
- /**
54
- * Results object version.
55
- */
56
- resultVersion?: number;
57
- /**
58
- * Strings to lint.
59
- */
60
- strings?: {
61
- [x: string]: string;
62
- };
63
- };
64
- /**
65
- * Called with the result of the lint function.
66
- */
67
- type LintCallback = (error: Error | null, results?: LintResults) => void;
68
- /**
69
- * Lint specified Markdown files synchronously.
70
- *
71
- * @param {Options | null} options Configuration options.
72
- * @returns {LintResults} Results object.
73
- */
74
- declare function markdownlintSync(options: Options | null): LintResults;
75
- /**
76
- * Read specified configuration file.
77
- *
78
- * @param {string} file Configuration file name.
79
- * @param {ConfigurationParser[] | ReadConfigCallback} parsers Parsing
80
- * function(s).
81
- * @param {Object} [fs] File system implementation.
82
- * @param {ReadConfigCallback} [callback] Callback (err, result) function.
83
- * @returns {void}
84
- */
85
- declare function readConfig(file: string, parsers: ConfigurationParser[] | ReadConfigCallback, fs?: any, callback?: ReadConfigCallback): void;
86
- /**
87
- * Read specified configuration file synchronously.
88
- *
89
- * @param {string} file Configuration file name.
90
- * @param {ConfigurationParser[]} [parsers] Parsing function(s).
91
- * @param {Object} [fs] File system implementation.
92
- * @returns {Configuration} Configuration object.
93
- * @throws An Error if processing fails.
94
- */
95
- declare function readConfigSync(file: string, parsers?: ConfigurationParser[], fs?: any): Configuration;
96
- /**
97
- * Gets the (semantic) version of the library.
98
- *
99
- * @returns {string} SemVer string.
100
- */
101
- declare function getVersion(): string;
102
- declare namespace promises {
103
- export { markdownlintPromise as markdownlint };
104
- export { extendConfigPromise as extendConfig };
105
- export { readConfigPromise as readConfig };
106
- }
107
- /**
108
- * Function to implement rule logic.
109
- */
110
- type RuleFunction = (params: RuleParams, onError: RuleOnError) => void;
111
- /**
112
- * Rule parameters.
113
- */
114
- type RuleParams = {
115
- /**
116
- * File/string name.
117
- */
118
- name: string;
119
- /**
120
- * Token objects from markdown-it.
121
- */
122
- tokens: MarkdownItToken[];
123
- /**
124
- * File/string lines.
125
- */
126
- lines: string[];
127
- /**
128
- * Front matter lines.
129
- */
130
- frontMatterLines: string[];
131
- /**
132
- * Rule configuration.
133
- */
134
- config: RuleConfiguration;
135
- };
136
- /**
137
- * Markdown-It token.
138
- */
139
- type MarkdownItToken = {
140
- /**
141
- * HTML attributes.
142
- */
143
- attrs: string[][];
144
- /**
145
- * Block-level token.
146
- */
147
- block: boolean;
148
- /**
149
- * Child nodes.
150
- */
151
- children: MarkdownItToken[];
152
- /**
153
- * Tag contents.
154
- */
155
- content: string;
156
- /**
157
- * Ignore element.
158
- */
159
- hidden: boolean;
160
- /**
161
- * Fence info.
162
- */
163
- info: string;
164
- /**
165
- * Nesting level.
166
- */
167
- level: number;
168
- /**
169
- * Beginning/ending line numbers.
170
- */
171
- map: number[];
172
- /**
173
- * Markup text.
174
- */
175
- markup: string;
176
- /**
177
- * Arbitrary data.
178
- */
179
- meta: any;
180
- /**
181
- * Level change.
182
- */
183
- nesting: number;
184
- /**
185
- * HTML tag name.
186
- */
187
- tag: string;
188
- /**
189
- * Token type.
190
- */
191
- type: string;
192
- /**
193
- * Line number (1-based).
194
- */
195
- lineNumber: number;
196
- /**
197
- * Line content.
198
- */
199
- line: string;
200
- };
201
- /**
202
- * Error-reporting callback.
203
- */
204
- type RuleOnError = (onErrorInfo: RuleOnErrorInfo) => void;
205
- /**
206
- * Fix information for RuleOnError callback.
207
- */
208
- type RuleOnErrorInfo = {
209
- /**
210
- * Line number (1-based).
211
- */
212
- lineNumber: number;
213
- /**
214
- * Detail about the error.
215
- */
216
- detail?: string;
217
- /**
218
- * Context for the error.
219
- */
220
- context?: string;
221
- /**
222
- * Link to more information.
223
- */
224
- information?: URL;
225
- /**
226
- * Column number (1-based) and length.
227
- */
228
- range?: number[];
229
- /**
230
- * Fix information.
231
- */
232
- fixInfo?: RuleOnErrorFixInfo;
233
- };
234
- /**
235
- * Fix information for RuleOnErrorInfo.
236
- */
237
- type RuleOnErrorFixInfo = {
238
- /**
239
- * Line number (1-based).
240
- */
241
- lineNumber?: number;
242
- /**
243
- * Column of the fix (1-based).
244
- */
245
- editColumn?: number;
246
- /**
247
- * Count of characters to delete.
248
- */
249
- deleteCount?: number;
250
- /**
251
- * Text to insert (after deleting).
252
- */
253
- insertText?: string;
254
- };
255
- /**
256
- * Rule definition.
257
- */
258
- type Rule = {
259
- /**
260
- * Rule name(s).
261
- */
262
- names: string[];
263
- /**
264
- * Rule description.
265
- */
266
- description: string;
267
- /**
268
- * Link to more information.
269
- */
270
- information?: URL;
271
- /**
272
- * Rule tag(s).
273
- */
274
- tags: string[];
275
- /**
276
- * True if asynchronous.
277
- */
278
- asynchronous?: boolean;
279
- /**
280
- * Rule implementation.
281
- */
282
- function: RuleFunction;
283
- };
284
- /**
285
- * A markdown-it plugin.
286
- */
287
- type Plugin = any[];
288
- /**
289
- * Function to pretty-print lint results.
290
- */
291
- type ToStringCallback = (ruleAliases?: boolean) => string;
292
- /**
293
- * Lint results (for resultVersion 3).
294
- */
295
- type LintResults = {
296
- [x: string]: LintError[];
297
- };
298
- /**
299
- * Lint error.
300
- */
301
- type LintError = {
302
- /**
303
- * Line number (1-based).
304
- */
305
- lineNumber: number;
306
- /**
307
- * Rule name(s).
308
- */
309
- ruleNames: string[];
310
- /**
311
- * Rule description.
312
- */
313
- ruleDescription: string;
314
- /**
315
- * Link to more information.
316
- */
317
- ruleInformation: string;
318
- /**
319
- * Detail about the error.
320
- */
321
- errorDetail: string;
322
- /**
323
- * Context for the error.
324
- */
325
- errorContext: string;
326
- /**
327
- * Column number (1-based) and length.
328
- */
329
- errorRange: number[];
330
- /**
331
- * Fix information.
332
- */
333
- fixInfo?: FixInfo;
334
- };
335
- /**
336
- * Fix information.
337
- */
338
- type FixInfo = {
339
- /**
340
- * Line number (1-based).
341
- */
342
- lineNumber?: number;
343
- /**
344
- * Column of the fix (1-based).
345
- */
346
- editColumn?: number;
347
- /**
348
- * Count of characters to delete.
349
- */
350
- deleteCount?: number;
351
- /**
352
- * Text to insert (after deleting).
353
- */
354
- insertText?: string;
355
- };
356
- /**
357
- * Called with the result of linting a string or document.
358
- */
359
- type LintContentCallback = (error: Error | null, result?: LintError[]) => void;
360
- /**
361
- * Configuration object for linting rules. For the JSON schema, see
362
- * {@link ../schema/markdownlint-config-schema.json}.
363
- */
364
- type Configuration = import("./configuration").Configuration;
365
- /**
366
- * Rule configuration.
367
- */
368
- type RuleConfiguration = boolean | any;
369
- /**
370
- * Parses a configuration string and returns a configuration object.
371
- */
372
- type ConfigurationParser = (text: string) => Configuration;
373
- /**
374
- * Called with the result of the readConfig function.
375
- */
376
- type ReadConfigCallback = (err: Error | null, config?: Configuration) => void;
377
- /**
378
- * Called with the result of the resolveConfigExtends function.
379
- */
380
- type ResolveConfigExtendsCallback = (err: Error | null, path?: string) => void;
381
- /**
382
- * Lint specified Markdown files.
383
- *
384
- * @param {Options} options Configuration options.
385
- * @returns {Promise<LintResults>} Results object.
386
- */
387
- declare function markdownlintPromise(options: Options): Promise<LintResults>;
388
- /**
389
- * Extend specified configuration object.
390
- *
391
- * @param {Configuration} config Configuration object.
392
- * @param {string} file Configuration file name.
393
- * @param {ConfigurationParser[]} [parsers] Parsing function(s).
394
- * @param {Object} [fs] File system implementation.
395
- * @returns {Promise<Configuration>} Configuration object.
396
- */
397
- declare function extendConfigPromise(config: Configuration, file: string, parsers?: ConfigurationParser[], fs?: any): Promise<Configuration>;
398
- /**
399
- * Read specified configuration file.
400
- *
401
- * @param {string} file Configuration file name.
402
- * @param {ConfigurationParser[]} [parsers] Parsing function(s).
403
- * @param {Object} [fs] File system implementation.
404
- * @returns {Promise<Configuration>} Configuration object.
405
- */
406
- declare function readConfigPromise(file: string, parsers?: ConfigurationParser[], fs?: any): Promise<Configuration>;