react-docgen/dist/utils/docblock.js

A library to extract information from React components for documentation generation.

/**
 * Helper functions to work with docblock comments.
 */
const DOCLET_PATTERN = /^@(\w+)(?:$|\s((?:[^](?!^@\w))*))/gim;
function parseDocblock(str) {
    // Does not use \s in the regex as this would match also \n and conflicts
    // with windows line endings.
    return str.replace(/^[ \t]*\*[ \t]?/gm, '').trim();
}
const DOCBLOCK_HEADER = /^\*\s/;
/**
 * Given a path, this function returns the closest preceding docblock if it
 * exists.
 */
export function getDocblock(path, trailing = false) {
    let comments = [];
    if (trailing && path.node.trailingComments) {
        comments = path.node.trailingComments.filter((comment) => comment.type === 'CommentBlock' && DOCBLOCK_HEADER.test(comment.value));
    }
    else if (path.node.leadingComments) {
        comments = path.node.leadingComments.filter((comment) => comment.type === 'CommentBlock' && DOCBLOCK_HEADER.test(comment.value));
    }
    if (comments.length > 0) {
        const lastComment = comments[comments.length - 1];
        if (lastComment) {
            return parseDocblock(lastComment.value);
        }
    }
    return null;
}
/**
 * Given a string, this functions returns an object with doclet names as keys
 * and their "content" as values.
 */
export function getDoclets(str) {
    const doclets = Object.create(null);
    let match;
    while ((match = DOCLET_PATTERN.exec(str))) {
        const [, name, value] = match;
        if (name) {
            doclets[name] = value || true;
        }
    }
    return doclets;
}