@enterthenamehere/esdoc
Version:
Good Documentation Generator For JavaScript, updated for new decade
107 lines (102 loc) • 12.6 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
/**
* Doc Comment Parser class.
*
* @example
* for (let comment of node.leadingComments) {
* let tags = CommentParser.parse(comment);
* console.log(tags);
* }
*/
class CommentParser {
/**
* parse comment to tags.
* @param {ASTNode} commentNode - comment node.
* @param {string} commentNode.value - comment body.
* @param {string} commentNode.type - CommentBlock or CommentLine.
* @returns {Tag[]} parsed comment.
*/
static parse(commentNode) {
if (!this.isESDoc(commentNode)) return [];
var comment = commentNode.value;
// TODO: refactor
comment = comment.replace(/\r\n/gm, '\n'); // for windows
comment = comment.replace(/^[\t ]*/gm, ''); // remove line head space
comment = comment.replace(/^\*[\t ]?/, ''); // remove first '*'
comment = comment.replace(/[\t ]$/, ''); // remove last space
comment = comment.replace(/^\*[\t ]?/gm, ''); // remove line head '*'
if (comment.charAt(0) !== '@') comment = "@desc ".concat(comment); // auto insert @desc
comment = comment.replace(/[\t ]*$/, ''); // remove tail space.
comment = comment.replace(/```(?:[\0-\uD7FF\uE000-\uFFFF]|[\uD800-\uDBFF][\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF])*?```/g, match => {
return match.replace(/@/g, '\\ESCAPED_AT\\');
}); // escape code in descriptions
comment = comment.replace(/^[\t ]*(@[0-9A-Z_a-z]+)$/gm, '$1 \\TRUE'); // auto insert tag text to non-text tag (e.g. @interface)
comment = comment.replace(/^[\t ]*(@[0-9A-Z_a-z]+)[\t ]((?:[\0-\t\x0B\f\x0E-\u2027\u202A-\uD7FF\uE000-\uFFFF]|[\uD800-\uDBFF][\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF])*)/gm, '\\Z$1\\Z$2'); // insert separator (\\Z@tag\\Ztext)
var lines = comment.split('\\Z');
var tagName = '';
var tagValue = '';
var tags = [];
for (var i = 0; i < lines.length; i++) {
var line = lines[i];
if (line.charAt(0) === '@') {
tagName = line;
var nextLine = lines[i + 1];
if (nextLine.charAt(0) === '@') {
tagValue = '';
} else {
tagValue = nextLine;
i++;
}
tagValue = tagValue.replace('\\TRUE', '').replace(/\\ESCAPED_AT\\/g, '@').replace(/^\n/, '').replace(/\n*$/, '');
tags.push({
tagName,
tagValue
});
}
}
return tags;
}
/**
* parse node to tags.
* @param {ASTNode} node - node.
* @returns {{tags: Tag[], commentNode: CommentNode}} parsed comment.
*/
static parseFromNode(node) {
if (!node.leadingComments) node.leadingComments = [{
type: 'CommentBlock',
value: ''
}];
var commentNode = node.leadingComments[node.leadingComments.length - 1];
var tags = this.parse(commentNode);
return {
tags,
commentNode
};
}
/**
* judge doc comment or not.
* @param {ASTNode} commentNode - comment node.
* @returns {boolean} if true, this comment node is doc comment.
*/
static isESDoc(commentNode) {
if (commentNode.type !== 'CommentBlock') return false;
return commentNode.value.charAt(0) === '*';
}
/**
* build comment from tags
* @param {Tag[]} tags
* @returns {string} block comment value.
*/
static buildComment(tags) {
return tags.reduce((comment, tag) => {
var line = tag.tagValue.replace(/\n/g, '\n * ');
return "".concat(comment, " * ").concat(tag.tagName, " \n * ").concat(line, " \n");
}, '*\n');
}
}
exports.default = CommentParser;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["CommentParser","parse","commentNode","isESDoc","comment","value","replace","charAt","concat","match","lines","split","tagName","tagValue","tags","i","length","line","nextLine","push","parseFromNode","node","leadingComments","type","buildComment","reduce","tag","exports","default"],"sources":["../../src/Parser/CommentParser.js"],"sourcesContent":["/**\r\n * Doc Comment Parser class.\r\n *\r\n * @example\r\n * for (let comment of node.leadingComments) {\r\n *   let tags = CommentParser.parse(comment);\r\n *   console.log(tags);\r\n * }\r\n */\r\nexport default class CommentParser {\r\n  /**\r\n   * parse comment to tags.\r\n   * @param {ASTNode} commentNode - comment node.\r\n   * @param {string} commentNode.value - comment body.\r\n   * @param {string} commentNode.type - CommentBlock or CommentLine.\r\n   * @returns {Tag[]} parsed comment.\r\n   */\r\n  static parse(commentNode) {\r\n    if (!this.isESDoc(commentNode)) return [];\r\n\r\n    let comment = commentNode.value;\r\n\r\n    // TODO: refactor\r\n    comment = comment.replace(/\\r\\n/gmu, '\\n'); // for windows\r\n    comment = comment.replace(/^[\\t ]*/gmu, ''); // remove line head space\r\n    comment = comment.replace(/^\\*[\\t ]?/u, ''); // remove first '*'\r\n    comment = comment.replace(/[\\t ]$/u, ''); // remove last space\r\n    comment = comment.replace(/^\\*[\\t ]?/gmu, ''); // remove line head '*'\r\n    if (comment.charAt(0) !== '@') comment = `@desc ${comment}`; // auto insert @desc\r\n    comment = comment.replace(/[\\t ]*$/u, ''); // remove tail space.\r\n    comment = comment.replace(/```[\\s\\S]*?```/gu, (match) => { return match.replace(/@/gu, '\\\\ESCAPED_AT\\\\'); }); // escape code in descriptions\r\n    comment = comment.replace(/^[\\t ]*(@\\w+)$/gmu, '$1 \\\\TRUE'); // auto insert tag text to non-text tag (e.g. @interface)\r\n    comment = comment.replace(/^[\\t ]*(@\\w+)[\\t ](.*)/gmu, '\\\\Z$1\\\\Z$2'); // insert separator (\\\\Z@tag\\\\Ztext)\r\n    const lines = comment.split('\\\\Z');\r\n\r\n    let tagName = '';\r\n    let tagValue = '';\r\n    const tags = [];\r\n    for (let i = 0; i < lines.length; i++) {\r\n      const line = lines[i];\r\n      if (line.charAt(0) === '@') {\r\n        tagName = line;\r\n        const nextLine = lines[i + 1];\r\n        if (nextLine.charAt(0) === '@') {\r\n          tagValue = '';\r\n        } else {\r\n          tagValue = nextLine;\r\n          i++;\r\n        }\r\n        tagValue = tagValue.replace('\\\\TRUE', '')\r\n          .replace(/\\\\ESCAPED_AT\\\\/gu, '@')\r\n          .replace(/^\\n/u, '')\r\n          .replace(/\\n*$/u, '');\r\n        tags.push({tagName, tagValue});\r\n      }\r\n    }\r\n    return tags;\r\n  }\r\n\r\n  /**\r\n   * parse node to tags.\r\n   * @param {ASTNode} node - node.\r\n   * @returns {{tags: Tag[], commentNode: CommentNode}} parsed comment.\r\n   */\r\n  static parseFromNode(node) {\r\n    if (!node.leadingComments) node.leadingComments = [{type: 'CommentBlock', value: ''}];\r\n    const commentNode = node.leadingComments[node.leadingComments.length - 1];\r\n    const tags = this.parse(commentNode);\r\n\r\n    return {tags, commentNode};\r\n  }\r\n\r\n  /**\r\n   * judge doc comment or not.\r\n   * @param {ASTNode} commentNode - comment node.\r\n   * @returns {boolean} if true, this comment node is doc comment.\r\n   */\r\n  static isESDoc(commentNode) {\r\n    if (commentNode.type !== 'CommentBlock') return false;\r\n    return commentNode.value.charAt(0) === '*';\r\n  }\r\n\r\n  /**\r\n   * build comment from tags\r\n   * @param {Tag[]} tags\r\n   * @returns {string} block comment value.\r\n   */\r\n  static buildComment(tags) {\r\n    return tags.reduce((comment, tag) => {\r\n      const line = tag.tagValue.replace(/\\n/gu, '\\n * ');\r\n      return `${comment} * ${tag.tagName} \\n * ${line} \\n`;\r\n    }, '*\\n');\r\n  }\r\n}\r\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,MAAMA,aAAa,CAAC;EACjC;AACF;AACA;AACA;AACA;AACA;AACA;EACE,OAAOC,KAAKA,CAACC,WAAW,EAAE;IACxB,IAAI,CAAC,IAAI,CAACC,OAAO,CAACD,WAAW,CAAC,EAAE,OAAO,EAAE;IAEzC,IAAIE,OAAO,GAAGF,WAAW,CAACG,KAAK;;IAE/B;IACAD,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,QAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5CF,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,WAAY,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7CF,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,WAAY,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7CF,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,QAAS,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1CF,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,aAAc,EAAE,EAAE,CAAC,CAAC,CAAC;IAC/C,IAAIF,OAAO,CAACG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAEH,OAAO,YAAAI,MAAA,CAAYJ,OAAO,CAAE,CAAC,CAAC;IAC7DA,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,SAAU,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3CF,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,+IAAkB,EAAGG,KAAK,IAAK;MAAE,OAAOA,KAAK,CAACH,OAAO,CAAC,IAAK,EAAE,gBAAgB,CAAC;IAAE,CAAC,CAAC,CAAC,CAAC;IAC9GF,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,4BAAmB,EAAE,WAAW,CAAC,CAAC,CAAC;IAC7DF,OAAO,GAAGA,OAAO,CAACE,OAAO,CAAC,iMAA2B,EAAE,YAAY,CAAC,CAAC,CAAC;IACtE,IAAMI,KAAK,GAAGN,OAAO,CAACO,KAAK,CAAC,KAAK,CAAC;IAElC,IAAIC,OAAO,GAAG,EAAE;IAChB,IAAIC,QAAQ,GAAG,EAAE;IACjB,IAAMC,IAAI,GAAG,EAAE;IACf,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGL,KAAK,CAACM,MAAM,EAAED,CAAC,EAAE,EAAE;MACrC,IAAME,IAAI,GAAGP,KAAK,CAACK,CAAC,CAAC;MACrB,IAAIE,IAAI,CAACV,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;QAC1BK,OAAO,GAAGK,IAAI;QACd,IAAMC,QAAQ,GAAGR,KAAK,CAACK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAIG,QAAQ,CAACX,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;UAC9BM,QAAQ,GAAG,EAAE;QACf,CAAC,MAAM;UACLA,QAAQ,GAAGK,QAAQ;UACnBH,CAAC,EAAE;QACL;QACAF,QAAQ,GAAGA,QAAQ,CAACP,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CACtCA,OAAO,CAAC,iBAAkB,EAAE,GAAG,CAAC,CAChCA,OAAO,CAAC,KAAM,EAAE,EAAE,CAAC,CACnBA,OAAO,CAAC,MAAO,EAAE,EAAE,CAAC;QACvBQ,IAAI,CAACK,IAAI,CAAC;UAACP,OAAO;UAAEC;QAAQ,CAAC,CAAC;MAChC;IACF;IACA,OAAOC,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;EACE,OAAOM,aAAaA,CAACC,IAAI,EAAE;IACzB,IAAI,CAACA,IAAI,CAACC,eAAe,EAAED,IAAI,CAACC,eAAe,GAAG,CAAC;MAACC,IAAI,EAAE,cAAc;MAAElB,KAAK,EAAE;IAAE,CAAC,CAAC;IACrF,IAAMH,WAAW,GAAGmB,IAAI,CAACC,eAAe,CAACD,IAAI,CAACC,eAAe,CAACN,MAAM,GAAG,CAAC,CAAC;IACzE,IAAMF,IAAI,GAAG,IAAI,CAACb,KAAK,CAACC,WAAW,CAAC;IAEpC,OAAO;MAACY,IAAI;MAAEZ;IAAW,CAAC;EAC5B;;EAEA;AACF;AACA;AACA;AACA;EACE,OAAOC,OAAOA,CAACD,WAAW,EAAE;IAC1B,IAAIA,WAAW,CAACqB,IAAI,KAAK,cAAc,EAAE,OAAO,KAAK;IACrD,OAAOrB,WAAW,CAACG,KAAK,CAACE,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG;EAC5C;;EAEA;AACF;AACA;AACA;AACA;EACE,OAAOiB,YAAYA,CAACV,IAAI,EAAE;IACxB,OAAOA,IAAI,CAACW,MAAM,CAAC,CAACrB,OAAO,EAAEsB,GAAG,KAAK;MACnC,IAAMT,IAAI,GAAGS,GAAG,CAACb,QAAQ,CAACP,OAAO,CAAC,KAAM,EAAE,OAAO,CAAC;MAClD,UAAAE,MAAA,CAAUJ,OAAO,SAAAI,MAAA,CAAMkB,GAAG,CAACd,OAAO,YAAAJ,MAAA,CAASS,IAAI;IACjD,CAAC,EAAE,KAAK,CAAC;EACX;AACF;AAACU,OAAA,CAAAC,OAAA,GAAA5B,aAAA"}