NN2022100801/addons/web/node_modules/extract-comments/lib/comments.js

/*!
 * extract-comments <https://github.com/jonschlinkert/extract-comments>
 *
 * Copyright (c) 2014 Jon Schlinkert, contributors.
 * Licensed under the MIT license.
 */

'use strict';

var extract = require('esprima-extract-comments');
var extend = require('extend-shallow');
var define = require('define-property');
var Context = require('./context');
var Block = require('./block');
var Line = require('./line');

/**
 * If you need to customize the generated comment objects, you
 * can create an instance of `Comments`:
 *
 * ```js
 * var extract = require('extract-comments');
 * var Comments = extract.Comments;
 * var comments = new Comments(options);
 * ```
 * @param {String} `string`
 * @param {Object} `options`
 * @param {Object} `options.first` Return the first comment only
 * @param {Object} `options.banner` alias for `options.first`
 * @param {Function} `fn` Optionally pass a transform function to call on each token (comment) in the AST.
 * @return {String}
 * @api public
 */

function Comments(options, fn) {
  this.options = extend({type: 'block'}, options);
  this.transform = fn;
  this.comments = [];
}

Comments.prototype.extract = function(str) {
  if (typeof str !== 'string') {
    throw new TypeError('expected a string');
  }

  define(this, 'input', str);

  var opts = this.options;
  var ast = [];

  try {
    ast = extract(this.input);
  } catch (err) {
    if (opts.silent !== true) {
      throw err;
    }
  }

  var strip = opts.stripProtected;
  var keep = opts.keepProtected;

  if (typeof keep === 'undefined' && typeof strip === 'undefined') {
    strip = false;
  } else if (typeof keep !== 'undefined') {
    strip = !keep;
  }

  var len = ast.length;
  var idx = -1;

  while (++idx < len) {
    var token = ast[idx];
    token.type = token.type.toLowerCase();

    if (typeof this.options.filter === 'function') {
      if (this.options.filter(token)) {
        continue;
      }
    }

    if (/^\*?!/.test(token.value) && strip === false) {
      continue;
    }

    if (token.type === 'block' && opts.block !== false) {
      var comment = new Block(str, token, opts);

      if (opts.context !== false) {
        comment.code = new Context(str, comment, opts);
      }

      if (typeof this.transform === 'function') {
        var res = this.transform(comment, this.options);
        if (res) comment = res;
      }

      this.comments.push(comment);
    }

    if (token.type === 'line' && opts.line !== false) {
      this.comments.push(new Line(str, token, opts));
    }

    if ((opts.first || opts.banner) && this.comments.length === 1) {
      break;
    }
  }
  return this;
};

/**
 * Expose `Comments` constructor, to
 * allow plugins to be registered.
 */

module.exports = Comments;