summaryrefslogtreecommitdiff
path: root/doc/.markdownlint/rules/tabs_blank_lines.js
blob: e0e2c1a0a9b910ee85018a941847aaf4594a0f97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const { globalPath } = require('../require_helper');
const {
  forEachLine,
  getLineMetadata,
  isBlankLine,
} = require(`${globalPath}/markdownlint-rule-helpers`);

module.exports = {
  names: ['tabs-blank-lines'],
  description: 'Tab elements must be surrounded by blank lines',
  tags: ['gitlab-docs', 'tabs'],
  function: (params, onError) => {
    const tabElements = ['::Tabs', '::EndTabs', ':::TabTitle'];
    forEachLine(getLineMetadata(params), (line, lineIndex) => {
      const lineHasTab = tabElements.includes(line.split(' ')[0]);
      const prevLine = params.lines[lineIndex - 1];
      const nextLine = params.lines[lineIndex + 1];

      if (lineHasTab && (!isBlankLine(prevLine) || !isBlankLine(nextLine))) {
        onError({
          lineNumber: lineIndex + 1,
        });
      }
    });
  },
};