Debian Codegraph @

.sphinx/.markdownlint/rules.rb

raw
1 rule 'Myst-MD031', 'Fenced code blocks should be surrounded by blank lines' do
2 tags :code, :blank_lines
3 aliases 'blanks-around-fences'
4 check do |doc|
5 errors = []
6 # Some parsers (including kramdown) have trouble detecting fenced code
7 # blocks without surrounding whitespace, so examine the lines directly.
8 in_code = false
9 fence = nil
10 lines = [''] + doc.lines + ['']
11 lines.each_with_index do |line, linenum|
12 line.strip.match(/^(`{3,}|~{3,})/)
13 unless Regexp.last_match(1) &&
14 (
15 !in_code ||
16 (Regexp.last_match(1).slice(0, fence.length) == fence)
17 )
18 next
19 end
20
21 fence = in_code ? nil : Regexp.last_match(1)
22 in_code = !in_code
23 if (in_code && !(lines[linenum - 1].empty? || lines[linenum - 1].match(/^[:\-\*]*\s*\% /))) ||
24 (!in_code && !(lines[linenum + 1].empty? || lines[linenum + 1].match(/^\s*:/)))
25 errors << linenum
26 end
27 end
28 errors
29 end
30 end
31
32
33 rule 'Myst-IDs', 'MyST IDs should be preceded by a blank line' do
34 check do |doc|
35 errors = []
36 ids = doc.matching_text_element_lines(/^\(.+\)=\s*$/)
37 ids.each do |linenum|
38 if (linenum > 1) && !doc.lines[linenum - 2].empty?
39 errors << linenum
40 end
41 end
42 errors.sort
43 end
44 end