esdoc/out/src/Util/InvalidCodeLogger.js

Good Documentation Generator For JavaScript

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _fsExtra = require('fs-extra');

var _fsExtra2 = _interopRequireDefault(_fsExtra);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/**
 * logger for invalid code which can not be parsed with ESDoc.
 */
class InvalidCodeLogger {
  constructor() {
    this._logs = [];
  }

  /**
   * show log.
   * @param {string} filePath - invalid code in this file.
   * @param {ASTNode} [node] - fail parsing node.
   */
  show(filePath, node) {
    if (!node) {
      this.showFile(filePath);
      return;
    }

    const lines = _fsExtra2.default.readFileSync(filePath).toString().split('\n');
    const targetLines = [];
    let start;
    const end = node.loc.start.line;

    if (node.leadingComments && node.leadingComments[0]) {
      start = node.leadingComments[0].loc.start.line;
    } else {
      start = Math.max(0, end - 10);
    }

    for (let i = start - 1; i < end; i++) {
      targetLines.push(`${i + 1}| ${lines[i]}`);
    }

    console.log('error: could not process the following code.');
    console.log(filePath);
    console.log(targetLines.join('\n'));
    console.log('');

    this._logs.push({ filePath: filePath, log: [start, end] });
  }

  /**
   * show error log.
   * @param {Error} error - target error.
   */
  showError(error) {
    console.log('');
    console.log(error);
    console.log('');
  }

  /**
   * show log.
   * @param {string} filePath - invalid code in this file.
   * @param {Error} error - error object.
   */
  showFile(filePath, error) {
    const lines = _fsExtra2.default.readFileSync(filePath).toString().split('\n');
    const start = Math.max(error.loc.line - 3, 1);
    const end = Math.min(error.loc.line + 3, lines.length);
    const targetLines = [];
    for (let i = start - 1; i < end; i++) {
      targetLines.push(`${i + 1}| ${lines[i]}`);
    }

    console.log('warning: could not parse the following code. if you want to use ECMAScript proposals, see https://esdoc.org/manual/feature.html#ecmascript-proposal');
    console.log(filePath);
    console.log(`${targetLines.join('\n')}`);

    this._logs.push({ filePath: filePath, log: [start, end] });
  }
}

/**
 * singleton for {@link InvalidCodeLogger}
 */
exports.default = new InvalidCodeLogger();