babel-plugin-transform-modules-ui5/dist/classes/helpers/jsdoc.js

An unofficial babel plugin for SAP UI5.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.getJsDocClassInfo = getJsDocClassInfo;
exports.getTags = getTags;
exports.hasJsdocGlobalExportFlag = hasJsdocGlobalExportFlag;
var _core = require("@babel/core");
var _doctrine = _interopRequireDefault(require("doctrine"));
var _ignoreCase = _interopRequireDefault(require("ignore-case"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
const classInfoValueTags = ["alias", "name", "namespace"];
const classInfoBoolTags = ["nonUI5", "controller", "keepConstructor"];
function getJsDocClassInfo(node, parent) {
  if (node.leadingComments) {
    return node.leadingComments.filter(isCommentBlock).map(comment => {
      const docAST = _doctrine.default.parse(comment.value, {
        unwrap: true
      });
      const tags = docAST.tags || [];
      const info = {};
      for (const tagName of classInfoValueTags) {
        const value = getJsDocTagValue(tags, tagName);
        if (value) {
          info[tagName] = value;
        }
      }
      for (const tagName of classInfoBoolTags) {
        const value = !!getJsDocTag(tags, tagName);
        if (value) {
          info[tagName] = value;
        }
      }
      return info;
    }).filter(notEmpty)[0];
  }
  // Else see if the JSDoc are on the return statement (eg. return class X extends SAPClass)
  // or export statement (eg. export default class X extends SAPClass)
  else if (_core.types.isClassExpression(node) && _core.types.isReturnStatement(parent) || _core.types.isClassDeclaration(node) && _core.types.isExportDefaultDeclaration(parent)) {
    return getJsDocClassInfo(parent);
  } else {
    return {};
  }
}

/**
 * Returns a map of tags by name.
 * Converts empty to bool. Also converts bool value
 */
function getTags(comments) {
  if (!comments) {
    return {};
  }
  for (const comment of comments) {
    if (!isCommentBlock(comment)) {
      continue;
    }
    const docAST = _doctrine.default.parse(comment.value, {
      unwrap: true
    });
    const tags = docAST.tags;
    if (!tags || !tags.length) {
      continue;
    }
    const map = {};
    for (const tag of tags) {
      const title = tag.title;
      let value = tag.name || tag.description || true;
      if (value === "false") value = false;
      map[title] = value;
    }
    return map;
  }
  return {};
}
function getJsDocTagValue(tags, name) {
  const tag = getJsDocTag(tags, name);
  return tag && (tag.name || tag.description);
}
function getJsDocTag(tags, name) {
  return tags.find(t => _ignoreCase.default.equals(name, t.title));
}
function notEmpty(obj) {
  return Object.values(obj).some(value => value);
}
function hasJsdocGlobalExportFlag(node) {
  if (!node.leadingComments) {
    return false;
  }
  return node.leadingComments.filter(isCommentBlock).some(comment => {
    return _doctrine.default.parse(comment.value, {
      unwrap: true,
      tags: ["global"]
    }).tags.length > 0;
  });
}

// This doesn't exist on babel-types
function isCommentBlock(node) {
  return node && node.type === "CommentBlock";
}