documentation/src/infer/access.js

a documentation generator

/**
 * Given a string with a pattern that might infer access level, like `^_`,
 * create an inference method.
 *
 * @param {?string} pattern regexp-compatible pattern
 * @returns {Function} inference method
 * @private
 */
export default function inferAccessWithPattern(pattern) {
  const re = pattern && new RegExp(pattern);

  /**
   * Infers access from TypeScript annotations, and from the name (only private atm).
   *
   * @name inferAccess
   * @param {Object} comment parsed comment
   * @returns {Object} comment with access inferred
   */
  return function inferAccess(comment) {
    // Support typescript access modifiers
    const ast = comment.context.ast;
    if (ast && ast.node.accessibility) {
      comment.access = ast.node.accessibility;
    }

    if (ast && ast.node.readonly) {
      comment.readonly = true;
    }

    // This needs to run after inferName because we infer the access based on
    // the name.
    if (
      re &&
      comment.name &&
      comment.access === undefined &&
      re.test(comment.name)
    ) {
      comment.access = 'private';
    }

    return comment;
  };
}