stylelint-sassdoc/src/utils/checkCommentsForPosterComment.js

stylelint plugin to check scss files for a valid sassdoc documentation Credits to https://github.com/anneangersbach

const adjacentLineIsSCSSComment = require('./adjacentLineIsSCSSComment');
const regExCheck = require('./regExCheck');
const nodeToString = require('./nodeToString');

/**
 * Checks the suceeding comment nodes for '////'
 * @param {Node} node - the current node
*/
let results = [];
module.exports = function checkCommentsForPosterComment(node, tail = 0) {
    const nextNode = node.next();
    if (tail === 0) {
        results = [];
    }
    if (adjacentLineIsSCSSComment(node, false)) {
        // check for '////'
        if (regExCheck(nodeToString(nextNode), /^\/\/\/\/$/)) {
            const returnComment = {};
            returnComment.returnOnLine = nextNode.source.start.line;
            returnComment.node = nextNode;
            results.push(returnComment);
        }
        // continue with any comments preceding this one
        return checkCommentsForPosterComment(nextNode, tail + 1);
    }

    return results;
};