@redocly/recheck 0.1.0 → 0.2.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 (591) hide show
  1. package/README.md +1006 -56
  2. package/dist/cli.js +27 -7
  3. package/dist/cli.js.map +1 -1
  4. package/dist/commands/markdoc-schema.d.ts +17 -0
  5. package/dist/commands/markdoc-schema.d.ts.map +1 -0
  6. package/dist/commands/markdoc-schema.js +127 -0
  7. package/dist/commands/markdoc-schema.js.map +1 -0
  8. package/dist/commands/run.d.ts +0 -1
  9. package/dist/commands/run.d.ts.map +1 -1
  10. package/dist/commands/run.js +68 -5
  11. package/dist/commands/run.js.map +1 -1
  12. package/dist/config/load.d.ts +11 -0
  13. package/dist/config/load.d.ts.map +1 -1
  14. package/dist/config/load.js +12 -2
  15. package/dist/config/load.js.map +1 -1
  16. package/dist/config/presets/google.d.ts +3 -0
  17. package/dist/config/presets/google.d.ts.map +1 -0
  18. package/dist/config/presets/google.js +1671 -0
  19. package/dist/config/presets/google.js.map +1 -0
  20. package/dist/config/presets/inclusive-language.d.ts +3 -0
  21. package/dist/config/presets/inclusive-language.d.ts.map +1 -0
  22. package/dist/config/presets/inclusive-language.js +321 -0
  23. package/dist/config/presets/inclusive-language.js.map +1 -0
  24. package/dist/config/presets/index.d.ts +67 -0
  25. package/dist/config/presets/index.d.ts.map +1 -0
  26. package/dist/config/presets/index.js +137 -0
  27. package/dist/config/presets/index.js.map +1 -0
  28. package/dist/config/presets/markdoc.d.ts +21 -0
  29. package/dist/config/presets/markdoc.d.ts.map +1 -0
  30. package/dist/config/presets/markdoc.js +101 -0
  31. package/dist/config/presets/markdoc.js.map +1 -0
  32. package/dist/config/presets/markdown-relaxed.d.ts +3 -0
  33. package/dist/config/presets/markdown-relaxed.d.ts.map +1 -0
  34. package/dist/config/presets/markdown-relaxed.js +98 -0
  35. package/dist/config/presets/markdown-relaxed.js.map +1 -0
  36. package/dist/config/presets/markdown.d.ts +43 -0
  37. package/dist/config/presets/markdown.d.ts.map +1 -0
  38. package/dist/config/presets/markdown.js +132 -0
  39. package/dist/config/presets/markdown.js.map +1 -0
  40. package/dist/config/presets/microsoft.d.ts +3 -0
  41. package/dist/config/presets/microsoft.d.ts.map +1 -0
  42. package/dist/config/presets/microsoft.js +2268 -0
  43. package/dist/config/presets/microsoft.js.map +1 -0
  44. package/dist/config/presets/minimal.d.ts +3 -0
  45. package/dist/config/presets/minimal.d.ts.map +1 -0
  46. package/dist/config/presets/minimal.js +21 -0
  47. package/dist/config/presets/minimal.js.map +1 -0
  48. package/dist/config/presets/plain-language.d.ts +3 -0
  49. package/dist/config/presets/plain-language.d.ts.map +1 -0
  50. package/dist/config/presets/plain-language.js +351 -0
  51. package/dist/config/presets/plain-language.js.map +1 -0
  52. package/dist/config/presets/prose.d.ts +52 -0
  53. package/dist/config/presets/prose.d.ts.map +1 -0
  54. package/dist/config/presets/prose.js +138 -0
  55. package/dist/config/presets/prose.js.map +1 -0
  56. package/dist/config/schema.d.ts +128 -22
  57. package/dist/config/schema.d.ts.map +1 -1
  58. package/dist/config/schema.js +105 -21
  59. package/dist/config/schema.js.map +1 -1
  60. package/dist/config/validate.d.ts +12 -2
  61. package/dist/config/validate.d.ts.map +1 -1
  62. package/dist/config/validate.js +1200 -44
  63. package/dist/config/validate.js.map +1 -1
  64. package/dist/core/auto-fix.d.ts +8 -13
  65. package/dist/core/auto-fix.d.ts.map +1 -1
  66. package/dist/core/auto-fix.js +94 -75
  67. package/dist/core/auto-fix.js.map +1 -1
  68. package/dist/core/case-preserve.d.ts +46 -0
  69. package/dist/core/case-preserve.d.ts.map +1 -0
  70. package/dist/core/case-preserve.js +57 -0
  71. package/dist/core/case-preserve.js.map +1 -0
  72. package/dist/core/directives.d.ts +9 -0
  73. package/dist/core/directives.d.ts.map +1 -0
  74. package/dist/core/directives.js +73 -0
  75. package/dist/core/directives.js.map +1 -0
  76. package/dist/core/files.d.ts +63 -0
  77. package/dist/core/files.d.ts.map +1 -1
  78. package/dist/core/files.js +185 -0
  79. package/dist/core/files.js.map +1 -1
  80. package/dist/core/inline-code.d.ts +87 -0
  81. package/dist/core/inline-code.d.ts.map +1 -0
  82. package/dist/core/inline-code.js +104 -0
  83. package/dist/core/inline-code.js.map +1 -0
  84. package/dist/core/line-endings.d.ts +32 -0
  85. package/dist/core/line-endings.d.ts.map +1 -0
  86. package/dist/core/line-endings.js +65 -0
  87. package/dist/core/line-endings.js.map +1 -0
  88. package/dist/core/markdoc-tags.d.ts +79 -0
  89. package/dist/core/markdoc-tags.d.ts.map +1 -0
  90. package/dist/core/markdoc-tags.js +131 -0
  91. package/dist/core/markdoc-tags.js.map +1 -0
  92. package/dist/core/runner.d.ts +92 -3
  93. package/dist/core/runner.d.ts.map +1 -1
  94. package/dist/core/runner.js +348 -110
  95. package/dist/core/runner.js.map +1 -1
  96. package/dist/core/timing.d.ts.map +1 -1
  97. package/dist/data/markdoc-realm-schema.d.ts +3 -0
  98. package/dist/data/markdoc-realm-schema.d.ts.map +1 -0
  99. package/dist/data/markdoc-realm-schema.js +760 -0
  100. package/dist/data/markdoc-realm-schema.js.map +1 -0
  101. package/dist/data/proper-nouns.d.ts +2 -0
  102. package/dist/data/proper-nouns.d.ts.map +1 -0
  103. package/dist/data/proper-nouns.js +208 -0
  104. package/dist/data/proper-nouns.js.map +1 -0
  105. package/dist/index.d.ts +90 -0
  106. package/dist/index.d.ts.map +1 -0
  107. package/dist/index.js +152 -0
  108. package/dist/index.js.map +1 -0
  109. package/dist/metrics/formulas.d.ts +17 -0
  110. package/dist/metrics/formulas.d.ts.map +1 -0
  111. package/dist/metrics/formulas.js +70 -0
  112. package/dist/metrics/formulas.js.map +1 -0
  113. package/dist/metrics/index.d.ts +5 -0
  114. package/dist/metrics/index.d.ts.map +1 -0
  115. package/dist/metrics/index.js +3 -0
  116. package/dist/metrics/index.js.map +1 -0
  117. package/dist/metrics/statistics.d.ts +27 -0
  118. package/dist/metrics/statistics.d.ts.map +1 -0
  119. package/dist/metrics/statistics.js +56 -0
  120. package/dist/metrics/statistics.js.map +1 -0
  121. package/dist/parser/index.d.ts +18 -0
  122. package/dist/parser/index.d.ts.map +1 -0
  123. package/dist/parser/index.js +168 -0
  124. package/dist/parser/index.js.map +1 -0
  125. package/dist/parser/markdoc/extract-statics.d.ts +45 -0
  126. package/dist/parser/markdoc/extract-statics.d.ts.map +1 -0
  127. package/dist/parser/markdoc/extract-statics.js +139 -0
  128. package/dist/parser/markdoc/extract-statics.js.map +1 -0
  129. package/dist/parser/markdoc/pairing.d.ts +63 -0
  130. package/dist/parser/markdoc/pairing.d.ts.map +1 -0
  131. package/dist/parser/markdoc/pairing.js +94 -0
  132. package/dist/parser/markdoc/pairing.js.map +1 -0
  133. package/dist/parser/markdoc/schema.d.ts +85 -0
  134. package/dist/parser/markdoc/schema.d.ts.map +1 -0
  135. package/dist/parser/markdoc/schema.js +86 -0
  136. package/dist/parser/markdoc/schema.js.map +1 -0
  137. package/dist/parser/markdoc/span.d.ts +64 -0
  138. package/dist/parser/markdoc/span.d.ts.map +1 -0
  139. package/dist/parser/markdoc/span.js +729 -0
  140. package/dist/parser/markdoc/span.js.map +1 -0
  141. package/dist/parser/markdoc/structure.d.ts +28 -0
  142. package/dist/parser/markdoc/structure.d.ts.map +1 -0
  143. package/dist/parser/markdoc/structure.js +153 -0
  144. package/dist/parser/markdoc/structure.js.map +1 -0
  145. package/dist/parser/markdoc/syntax.d.ts +44 -0
  146. package/dist/parser/markdoc/syntax.d.ts.map +1 -0
  147. package/dist/parser/markdoc/syntax.js +317 -0
  148. package/dist/parser/markdoc/syntax.js.map +1 -0
  149. package/dist/parser/types.d.ts +18 -0
  150. package/dist/parser/types.d.ts.map +1 -0
  151. package/dist/parser/types.js.map +1 -0
  152. package/dist/reporter/fixes.d.ts.map +1 -1
  153. package/dist/reporter/fixes.js +22 -1
  154. package/dist/reporter/fixes.js.map +1 -1
  155. package/dist/reporter/statistics.d.ts +1 -8
  156. package/dist/reporter/statistics.d.ts.map +1 -1
  157. package/dist/reporter/statistics.js.map +1 -1
  158. package/dist/rules/registry.d.ts +15 -0
  159. package/dist/rules/registry.d.ts.map +1 -0
  160. package/dist/rules/registry.js +81 -0
  161. package/dist/rules/registry.js.map +1 -0
  162. package/dist/rules/scope/capitalization.d.ts +3 -0
  163. package/dist/rules/scope/capitalization.d.ts.map +1 -0
  164. package/dist/rules/scope/capitalization.js +161 -0
  165. package/dist/rules/scope/capitalization.js.map +1 -0
  166. package/dist/rules/scope/conditional.d.ts +3 -0
  167. package/dist/rules/scope/conditional.d.ts.map +1 -0
  168. package/dist/rules/scope/conditional.js +112 -0
  169. package/dist/rules/scope/conditional.js.map +1 -0
  170. package/dist/rules/scope/consistency.d.ts +3 -0
  171. package/dist/rules/scope/consistency.d.ts.map +1 -0
  172. package/dist/rules/scope/consistency.js +178 -0
  173. package/dist/rules/scope/consistency.js.map +1 -0
  174. package/dist/rules/scope/length.d.ts +3 -0
  175. package/dist/rules/scope/length.d.ts.map +1 -0
  176. package/dist/rules/scope/length.js +69 -0
  177. package/dist/rules/scope/length.js.map +1 -0
  178. package/dist/rules/scope/max-image-size.d.ts +3 -0
  179. package/dist/rules/scope/max-image-size.d.ts.map +1 -0
  180. package/dist/rules/scope/max-image-size.js +65 -0
  181. package/dist/rules/scope/max-image-size.js.map +1 -0
  182. package/dist/rules/scope/metric.d.ts +17 -0
  183. package/dist/rules/scope/metric.d.ts.map +1 -0
  184. package/dist/rules/scope/metric.js +216 -0
  185. package/dist/rules/scope/metric.js.map +1 -0
  186. package/dist/rules/scope/occurrence.d.ts +3 -0
  187. package/dist/rules/scope/occurrence.d.ts.map +1 -0
  188. package/dist/rules/scope/occurrence.js +48 -0
  189. package/dist/rules/scope/occurrence.js.map +1 -0
  190. package/dist/rules/scope/pattern.d.ts +3 -0
  191. package/dist/rules/scope/pattern.d.ts.map +1 -0
  192. package/dist/rules/scope/pattern.js +75 -0
  193. package/dist/rules/scope/pattern.js.map +1 -0
  194. package/dist/rules/scope/repetition.d.ts +3 -0
  195. package/dist/rules/scope/repetition.d.ts.map +1 -0
  196. package/dist/rules/scope/repetition.js +139 -0
  197. package/dist/rules/scope/repetition.js.map +1 -0
  198. package/dist/rules/scope/semantic-line-breaks.d.ts +3 -0
  199. package/dist/rules/scope/semantic-line-breaks.d.ts.map +1 -0
  200. package/dist/rules/scope/semantic-line-breaks.js +213 -0
  201. package/dist/rules/scope/semantic-line-breaks.js.map +1 -0
  202. package/dist/rules/scope/spelling.d.ts +27 -0
  203. package/dist/rules/scope/spelling.d.ts.map +1 -0
  204. package/dist/rules/scope/spelling.js +227 -0
  205. package/dist/rules/scope/spelling.js.map +1 -0
  206. package/dist/rules/scope/swap.d.ts +3 -0
  207. package/dist/rules/scope/swap.d.ts.map +1 -0
  208. package/dist/rules/scope/swap.js +149 -0
  209. package/dist/rules/scope/swap.js.map +1 -0
  210. package/dist/rules/scope/title-case.d.ts +42 -0
  211. package/dist/rules/scope/title-case.d.ts.map +1 -0
  212. package/dist/rules/scope/title-case.js +264 -0
  213. package/dist/rules/scope/title-case.js.map +1 -0
  214. package/dist/rules/token/blanks-around-fences.d.ts +3 -0
  215. package/dist/rules/token/blanks-around-fences.d.ts.map +1 -0
  216. package/dist/rules/token/blanks-around-fences.js +44 -0
  217. package/dist/rules/token/blanks-around-fences.js.map +1 -0
  218. package/dist/rules/token/blanks-around-headings.d.ts +3 -0
  219. package/dist/rules/token/blanks-around-headings.d.ts.map +1 -0
  220. package/dist/rules/token/blanks-around-headings.js +108 -0
  221. package/dist/rules/token/blanks-around-headings.js.map +1 -0
  222. package/dist/rules/token/blanks-around-lists.d.ts +3 -0
  223. package/dist/rules/token/blanks-around-lists.d.ts.map +1 -0
  224. package/dist/rules/token/blanks-around-lists.js +56 -0
  225. package/dist/rules/token/blanks-around-lists.js.map +1 -0
  226. package/dist/rules/token/blanks-around-tables.d.ts +3 -0
  227. package/dist/rules/token/blanks-around-tables.d.ts.map +1 -0
  228. package/dist/rules/token/blanks-around-tables.js +42 -0
  229. package/dist/rules/token/blanks-around-tables.js.map +1 -0
  230. package/dist/rules/token/code-block-style.d.ts +3 -0
  231. package/dist/rules/token/code-block-style.d.ts.map +1 -0
  232. package/dist/rules/token/code-block-style.js +30 -0
  233. package/dist/rules/token/code-block-style.js.map +1 -0
  234. package/dist/rules/token/code-fence-style.d.ts +3 -0
  235. package/dist/rules/token/code-fence-style.d.ts.map +1 -0
  236. package/dist/rules/token/code-fence-style.js +35 -0
  237. package/dist/rules/token/code-fence-style.js.map +1 -0
  238. package/dist/rules/token/commands-show-output.d.ts +3 -0
  239. package/dist/rules/token/commands-show-output.d.ts.map +1 -0
  240. package/dist/rules/token/commands-show-output.js +38 -0
  241. package/dist/rules/token/commands-show-output.js.map +1 -0
  242. package/dist/rules/token/descriptive-link-text.d.ts +3 -0
  243. package/dist/rules/token/descriptive-link-text.d.ts.map +1 -0
  244. package/dist/rules/token/descriptive-link-text.js +53 -0
  245. package/dist/rules/token/descriptive-link-text.js.map +1 -0
  246. package/dist/rules/token/emphasis-style.d.ts +3 -0
  247. package/dist/rules/token/emphasis-style.d.ts.map +1 -0
  248. package/dist/rules/token/emphasis-style.js +51 -0
  249. package/dist/rules/token/emphasis-style.js.map +1 -0
  250. package/dist/rules/token/fenced-code-language.d.ts +3 -0
  251. package/dist/rules/token/fenced-code-language.d.ts.map +1 -0
  252. package/dist/rules/token/fenced-code-language.js +35 -0
  253. package/dist/rules/token/fenced-code-language.js.map +1 -0
  254. package/dist/rules/token/first-line-h1.d.ts +3 -0
  255. package/dist/rules/token/first-line-h1.d.ts.map +1 -0
  256. package/dist/rules/token/first-line-h1.js +107 -0
  257. package/dist/rules/token/first-line-h1.js.map +1 -0
  258. package/dist/rules/token/heading-increment.d.ts +3 -0
  259. package/dist/rules/token/heading-increment.d.ts.map +1 -0
  260. package/dist/rules/token/heading-increment.js +27 -0
  261. package/dist/rules/token/heading-increment.js.map +1 -0
  262. package/dist/rules/token/heading-start-left.d.ts +3 -0
  263. package/dist/rules/token/heading-start-left.d.ts.map +1 -0
  264. package/dist/rules/token/heading-start-left.js +31 -0
  265. package/dist/rules/token/heading-start-left.js.map +1 -0
  266. package/dist/rules/token/heading-style.d.ts +3 -0
  267. package/dist/rules/token/heading-style.d.ts.map +1 -0
  268. package/dist/rules/token/heading-style.js +41 -0
  269. package/dist/rules/token/heading-style.js.map +1 -0
  270. package/dist/rules/token/helpers.d.ts +313 -0
  271. package/dist/rules/token/helpers.d.ts.map +1 -0
  272. package/dist/rules/token/helpers.js +746 -0
  273. package/dist/rules/token/helpers.js.map +1 -0
  274. package/dist/rules/token/hr-style.d.ts +3 -0
  275. package/dist/rules/token/hr-style.d.ts.map +1 -0
  276. package/dist/rules/token/hr-style.js +28 -0
  277. package/dist/rules/token/hr-style.js.map +1 -0
  278. package/dist/rules/token/index.d.ts +75 -0
  279. package/dist/rules/token/index.d.ts.map +1 -0
  280. package/dist/rules/token/index.js +226 -0
  281. package/dist/rules/token/index.js.map +1 -0
  282. package/dist/rules/token/line-length.d.ts +3 -0
  283. package/dist/rules/token/line-length.d.ts.map +1 -0
  284. package/dist/rules/token/line-length.js +120 -0
  285. package/dist/rules/token/line-length.js.map +1 -0
  286. package/dist/rules/token/link-fragments.d.ts +3 -0
  287. package/dist/rules/token/link-fragments.d.ts.map +1 -0
  288. package/dist/rules/token/link-fragments.js +145 -0
  289. package/dist/rules/token/link-fragments.js.map +1 -0
  290. package/dist/rules/token/link-image-reference-definitions.d.ts +3 -0
  291. package/dist/rules/token/link-image-reference-definitions.d.ts.map +1 -0
  292. package/dist/rules/token/link-image-reference-definitions.js +50 -0
  293. package/dist/rules/token/link-image-reference-definitions.js.map +1 -0
  294. package/dist/rules/token/link-image-style.d.ts +3 -0
  295. package/dist/rules/token/link-image-style.d.ts.map +1 -0
  296. package/dist/rules/token/link-image-style.js +131 -0
  297. package/dist/rules/token/link-image-style.js.map +1 -0
  298. package/dist/rules/token/list-indent.d.ts +3 -0
  299. package/dist/rules/token/list-indent.d.ts.map +1 -0
  300. package/dist/rules/token/list-indent.js +60 -0
  301. package/dist/rules/token/list-indent.js.map +1 -0
  302. package/dist/rules/token/list-length.d.ts +3 -0
  303. package/dist/rules/token/list-length.d.ts.map +1 -0
  304. package/dist/rules/token/list-length.js +55 -0
  305. package/dist/rules/token/list-length.js.map +1 -0
  306. package/dist/rules/token/list-marker-space.d.ts +3 -0
  307. package/dist/rules/token/list-marker-space.d.ts.map +1 -0
  308. package/dist/rules/token/list-marker-space.js +52 -0
  309. package/dist/rules/token/list-marker-space.js.map +1 -0
  310. package/dist/rules/token/markdoc-attributes.d.ts +3 -0
  311. package/dist/rules/token/markdoc-attributes.d.ts.map +1 -0
  312. package/dist/rules/token/markdoc-attributes.js +269 -0
  313. package/dist/rules/token/markdoc-attributes.js.map +1 -0
  314. package/dist/rules/token/markdoc-pairing.d.ts +3 -0
  315. package/dist/rules/token/markdoc-pairing.d.ts.map +1 -0
  316. package/dist/rules/token/markdoc-pairing.js +73 -0
  317. package/dist/rules/token/markdoc-pairing.js.map +1 -0
  318. package/dist/rules/token/markdoc-syntax.d.ts +3 -0
  319. package/dist/rules/token/markdoc-syntax.d.ts.map +1 -0
  320. package/dist/rules/token/markdoc-syntax.js +119 -0
  321. package/dist/rules/token/markdoc-syntax.js.map +1 -0
  322. package/dist/rules/token/markdoc-unknown-tag.d.ts +3 -0
  323. package/dist/rules/token/markdoc-unknown-tag.d.ts.map +1 -0
  324. package/dist/rules/token/markdoc-unknown-tag.js +64 -0
  325. package/dist/rules/token/markdoc-unknown-tag.js.map +1 -0
  326. package/dist/rules/token/messages.d.ts +4 -0
  327. package/dist/rules/token/messages.d.ts.map +1 -0
  328. package/dist/rules/token/messages.js +20 -0
  329. package/dist/rules/token/messages.js.map +1 -0
  330. package/dist/rules/token/no-alt-text.d.ts +3 -0
  331. package/dist/rules/token/no-alt-text.d.ts.map +1 -0
  332. package/dist/rules/token/no-alt-text.js +47 -0
  333. package/dist/rules/token/no-alt-text.js.map +1 -0
  334. package/dist/rules/token/no-bare-urls.d.ts +3 -0
  335. package/dist/rules/token/no-bare-urls.d.ts.map +1 -0
  336. package/dist/rules/token/no-bare-urls.js +88 -0
  337. package/dist/rules/token/no-bare-urls.js.map +1 -0
  338. package/dist/rules/token/no-blanks-blockquote.d.ts +3 -0
  339. package/dist/rules/token/no-blanks-blockquote.d.ts.map +1 -0
  340. package/dist/rules/token/no-blanks-blockquote.js +39 -0
  341. package/dist/rules/token/no-blanks-blockquote.js.map +1 -0
  342. package/dist/rules/token/no-duplicate-heading.d.ts +3 -0
  343. package/dist/rules/token/no-duplicate-heading.d.ts.map +1 -0
  344. package/dist/rules/token/no-duplicate-heading.js +101 -0
  345. package/dist/rules/token/no-duplicate-heading.js.map +1 -0
  346. package/dist/rules/token/no-duplicate-link-destinations.d.ts +3 -0
  347. package/dist/rules/token/no-duplicate-link-destinations.d.ts.map +1 -0
  348. package/dist/rules/token/no-duplicate-link-destinations.js +65 -0
  349. package/dist/rules/token/no-duplicate-link-destinations.js.map +1 -0
  350. package/dist/rules/token/no-emphasis-as-heading.d.ts +3 -0
  351. package/dist/rules/token/no-emphasis-as-heading.d.ts.map +1 -0
  352. package/dist/rules/token/no-emphasis-as-heading.js +44 -0
  353. package/dist/rules/token/no-emphasis-as-heading.js.map +1 -0
  354. package/dist/rules/token/no-empty-headings.d.ts +3 -0
  355. package/dist/rules/token/no-empty-headings.d.ts.map +1 -0
  356. package/dist/rules/token/no-empty-headings.js +28 -0
  357. package/dist/rules/token/no-empty-headings.js.map +1 -0
  358. package/dist/rules/token/no-empty-links.d.ts +3 -0
  359. package/dist/rules/token/no-empty-links.d.ts.map +1 -0
  360. package/dist/rules/token/no-empty-links.js +67 -0
  361. package/dist/rules/token/no-empty-links.js.map +1 -0
  362. package/dist/rules/token/no-hard-tabs.d.ts +3 -0
  363. package/dist/rules/token/no-hard-tabs.d.ts.map +1 -0
  364. package/dist/rules/token/no-hard-tabs.js +76 -0
  365. package/dist/rules/token/no-hard-tabs.js.map +1 -0
  366. package/dist/rules/token/no-inline-html.d.ts +3 -0
  367. package/dist/rules/token/no-inline-html.d.ts.map +1 -0
  368. package/dist/rules/token/no-inline-html.js +45 -0
  369. package/dist/rules/token/no-inline-html.js.map +1 -0
  370. package/dist/rules/token/no-missing-space-atx.d.ts +3 -0
  371. package/dist/rules/token/no-missing-space-atx.d.ts.map +1 -0
  372. package/dist/rules/token/no-missing-space-atx.js +36 -0
  373. package/dist/rules/token/no-missing-space-atx.js.map +1 -0
  374. package/dist/rules/token/no-missing-space-closed-atx.d.ts +3 -0
  375. package/dist/rules/token/no-missing-space-closed-atx.d.ts.map +1 -0
  376. package/dist/rules/token/no-missing-space-closed-atx.js +45 -0
  377. package/dist/rules/token/no-missing-space-closed-atx.js.map +1 -0
  378. package/dist/rules/token/no-multiple-blanks.d.ts +3 -0
  379. package/dist/rules/token/no-multiple-blanks.d.ts.map +1 -0
  380. package/dist/rules/token/no-multiple-blanks.js +35 -0
  381. package/dist/rules/token/no-multiple-blanks.js.map +1 -0
  382. package/dist/rules/token/no-multiple-space-atx.d.ts +13 -0
  383. package/dist/rules/token/no-multiple-space-atx.d.ts.map +1 -0
  384. package/dist/rules/token/no-multiple-space-atx.js +50 -0
  385. package/dist/rules/token/no-multiple-space-atx.js.map +1 -0
  386. package/dist/rules/token/no-multiple-space-blockquote.d.ts +3 -0
  387. package/dist/rules/token/no-multiple-space-blockquote.d.ts.map +1 -0
  388. package/dist/rules/token/no-multiple-space-blockquote.js +43 -0
  389. package/dist/rules/token/no-multiple-space-blockquote.js.map +1 -0
  390. package/dist/rules/token/no-multiple-space-closed-atx.d.ts +3 -0
  391. package/dist/rules/token/no-multiple-space-closed-atx.d.ts.map +1 -0
  392. package/dist/rules/token/no-multiple-space-closed-atx.js +19 -0
  393. package/dist/rules/token/no-multiple-space-closed-atx.js.map +1 -0
  394. package/dist/rules/token/no-reversed-links.d.ts +3 -0
  395. package/dist/rules/token/no-reversed-links.d.ts.map +1 -0
  396. package/dist/rules/token/no-reversed-links.js +52 -0
  397. package/dist/rules/token/no-reversed-links.js.map +1 -0
  398. package/dist/rules/token/no-space-in-code.d.ts +3 -0
  399. package/dist/rules/token/no-space-in-code.d.ts.map +1 -0
  400. package/dist/rules/token/no-space-in-code.js +75 -0
  401. package/dist/rules/token/no-space-in-code.js.map +1 -0
  402. package/dist/rules/token/no-space-in-emphasis.d.ts +3 -0
  403. package/dist/rules/token/no-space-in-emphasis.d.ts.map +1 -0
  404. package/dist/rules/token/no-space-in-emphasis.js +79 -0
  405. package/dist/rules/token/no-space-in-emphasis.js.map +1 -0
  406. package/dist/rules/token/no-space-in-links.d.ts +3 -0
  407. package/dist/rules/token/no-space-in-links.d.ts.map +1 -0
  408. package/dist/rules/token/no-space-in-links.js +48 -0
  409. package/dist/rules/token/no-space-in-links.js.map +1 -0
  410. package/dist/rules/token/no-trailing-punctuation.d.ts +3 -0
  411. package/dist/rules/token/no-trailing-punctuation.d.ts.map +1 -0
  412. package/dist/rules/token/no-trailing-punctuation.js +38 -0
  413. package/dist/rules/token/no-trailing-punctuation.js.map +1 -0
  414. package/dist/rules/token/no-trailing-spaces.d.ts +3 -0
  415. package/dist/rules/token/no-trailing-spaces.d.ts.map +1 -0
  416. package/dist/rules/token/no-trailing-spaces.js +89 -0
  417. package/dist/rules/token/no-trailing-spaces.js.map +1 -0
  418. package/dist/rules/token/ol-prefix.d.ts +3 -0
  419. package/dist/rules/token/ol-prefix.d.ts.map +1 -0
  420. package/dist/rules/token/ol-prefix.js +70 -0
  421. package/dist/rules/token/ol-prefix.js.map +1 -0
  422. package/dist/rules/token/proper-names.d.ts +3 -0
  423. package/dist/rules/token/proper-names.d.ts.map +1 -0
  424. package/dist/rules/token/proper-names.js +93 -0
  425. package/dist/rules/token/proper-names.js.map +1 -0
  426. package/dist/rules/token/reference-links-images.d.ts +3 -0
  427. package/dist/rules/token/reference-links-images.d.ts.map +1 -0
  428. package/dist/rules/token/reference-links-images.js +36 -0
  429. package/dist/rules/token/reference-links-images.js.map +1 -0
  430. package/dist/rules/token/required-headings.d.ts +3 -0
  431. package/dist/rules/token/required-headings.d.ts.map +1 -0
  432. package/dist/rules/token/required-headings.js +83 -0
  433. package/dist/rules/token/required-headings.js.map +1 -0
  434. package/dist/rules/token/single-h1.d.ts +3 -0
  435. package/dist/rules/token/single-h1.d.ts.map +1 -0
  436. package/dist/rules/token/single-h1.js +56 -0
  437. package/dist/rules/token/single-h1.js.map +1 -0
  438. package/dist/rules/token/single-trailing-newline.d.ts +3 -0
  439. package/dist/rules/token/single-trailing-newline.d.ts.map +1 -0
  440. package/dist/rules/token/single-trailing-newline.js +25 -0
  441. package/dist/rules/token/single-trailing-newline.js.map +1 -0
  442. package/dist/rules/token/strong-style.d.ts +3 -0
  443. package/dist/rules/token/strong-style.d.ts.map +1 -0
  444. package/dist/rules/token/strong-style.js +51 -0
  445. package/dist/rules/token/strong-style.js.map +1 -0
  446. package/dist/rules/token/table-column-count.d.ts +3 -0
  447. package/dist/rules/token/table-column-count.d.ts.map +1 -0
  448. package/dist/rules/token/table-column-count.js +44 -0
  449. package/dist/rules/token/table-column-count.js.map +1 -0
  450. package/dist/rules/token/table-column-style.d.ts +3 -0
  451. package/dist/rules/token/table-column-style.d.ts.map +1 -0
  452. package/dist/rules/token/table-column-style.js +179 -0
  453. package/dist/rules/token/table-column-style.js.map +1 -0
  454. package/dist/rules/token/table-pipe-style.d.ts +3 -0
  455. package/dist/rules/token/table-pipe-style.d.ts.map +1 -0
  456. package/dist/rules/token/table-pipe-style.js +54 -0
  457. package/dist/rules/token/table-pipe-style.js.map +1 -0
  458. package/dist/rules/token/ul-indent.d.ts +3 -0
  459. package/dist/rules/token/ul-indent.d.ts.map +1 -0
  460. package/dist/rules/token/ul-indent.js +72 -0
  461. package/dist/rules/token/ul-indent.js.map +1 -0
  462. package/dist/rules/token/ul-style.d.ts +3 -0
  463. package/dist/rules/token/ul-style.d.ts.map +1 -0
  464. package/dist/rules/token/ul-style.js +80 -0
  465. package/dist/rules/token/ul-style.js.map +1 -0
  466. package/dist/rules/types.d.ts +81 -0
  467. package/dist/rules/types.d.ts.map +1 -0
  468. package/dist/rules/types.js +2 -0
  469. package/dist/rules/types.js.map +1 -0
  470. package/dist/rules/utils.d.ts +29 -0
  471. package/dist/rules/utils.d.ts.map +1 -0
  472. package/dist/{assertions → rules}/utils.js +27 -0
  473. package/dist/rules/utils.js.map +1 -0
  474. package/dist/scopes/extractor.d.ts +7 -0
  475. package/dist/scopes/extractor.d.ts.map +1 -0
  476. package/dist/scopes/extractor.js +475 -0
  477. package/dist/scopes/extractor.js.map +1 -0
  478. package/dist/scopes/selector.d.ts +51 -0
  479. package/dist/scopes/selector.d.ts.map +1 -0
  480. package/dist/scopes/selector.js +121 -0
  481. package/dist/scopes/selector.js.map +1 -0
  482. package/dist/scopes/sentences.d.ts +7 -0
  483. package/dist/scopes/sentences.d.ts.map +1 -0
  484. package/dist/scopes/sentences.js +115 -0
  485. package/dist/scopes/sentences.js.map +1 -0
  486. package/dist/scopes/types.d.ts +44 -0
  487. package/dist/scopes/types.d.ts.map +1 -0
  488. package/dist/scopes/types.js +2 -0
  489. package/dist/scopes/types.js.map +1 -0
  490. package/dist/scopes/vocabulary.d.ts +16 -0
  491. package/dist/scopes/vocabulary.d.ts.map +1 -0
  492. package/dist/scopes/vocabulary.js +70 -0
  493. package/dist/scopes/vocabulary.js.map +1 -0
  494. package/dist/types/assertions.d.ts +95 -32
  495. package/dist/types/assertions.d.ts.map +1 -1
  496. package/dist/types/problems.d.ts +4 -5
  497. package/dist/types/problems.d.ts.map +1 -1
  498. package/dist/types/rules.d.ts +4 -6
  499. package/dist/types/rules.d.ts.map +1 -1
  500. package/examples/appendices/google.appendix.yaml +91 -0
  501. package/examples/appendices/inclusive-language.appendix.yaml +61 -0
  502. package/examples/appendices/microsoft.appendix.yaml +99 -0
  503. package/examples/appendices/plain-language.appendix.yaml +88 -0
  504. package/examples/google.yaml +1525 -0
  505. package/examples/inclusive-language.yaml +304 -0
  506. package/examples/microsoft.yaml +1542 -0
  507. package/examples/plain-language.yaml +325 -0
  508. package/package.json +49 -16
  509. package/presets/google/PROVENANCE.md +1022 -0
  510. package/presets/google/sources.json +192 -0
  511. package/presets/inclusive-language/PROVENANCE.md +174 -0
  512. package/presets/inclusive-language/sources.json +107 -0
  513. package/presets/microsoft/PROVENANCE.md +1555 -0
  514. package/presets/microsoft/sources.json +494 -0
  515. package/presets/plain-language/PROVENANCE.md +364 -0
  516. package/presets/plain-language/sources.json +108 -0
  517. package/dist/assertions/bullet-style.d.ts +0 -3
  518. package/dist/assertions/bullet-style.d.ts.map +0 -1
  519. package/dist/assertions/bullet-style.js +0 -60
  520. package/dist/assertions/bullet-style.js.map +0 -1
  521. package/dist/assertions/index.d.ts +0 -21
  522. package/dist/assertions/index.d.ts.map +0 -1
  523. package/dist/assertions/index.js +0 -30
  524. package/dist/assertions/index.js.map +0 -1
  525. package/dist/assertions/max-image-size.d.ts +0 -3
  526. package/dist/assertions/max-image-size.d.ts.map +0 -1
  527. package/dist/assertions/max-image-size.js +0 -73
  528. package/dist/assertions/max-image-size.js.map +0 -1
  529. package/dist/assertions/max-line-length.d.ts +0 -3
  530. package/dist/assertions/max-line-length.d.ts.map +0 -1
  531. package/dist/assertions/max-line-length.js +0 -68
  532. package/dist/assertions/max-line-length.js.map +0 -1
  533. package/dist/assertions/no-broken-fragment-links.d.ts +0 -3
  534. package/dist/assertions/no-broken-fragment-links.d.ts.map +0 -1
  535. package/dist/assertions/no-broken-fragment-links.js +0 -79
  536. package/dist/assertions/no-broken-fragment-links.js.map +0 -1
  537. package/dist/assertions/no-duplicate-headings.d.ts +0 -3
  538. package/dist/assertions/no-duplicate-headings.d.ts.map +0 -1
  539. package/dist/assertions/no-duplicate-headings.js +0 -66
  540. package/dist/assertions/no-duplicate-headings.js.map +0 -1
  541. package/dist/assertions/no-hard-tabs.d.ts +0 -3
  542. package/dist/assertions/no-hard-tabs.d.ts.map +0 -1
  543. package/dist/assertions/no-hard-tabs.js +0 -63
  544. package/dist/assertions/no-hard-tabs.js.map +0 -1
  545. package/dist/assertions/no-trailing-spaces.d.ts +0 -3
  546. package/dist/assertions/no-trailing-spaces.d.ts.map +0 -1
  547. package/dist/assertions/no-trailing-spaces.js +0 -72
  548. package/dist/assertions/no-trailing-spaces.js.map +0 -1
  549. package/dist/assertions/pattern.d.ts +0 -3
  550. package/dist/assertions/pattern.d.ts.map +0 -1
  551. package/dist/assertions/pattern.js +0 -39
  552. package/dist/assertions/pattern.js.map +0 -1
  553. package/dist/assertions/semantic-line-breaks.d.ts +0 -3
  554. package/dist/assertions/semantic-line-breaks.d.ts.map +0 -1
  555. package/dist/assertions/semantic-line-breaks.js +0 -152
  556. package/dist/assertions/semantic-line-breaks.js.map +0 -1
  557. package/dist/assertions/swap.d.ts +0 -3
  558. package/dist/assertions/swap.d.ts.map +0 -1
  559. package/dist/assertions/swap.js +0 -39
  560. package/dist/assertions/swap.js.map +0 -1
  561. package/dist/assertions/utils.d.ts +0 -8
  562. package/dist/assertions/utils.d.ts.map +0 -1
  563. package/dist/assertions/utils.js.map +0 -1
  564. package/dist/core/scope-parser.d.ts +0 -26
  565. package/dist/core/scope-parser.d.ts.map +0 -1
  566. package/dist/core/scope-parser.js +0 -110
  567. package/dist/core/scope-parser.js.map +0 -1
  568. package/dist/files.d.ts +0 -2
  569. package/dist/files.d.ts.map +0 -1
  570. package/dist/files.js +0 -39
  571. package/dist/files.js.map +0 -1
  572. package/dist/load-config.d.ts +0 -25
  573. package/dist/load-config.d.ts.map +0 -1
  574. package/dist/load-config.js +0 -104
  575. package/dist/load-config.js.map +0 -1
  576. package/dist/load.d.ts +0 -25
  577. package/dist/load.d.ts.map +0 -1
  578. package/dist/load.js +0 -112
  579. package/dist/load.js.map +0 -1
  580. package/dist/scope.d.ts +0 -26
  581. package/dist/scope.d.ts.map +0 -1
  582. package/dist/scope.js +0 -110
  583. package/dist/scope.js.map +0 -1
  584. package/dist/types.d.ts +0 -109
  585. package/dist/types.d.ts.map +0 -1
  586. package/dist/types.js.map +0 -1
  587. package/dist/validate.d.ts +0 -31
  588. package/dist/validate.d.ts.map +0 -1
  589. package/dist/validate.js +0 -154
  590. package/dist/validate.js.map +0 -1
  591. /package/dist/{types.js → parser/types.js} +0 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"code-fence-style.d.ts","sourceRoot":"","sources":["../../../src/rules/token/code-fence-style.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAQ7C,eAAO,MAAM,cAAc,EAAE,SA4B5B,CAAC"}
@@ -0,0 +1,35 @@
1
+ import { filterByTypes } from '../../parser/index.js';
2
+ import { getDescendantsByType } from './helpers.js';
3
+ function fencedCodeBlockStyleFor(markup) {
4
+ return markup[0] === '~' ? 'tilde' : 'backtick';
5
+ }
6
+ export const codeFenceStyle = {
7
+ name: 'code-fence-style',
8
+ tags: ['code'],
9
+ fixable: false,
10
+ defaults: {
11
+ message: 'Code fence style',
12
+ style: 'consistent',
13
+ },
14
+ check(ctx) {
15
+ let expectedStyle = String(ctx.config.style || 'consistent');
16
+ for (const codeFenced of filterByTypes(ctx.tree, ['codeFenced'])) {
17
+ const codeFencedFenceSequence = getDescendantsByType(codeFenced, [
18
+ 'codeFencedFence',
19
+ 'codeFencedFenceSequence',
20
+ ])[0];
21
+ const { startLine, text } = codeFencedFenceSequence;
22
+ if (expectedStyle === 'consistent') {
23
+ expectedStyle = fencedCodeBlockStyleFor(text);
24
+ }
25
+ const actualStyle = fencedCodeBlockStyleFor(text);
26
+ if (expectedStyle !== actualStyle) {
27
+ ctx.onError({
28
+ line: startLine,
29
+ detail: `Expected: ${expectedStyle}; Actual: ${actualStyle}`,
30
+ });
31
+ }
32
+ }
33
+ },
34
+ };
35
+ //# sourceMappingURL=code-fence-style.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"code-fence-style.js","sourceRoot":"","sources":["../../../src/rules/token/code-fence-style.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,SAAS,uBAAuB,CAAC,MAAc;IAC7C,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAc;IACvC,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE;QACR,OAAO,EAAE,kBAAkB;QAC3B,KAAK,EAAE,YAAY;KACpB;IACD,KAAK,CAAC,GAAG;QACP,IAAI,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC,CAAC;QAC7D,KAAK,MAAM,UAAU,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YACjE,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,UAAU,EAAE;gBAC/D,iBAAiB;gBACjB,yBAAyB;aAC1B,CAAC,CAAC,CAAC,CAAC,CAAC;YACN,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,uBAAuB,CAAC;YACpD,IAAI,aAAa,KAAK,YAAY,EAAE,CAAC;gBACnC,aAAa,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;YAChD,CAAC;YACD,MAAM,WAAW,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;YAClD,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBAClC,GAAG,CAAC,OAAO,CAAC;oBACV,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,aAAa,aAAa,aAAa,WAAW,EAAE;iBAC7D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const commandsShowOutput: TokenRule;
3
+ //# sourceMappingURL=commands-show-output.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands-show-output.d.ts","sourceRoot":"","sources":["../../../src/rules/token/commands-show-output.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAK7C,eAAO,MAAM,kBAAkB,EAAE,SAqChC,CAAC"}
@@ -0,0 +1,38 @@
1
+ import { filterByTypes } from '../../parser/index.js';
2
+ const dollarCommandRe = /^(\s*)(\$\s+)/;
3
+ export const commandsShowOutput = {
4
+ name: 'commands-show-output',
5
+ tags: ['code'],
6
+ fixable: true,
7
+ defaults: {
8
+ message: 'Dollar signs used before commands without showing output',
9
+ },
10
+ check(ctx) {
11
+ for (const codeBlock of filterByTypes(ctx.tree, ['codeFenced', 'codeIndented'])) {
12
+ const codeFlowValues = codeBlock.children.filter((child) => child.type === 'codeFlowValue');
13
+ const dollarMatches = codeFlowValues
14
+ .map((codeFlowValue) => ({
15
+ result: dollarCommandRe.exec(codeFlowValue.text),
16
+ startColumn: codeFlowValue.startColumn,
17
+ startLine: codeFlowValue.startLine,
18
+ }))
19
+ .filter((dollarMatch) => dollarMatch.result !== null);
20
+ if (dollarMatches.length === codeFlowValues.length) {
21
+ for (const dollarMatch of dollarMatches) {
22
+ const column = dollarMatch.startColumn + dollarMatch.result[1].length;
23
+ const length = dollarMatch.result[2].length;
24
+ ctx.onError({
25
+ line: dollarMatch.startLine,
26
+ column,
27
+ fixInfo: {
28
+ lineNumber: dollarMatch.startLine,
29
+ editColumn: column,
30
+ deleteCount: length,
31
+ },
32
+ });
33
+ }
34
+ }
35
+ }
36
+ },
37
+ };
38
+ //# sourceMappingURL=commands-show-output.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands-show-output.js","sourceRoot":"","sources":["../../../src/rules/token/commands-show-output.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,MAAM,eAAe,GAAG,eAAe,CAAC;AAExC,MAAM,CAAC,MAAM,kBAAkB,GAAc;IAC3C,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE;QACR,OAAO,EAAE,0DAA0D;KACpE;IACD,KAAK,CAAC,GAAG;QACP,KAAK,MAAM,SAAS,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC;YAChF,MAAM,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC;YAC5F,MAAM,aAAa,GAAG,cAAc;iBACjC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBACvB,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;gBAChD,WAAW,EAAE,aAAa,CAAC,WAAW;gBACtC,SAAS,EAAE,aAAa,CAAC,SAAS;aACnC,CAAC,CAAC;iBACF,MAAM,CACL,CAAC,WAAW,EAAmE,EAAE,CAC/E,WAAW,CAAC,MAAM,KAAK,IAAI,CAC9B,CAAC;YACJ,IAAI,aAAa,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,EAAE,CAAC;gBACnD,KAAK,MAAM,WAAW,IAAI,aAAa,EAAE,CAAC;oBACxC,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;oBACtE,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;oBAC5C,GAAG,CAAC,OAAO,CAAC;wBACV,IAAI,EAAE,WAAW,CAAC,SAAS;wBAC3B,MAAM;wBACN,OAAO,EAAE;4BACP,UAAU,EAAE,WAAW,CAAC,SAAS;4BACjC,UAAU,EAAE,MAAM;4BAClB,WAAW,EAAE,MAAM;yBACpB;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const descriptiveLinkText: TokenRule;
3
+ //# sourceMappingURL=descriptive-link-text.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"descriptive-link-text.d.ts","sourceRoot":"","sources":["../../../src/rules/token/descriptive-link-text.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAgB7C,eAAO,MAAM,mBAAmB,EAAE,SA4CjC,CAAC"}
@@ -0,0 +1,53 @@
1
+ import { filterByTypes } from '../../parser/index.js';
2
+ import { getDescendantsByType } from './helpers.js';
3
+ const allowedChildrenTypes = new Set(['codeText', 'htmlText']);
4
+ const defaultProhibitedTexts = ['click here', 'here', 'link', 'more'];
5
+ /** Normalizes a string by removing extra whitespace and punctuation. */
6
+ function normalize(str) {
7
+ return str
8
+ .replace(/[\W_]+/g, ' ')
9
+ .replace(/\s+/g, ' ')
10
+ .toLowerCase()
11
+ .trim();
12
+ }
13
+ export const descriptiveLinkText = {
14
+ name: 'descriptive-link-text',
15
+ tags: ['accessibility', 'links'],
16
+ fixable: false,
17
+ defaults: {
18
+ message: 'Link text should be descriptive',
19
+ prohibitedTexts: defaultProhibitedTexts,
20
+ },
21
+ check(ctx) {
22
+ const configuredProhibited = ctx.config.prohibitedTexts;
23
+ // Matches upstream's `config.prohibited_texts || defaultProhibitedTexts`
24
+ // (md059.mjs): an explicitly configured empty array is truthy in JS, so
25
+ // it is used as-is (yielding an empty Set below, which disables the
26
+ // rule) rather than falling back to the defaults -- only a missing/
27
+ // non-array value falls back. Mirrors the other array-option rules in
28
+ // this batch (e.g. reference-links-images's ignoredLabels), which all
29
+ // use a plain `Array.isArray(...) ? ... : defaults` with no additional
30
+ // length check.
31
+ const prohibitedTexts = new Set((Array.isArray(configuredProhibited)
32
+ ? configuredProhibited.map(String)
33
+ : defaultProhibitedTexts).map(normalize));
34
+ if (prohibitedTexts.size === 0)
35
+ return;
36
+ for (const link of filterByTypes(ctx.tree, ['link'])) {
37
+ const labelTexts = getDescendantsByType(link, ['label', 'labelText']);
38
+ for (const labelText of labelTexts) {
39
+ const { children, endLine, parent, startColumn, startLine, text } = labelText;
40
+ if (!children.some((child) => allowedChildrenTypes.has(child.type)) &&
41
+ prohibitedTexts.has(normalize(text))) {
42
+ const hasRange = startLine === endLine;
43
+ ctx.onError({
44
+ line: startLine,
45
+ column: hasRange ? startColumn : undefined,
46
+ context: hasRange ? (parent?.text ?? text) : undefined,
47
+ });
48
+ }
49
+ }
50
+ }
51
+ },
52
+ };
53
+ //# sourceMappingURL=descriptive-link-text.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"descriptive-link-text.js","sourceRoot":"","sources":["../../../src/rules/token/descriptive-link-text.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAC/D,MAAM,sBAAsB,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtE,wEAAwE;AACxE,SAAS,SAAS,CAAC,GAAW;IAC5B,OAAO,GAAG;SACP,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,WAAW,EAAE;SACb,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAc;IAC5C,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,CAAC,eAAe,EAAE,OAAO,CAAC;IAChC,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE;QACR,OAAO,EAAE,iCAAiC;QAC1C,eAAe,EAAE,sBAAsB;KACxC;IACD,KAAK,CAAC,GAAG;QACP,MAAM,oBAAoB,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC;QACxD,yEAAyE;QACzE,wEAAwE;QACxE,oEAAoE;QACpE,oEAAoE;QACpE,sEAAsE;QACtE,sEAAsE;QACtE,uEAAuE;QACvE,gBAAgB;QAChB,MAAM,eAAe,GAAG,IAAI,GAAG,CAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,CAAC;YAClC,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC;YAClC,CAAC,CAAC,sBAAsB,CACzB,CAAC,GAAG,CAAC,SAAS,CAAC,CACjB,CAAC;QACF,IAAI,eAAe,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QAEvC,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACrD,MAAM,UAAU,GAAG,oBAAoB,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;YACtE,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;gBACnC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;gBAC9E,IACE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC/D,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EACpC,CAAC;oBACD,MAAM,QAAQ,GAAG,SAAS,KAAK,OAAO,CAAC;oBACvC,GAAG,CAAC,OAAO,CAAC;wBACV,IAAI,EAAE,SAAS;wBACf,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;wBAC1C,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;qBACvD,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const emphasisStyle: TokenRule;
3
+ //# sourceMappingURL=emphasis-style.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emphasis-style.d.ts","sourceRoot":"","sources":["../../../src/rules/token/emphasis-style.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAS7C,eAAO,MAAM,aAAa,EAAE,SAkD3B,CAAC"}
@@ -0,0 +1,51 @@
1
+ import { filterByPredicate, getDescendantsByType } from './helpers.js';
2
+ const intrawordRe = /^\w$/;
3
+ function emphasisOrStrongStyleFor(markup) {
4
+ return markup[0] === '*' ? 'asterisk' : 'underscore';
5
+ }
6
+ export const emphasisStyle = {
7
+ name: 'emphasis-style',
8
+ tags: ['emphasis'],
9
+ fixable: true,
10
+ defaults: {
11
+ message: 'Emphasis style',
12
+ style: 'consistent',
13
+ },
14
+ check(ctx) {
15
+ const { lines } = ctx;
16
+ let style = String(ctx.config.style || 'consistent');
17
+ const emphasisTokens = filterByPredicate(ctx.tree, (token) => token.type === 'emphasis', (token) => (token.type === 'htmlFlow' ? [] : token.children));
18
+ for (const token of emphasisTokens) {
19
+ const sequences = getDescendantsByType(token, ['emphasisSequence']);
20
+ const startSequence = sequences[0];
21
+ const endSequence = sequences[sequences.length - 1];
22
+ if (!startSequence || !endSequence)
23
+ continue;
24
+ const markupStyle = emphasisOrStrongStyleFor(startSequence.text);
25
+ if (style === 'consistent') {
26
+ style = markupStyle;
27
+ }
28
+ if (style !== markupStyle) {
29
+ const underscoreIntraword = style === 'underscore' &&
30
+ (intrawordRe.test(lines[startSequence.startLine - 1]?.[startSequence.startColumn - 2] ?? '') ||
31
+ intrawordRe.test(lines[endSequence.endLine - 1]?.[endSequence.endColumn - 1] ?? ''));
32
+ if (!underscoreIntraword) {
33
+ for (const sequence of [startSequence, endSequence]) {
34
+ ctx.onError({
35
+ line: sequence.startLine,
36
+ column: sequence.startColumn,
37
+ detail: `Expected: ${style}; Actual: ${markupStyle}`,
38
+ fixInfo: {
39
+ lineNumber: sequence.startLine,
40
+ editColumn: sequence.startColumn,
41
+ deleteCount: sequence.text.length,
42
+ insertText: style === 'asterisk' ? '*' : '_',
43
+ },
44
+ });
45
+ }
46
+ }
47
+ }
48
+ }
49
+ },
50
+ };
51
+ //# sourceMappingURL=emphasis-style.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emphasis-style.js","sourceRoot":"","sources":["../../../src/rules/token/emphasis-style.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEvE,MAAM,WAAW,GAAG,MAAM,CAAC;AAE3B,SAAS,wBAAwB,CAAC,MAAc;IAC9C,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC;AACvD,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAc;IACtC,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,CAAC,UAAU,CAAC;IAClB,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE;QACR,OAAO,EAAE,gBAAgB;QACzB,KAAK,EAAE,YAAY;KACpB;IACD,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC;QACtB,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC,CAAC;QACrD,MAAM,cAAc,GAAG,iBAAiB,CACtC,GAAG,CAAC,IAAI,EACR,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,EACpC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAC7D,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;YACnC,MAAM,SAAS,GAAG,oBAAoB,CAAC,KAAK,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;YACpE,MAAM,aAAa,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,aAAa,IAAI,CAAC,WAAW;gBAAE,SAAS;YAC7C,MAAM,WAAW,GAAG,wBAAwB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACjE,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;gBAC3B,KAAK,GAAG,WAAW,CAAC;YACtB,CAAC;YACD,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;gBAC1B,MAAM,mBAAmB,GACvB,KAAK,KAAK,YAAY;oBACtB,CAAC,WAAW,CAAC,IAAI,CACf,KAAK,CAAC,aAAa,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,WAAW,GAAG,CAAC,CAAC,IAAI,EAAE,CAC1E;wBACC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gBACzF,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBACzB,KAAK,MAAM,QAAQ,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,CAAC;wBACpD,GAAG,CAAC,OAAO,CAAC;4BACV,IAAI,EAAE,QAAQ,CAAC,SAAS;4BACxB,MAAM,EAAE,QAAQ,CAAC,WAAW;4BAC5B,MAAM,EAAE,aAAa,KAAK,aAAa,WAAW,EAAE;4BACpD,OAAO,EAAE;gCACP,UAAU,EAAE,QAAQ,CAAC,SAAS;gCAC9B,UAAU,EAAE,QAAQ,CAAC,WAAW;gCAChC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;gCACjC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;6BAC7C;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const fencedCodeLanguage: TokenRule;
3
+ //# sourceMappingURL=fenced-code-language.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fenced-code-language.d.ts","sourceRoot":"","sources":["../../../src/rules/token/fenced-code-language.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAI7C,eAAO,MAAM,kBAAkB,EAAE,SA8BhC,CAAC"}
@@ -0,0 +1,35 @@
1
+ import { filterByTypes } from '../../parser/index.js';
2
+ import { getDescendantsByType } from './helpers.js';
3
+ export const fencedCodeLanguage = {
4
+ name: 'fenced-code-language',
5
+ tags: ['code', 'language'],
6
+ fixable: false,
7
+ defaults: {
8
+ message: 'Fenced code blocks should have a language specified',
9
+ allowedLanguages: [],
10
+ languageOnly: false,
11
+ },
12
+ check(ctx) {
13
+ const configured = ctx.config.allowedLanguages;
14
+ const allowed = Array.isArray(configured) ? configured.map(String) : [];
15
+ const languageOnly = !!ctx.config.languageOnly;
16
+ for (const fencedCode of filterByTypes(ctx.tree, ['codeFenced'])) {
17
+ const openingFence = getDescendantsByType(fencedCode, ['codeFencedFence'])[0];
18
+ const { startLine, text } = openingFence;
19
+ const info = getDescendantsByType(openingFence, ['codeFencedFenceInfo'])[0]?.text;
20
+ if (!info) {
21
+ ctx.onError({ line: startLine, context: text });
22
+ }
23
+ else if (allowed.length > 0 && !allowed.includes(info)) {
24
+ ctx.onError({ line: startLine, detail: `"${info}" is not allowed` });
25
+ }
26
+ if (languageOnly && getDescendantsByType(openingFence, ['codeFencedFenceMeta']).length > 0) {
27
+ ctx.onError({
28
+ line: startLine,
29
+ detail: `Info string contains more than language: "${text}"`,
30
+ });
31
+ }
32
+ }
33
+ },
34
+ };
35
+ //# sourceMappingURL=fenced-code-language.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fenced-code-language.js","sourceRoot":"","sources":["../../../src/rules/token/fenced-code-language.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,CAAC,MAAM,kBAAkB,GAAc;IAC3C,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1B,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE;QACR,OAAO,EAAE,qDAAqD;QAC9D,gBAAgB,EAAE,EAAE;QACpB,YAAY,EAAE,KAAK;KACpB;IACD,KAAK,CAAC,GAAG;QACP,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC;QAC/C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAE,UAAwB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,MAAM,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;QAC/C,KAAK,MAAM,UAAU,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YACjE,MAAM,YAAY,GAAG,oBAAoB,CAAC,UAAU,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9E,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC;YACzC,MAAM,IAAI,GAAG,oBAAoB,CAAC,YAAY,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;YAClF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,GAAG,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAClD,CAAC;iBAAM,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzD,GAAG,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,IAAI,kBAAkB,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,YAAY,IAAI,oBAAoB,CAAC,YAAY,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3F,GAAG,CAAC,OAAO,CAAC;oBACV,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,6CAA6C,IAAI,GAAG;iBAC7D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const firstLineH1: TokenRule;
3
+ //# sourceMappingURL=first-line-h1.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"first-line-h1.d.ts","sourceRoot":"","sources":["../../../src/rules/token/first-line-h1.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AA8C7C,eAAO,MAAM,WAAW,EAAE,SAmEzB,CAAC"}
@@ -0,0 +1,107 @@
1
+ import { frontMatterHasTitle, getFrontmatterEndLine, getHeadingLevel, getHtmlTagInfo, isHtmlFlowComment, nonContentTokens, } from './helpers.js';
2
+ const headingTagNameRe = /^h[1-6]$/;
3
+ /**
4
+ * Finds the first descendant of `token` with the given type, at any depth
5
+ * (depth-first, pre-order). Explicit-stack DFS rather than call-stack
6
+ * recursion: this runs over `htmlFlow` tokens whose reparsed subtree depth
7
+ * tracks the block's own (attacker-controlled) markdown nesting, so
8
+ * recursion depth must not track document nesting depth.
9
+ */
10
+ function findDescendantByType(token, type) {
11
+ const stack = [];
12
+ for (let i = token.children.length - 1; i >= 0; i--)
13
+ stack.push(token.children[i]);
14
+ while (stack.length > 0) {
15
+ const current = stack.pop();
16
+ if (current === undefined)
17
+ break;
18
+ if (current.type === type)
19
+ return current;
20
+ for (let i = current.children.length - 1; i >= 0; i--)
21
+ stack.push(current.children[i]);
22
+ }
23
+ return null;
24
+ }
25
+ /**
26
+ * Gets the HTML tag name of an htmlFlow token's first tag, via its
27
+ * (Task 12-added) reparsed `htmlText` descendants — same approach as
28
+ * upstream's own `getHtmlFlowTagName`, which reads off a nested `htmlText`
29
+ * descendant since its parser subtokenizes htmlFlow content the same way
30
+ * (the reparsed content nests `htmlText` under intermediate `content`/
31
+ * `paragraph` wrapper tokens, not as a direct child).
32
+ */
33
+ function getHtmlFlowTagName(token) {
34
+ if (token.type !== 'htmlFlow')
35
+ return null;
36
+ const firstHtmlText = findDescendantByType(token, 'htmlText');
37
+ const tagInfo = firstHtmlText && getHtmlTagInfo(firstHtmlText);
38
+ return tagInfo ? tagInfo.name.toLowerCase() : null;
39
+ }
40
+ export const firstLineH1 = {
41
+ name: 'first-line-h1',
42
+ aliases: ['first-line-heading'],
43
+ tags: ['headings'],
44
+ fixable: false,
45
+ defaults: {
46
+ message: 'First line in a file should be a top-level heading',
47
+ allowPreamble: false,
48
+ frontMatterTitle: '^\\s*"?title"?\\s*[:=]',
49
+ level: 1,
50
+ },
51
+ check(ctx) {
52
+ const allowPreamble = !!ctx.config.allowPreamble;
53
+ const level = Number(ctx.config.level ?? 1);
54
+ // A front matter title counts as the document's top-level heading, fully
55
+ // satisfying this rule — see frontMatterHasTitle's doc comment (upstream
56
+ // `front_matter_title`).
57
+ if (frontMatterHasTitle(ctx.tree, ctx.config.frontMatterTitle))
58
+ return;
59
+ // See getFrontmatterEndLine's doc comment: recheck's parser keeps
60
+ // frontmatter as real tokens in the tree (unlike upstream, which
61
+ // strips it out before tokenizing), so every token through the end of
62
+ // the frontmatter block must be skipped here too — otherwise
63
+ // frontmatter with no recognized title (no `frontMatterTitle` match,
64
+ // e.g. no `title:` key at all) is wrongly treated as containing the
65
+ // document's "first line" content, tripping `!allowPreamble` even
66
+ // when a valid heading immediately follows the frontmatter block.
67
+ const frontmatterEndLine = getFrontmatterEndLine(ctx.tree);
68
+ // Walk TOP-LEVEL tokens only (`ctx.tree.children`), matching upstream:
69
+ // `params.parsers.micromark.tokens` (what md041.mjs iterates) is the
70
+ // document's top-level sibling list, not a depth-first flattening. Using
71
+ // `ctx.tree.flat` here would also visit descendants of the first
72
+ // top-level token -- e.g. an `htmlFlow` HTML-comment block's
73
+ // `htmlFlowData` child -- which `isHtmlFlowComment` only recognizes on
74
+ // the top-level `htmlFlow` token itself, not its children, wrongly
75
+ // treating the comment's inner text as the document's "first line".
76
+ let errorLineNumber = 0;
77
+ for (const token of ctx.tree.children) {
78
+ const { startLine, type } = token;
79
+ if (startLine <= frontmatterEndLine || nonContentTokens.has(type) || isHtmlFlowComment(token))
80
+ continue;
81
+ const tagName = getHtmlFlowTagName(token);
82
+ if (type === 'atxHeading' || type === 'setextHeading') {
83
+ if (getHeadingLevel(token) !== level) {
84
+ errorLineNumber = startLine;
85
+ }
86
+ break;
87
+ }
88
+ else if (tagName && headingTagNameRe.test(tagName)) {
89
+ if (tagName !== `h${level}`) {
90
+ errorLineNumber = startLine;
91
+ }
92
+ break;
93
+ }
94
+ else if (!allowPreamble) {
95
+ errorLineNumber = startLine;
96
+ break;
97
+ }
98
+ }
99
+ if (errorLineNumber > 0) {
100
+ ctx.onError({
101
+ line: errorLineNumber,
102
+ context: ctx.lines[errorLineNumber - 1],
103
+ });
104
+ }
105
+ },
106
+ };
107
+ //# sourceMappingURL=first-line-h1.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"first-line-h1.js","sourceRoot":"","sources":["../../../src/rules/token/first-line-h1.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,cAAc,CAAC;AAEtB,MAAM,gBAAgB,GAAG,UAAU,CAAC;AAEpC;;;;;;GAMG;AACH,SAAS,oBAAoB,CAAC,KAAY,EAAE,IAAY;IACtD,MAAM,KAAK,GAAY,EAAE,CAAC;IAC1B,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACnF,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QAC5B,IAAI,OAAO,KAAK,SAAS;YAAE,MAAM;QACjC,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI;YAAE,OAAO,OAAO,CAAC;QAC1C,KAAK,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACzF,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,kBAAkB,CAAC,KAAY;IACtC,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC;IAC3C,MAAM,aAAa,GAAG,oBAAoB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,aAAa,IAAI,cAAc,CAAC,aAAa,CAAC,CAAC;IAC/D,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAc;IACpC,IAAI,EAAE,eAAe;IACrB,OAAO,EAAE,CAAC,oBAAoB,CAAC;IAC/B,IAAI,EAAE,CAAC,UAAU,CAAC;IAClB,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE;QACR,OAAO,EAAE,oDAAoD;QAC7D,aAAa,EAAE,KAAK;QACpB,gBAAgB,EAAE,wBAAwB;QAC1C,KAAK,EAAE,CAAC;KACT;IACD,KAAK,CAAC,GAAG;QACP,MAAM,aAAa,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;QACjD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QAE5C,yEAAyE;QACzE,yEAAyE;QACzE,yBAAyB;QACzB,IAAI,mBAAmB,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAAE,OAAO;QAEvE,kEAAkE;QAClE,iEAAiE;QACjE,sEAAsE;QACtE,6DAA6D;QAC7D,qEAAqE;QACrE,oEAAoE;QACpE,kEAAkE;QAClE,kEAAkE;QAClE,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE3D,uEAAuE;QACvE,qEAAqE;QACrE,yEAAyE;QACzE,iEAAiE;QACjE,6DAA6D;QAC7D,uEAAuE;QACvE,mEAAmE;QACnE,oEAAoE;QACpE,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;YAClC,IAAI,SAAS,IAAI,kBAAkB,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC;gBAC3F,SAAS;YAEX,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,IAAI,KAAK,YAAY,IAAI,IAAI,KAAK,eAAe,EAAE,CAAC;gBACtD,IAAI,eAAe,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;oBACrC,eAAe,GAAG,SAAS,CAAC;gBAC9B,CAAC;gBACD,MAAM;YACR,CAAC;iBAAM,IAAI,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACrD,IAAI,OAAO,KAAK,IAAI,KAAK,EAAE,EAAE,CAAC;oBAC5B,eAAe,GAAG,SAAS,CAAC;gBAC9B,CAAC;gBACD,MAAM;YACR,CAAC;iBAAM,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC1B,eAAe,GAAG,SAAS,CAAC;gBAC5B,MAAM;YACR,CAAC;QACH,CAAC;QACD,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YACxB,GAAG,CAAC,OAAO,CAAC;gBACV,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,eAAe,GAAG,CAAC,CAAC;aACxC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const headingIncrement: TokenRule;
3
+ //# sourceMappingURL=heading-increment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"heading-increment.d.ts","sourceRoot":"","sources":["../../../src/rules/token/heading-increment.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAI7C,eAAO,MAAM,gBAAgB,EAAE,SAuB9B,CAAC"}
@@ -0,0 +1,27 @@
1
+ import { filterByTypes } from '../../parser/index.js';
2
+ import { frontMatterHasTitle, getHeadingLevel } from './helpers.js';
3
+ export const headingIncrement = {
4
+ name: 'heading-increment',
5
+ tags: ['headings'],
6
+ fixable: false,
7
+ defaults: {
8
+ message: 'Heading levels should only increment by one level at a time.',
9
+ frontMatterTitle: '^\\s*"?title"?\\s*[:=]',
10
+ },
11
+ check(ctx) {
12
+ // A front matter title counts as the document's implicit h1 — see
13
+ // frontMatterHasTitle's doc comment (upstream `front_matter_title`).
14
+ let previous = frontMatterHasTitle(ctx.tree, ctx.config.frontMatterTitle) ? 1 : 0;
15
+ for (const heading of filterByTypes(ctx.tree, ['atxHeading', 'setextHeading'])) {
16
+ const level = getHeadingLevel(heading);
17
+ if (previous && level > previous + 1) {
18
+ ctx.onError({
19
+ line: heading.startLine,
20
+ detail: `Expected: h${previous + 1}; Actual: h${level}`,
21
+ });
22
+ }
23
+ previous = level;
24
+ }
25
+ },
26
+ };
27
+ //# sourceMappingURL=heading-increment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"heading-increment.js","sourceRoot":"","sources":["../../../src/rules/token/heading-increment.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpE,MAAM,CAAC,MAAM,gBAAgB,GAAc;IACzC,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE,CAAC,UAAU,CAAC;IAClB,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE;QACR,OAAO,EAAE,8DAA8D;QACvE,gBAAgB,EAAE,wBAAwB;KAC3C;IACD,KAAK,CAAC,GAAG;QACP,kEAAkE;QAClE,qEAAqE;QACrE,IAAI,QAAQ,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClF,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC;YAC/E,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;YACvC,IAAI,QAAQ,IAAI,KAAK,GAAG,QAAQ,GAAG,CAAC,EAAE,CAAC;gBACrC,GAAG,CAAC,OAAO,CAAC;oBACV,IAAI,EAAE,OAAO,CAAC,SAAS;oBACvB,MAAM,EAAE,cAAc,QAAQ,GAAG,CAAC,cAAc,KAAK,EAAE;iBACxD,CAAC,CAAC;YACL,CAAC;YACD,QAAQ,GAAG,KAAK,CAAC;QACnB,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const headingStartLeft: TokenRule;
3
+ //# sourceMappingURL=heading-start-left.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"heading-start-left.d.ts","sourceRoot":"","sources":["../../../src/rules/token/heading-start-left.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAG7C,eAAO,MAAM,gBAAgB,EAAE,SA8B9B,CAAC"}
@@ -0,0 +1,31 @@
1
+ import { filterByTypes } from '../../parser/index.js';
2
+ export const headingStartLeft = {
3
+ name: 'heading-start-left',
4
+ tags: ['headings', 'spaces'],
5
+ fixable: true,
6
+ defaults: {
7
+ message: 'Headings must start at the beginning of the line',
8
+ },
9
+ check(ctx) {
10
+ const headings = filterByTypes(ctx.tree, ['atxHeading', 'linePrefix', 'setextHeading']);
11
+ for (let i = 0; i < headings.length - 1; i++) {
12
+ if (headings[i].type === 'linePrefix' &&
13
+ headings[i + 1].type !== 'linePrefix' &&
14
+ headings[i].startLine === headings[i + 1].startLine) {
15
+ const { endColumn, startColumn, startLine } = headings[i];
16
+ const length = endColumn - startColumn;
17
+ ctx.onError({
18
+ line: startLine,
19
+ column: startColumn,
20
+ context: ctx.lines[startLine - 1],
21
+ fixInfo: {
22
+ lineNumber: startLine,
23
+ editColumn: startColumn,
24
+ deleteCount: length,
25
+ },
26
+ });
27
+ }
28
+ }
29
+ },
30
+ };
31
+ //# sourceMappingURL=heading-start-left.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"heading-start-left.js","sourceRoot":"","sources":["../../../src/rules/token/heading-start-left.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,MAAM,CAAC,MAAM,gBAAgB,GAAc;IACzC,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC;IAC5B,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE;QACR,OAAO,EAAE,kDAAkD;KAC5D;IACD,KAAK,CAAC,GAAG;QACP,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;QACxF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7C,IACE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY;gBACjC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY;gBACrC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EACnD,CAAC;gBACD,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAC1D,MAAM,MAAM,GAAG,SAAS,GAAG,WAAW,CAAC;gBACvC,GAAG,CAAC,OAAO,CAAC;oBACV,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,WAAW;oBACnB,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;oBACjC,OAAO,EAAE;wBACP,UAAU,EAAE,SAAS;wBACrB,UAAU,EAAE,WAAW;wBACvB,WAAW,EAAE,MAAM;qBACpB;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { TokenRule } from '../types.js';
2
+ export declare const headingStyle: TokenRule;
3
+ //# sourceMappingURL=heading-style.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"heading-style.d.ts","sourceRoot":"","sources":["../../../src/rules/token/heading-style.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAI7C,eAAO,MAAM,YAAY,EAAE,SAsC1B,CAAC"}
@@ -0,0 +1,41 @@
1
+ import { filterByTypes } from '../../parser/index.js';
2
+ import { getHeadingLevel, getHeadingStyle } from './helpers.js';
3
+ export const headingStyle = {
4
+ name: 'heading-style',
5
+ tags: ['headings'],
6
+ fixable: false,
7
+ defaults: {
8
+ message: 'Heading style',
9
+ style: 'consistent',
10
+ },
11
+ check(ctx) {
12
+ let style = String(ctx.config.style ?? 'consistent');
13
+ for (const heading of filterByTypes(ctx.tree, ['atxHeading', 'setextHeading'])) {
14
+ const styleForToken = getHeadingStyle(heading);
15
+ if (style === 'consistent') {
16
+ style = styleForToken;
17
+ }
18
+ if (styleForToken !== style) {
19
+ const h12 = getHeadingLevel(heading) <= 2;
20
+ const setextWithAtx = style === 'setext_with_atx' &&
21
+ ((h12 && styleForToken === 'setext') || (!h12 && styleForToken === 'atx'));
22
+ const setextWithAtxClosed = style === 'setext_with_atx_closed' &&
23
+ ((h12 && styleForToken === 'setext') || (!h12 && styleForToken === 'atx_closed'));
24
+ if (!setextWithAtx && !setextWithAtxClosed) {
25
+ let expected = style;
26
+ if (style === 'setext_with_atx') {
27
+ expected = h12 ? 'setext' : 'atx';
28
+ }
29
+ else if (style === 'setext_with_atx_closed') {
30
+ expected = h12 ? 'setext' : 'atx_closed';
31
+ }
32
+ ctx.onError({
33
+ line: heading.startLine,
34
+ detail: `Expected: ${expected}; Actual: ${styleForToken}`,
35
+ });
36
+ }
37
+ }
38
+ }
39
+ },
40
+ };
41
+ //# sourceMappingURL=heading-style.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"heading-style.js","sourceRoot":"","sources":["../../../src/rules/token/heading-style.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEhE,MAAM,CAAC,MAAM,YAAY,GAAc;IACrC,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,CAAC,UAAU,CAAC;IAClB,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE;QACR,OAAO,EAAE,eAAe;QACxB,KAAK,EAAE,YAAY;KACpB;IACD,KAAK,CAAC,GAAG;QACP,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC,CAAC;QACrD,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC;YAC/E,MAAM,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;YAC/C,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;gBAC3B,KAAK,GAAG,aAAa,CAAC;YACxB,CAAC;YACD,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;gBAC5B,MAAM,GAAG,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC1C,MAAM,aAAa,GACjB,KAAK,KAAK,iBAAiB;oBAC3B,CAAC,CAAC,GAAG,IAAI,aAAa,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,aAAa,KAAK,KAAK,CAAC,CAAC,CAAC;gBAC7E,MAAM,mBAAmB,GACvB,KAAK,KAAK,wBAAwB;oBAClC,CAAC,CAAC,GAAG,IAAI,aAAa,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,aAAa,KAAK,YAAY,CAAC,CAAC,CAAC;gBACpF,IAAI,CAAC,aAAa,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC3C,IAAI,QAAQ,GAAW,KAAK,CAAC;oBAC7B,IAAI,KAAK,KAAK,iBAAiB,EAAE,CAAC;wBAChC,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;oBACpC,CAAC;yBAAM,IAAI,KAAK,KAAK,wBAAwB,EAAE,CAAC;wBAC9C,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;oBAC3C,CAAC;oBACD,GAAG,CAAC,OAAO,CAAC;wBACV,IAAI,EAAE,OAAO,CAAC,SAAS;wBACvB,MAAM,EAAE,aAAa,QAAQ,aAAa,aAAa,EAAE;qBAC1D,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC"}