apercova/atom-path-intellisense

'use strict';
const path = require('path'),
  stringUtils = require('../util/string-utils'),
  BaseFormatter = require('./base.formatter'),
  SuggestionsDTO = require('../dto/suggestions.dto');

/**
 *
 * @class
 * @Classdesc Node.js formatter.
 * @author
 *  [{@link https://github.com/apercova|github@apercova}],
 *  [{@link https://twitter.com/apercova|twitter@apercova}],
 *  [{@link https://www.npmjs.com/~apercova|npmjs/~apercova}]
 *
 * @since 1.2.0
 */
class NodeJSFormatter extends BaseFormatter {
  /**
   * @return {NodeJSFormatter} NodeJSFormatter instance.
   * Meant to format raw suggestions for files, directories and Node Modules.
   */
  constructor() {
    super();
    this.id = 'NodeJSFormatter';
  }

  /**
   * format - format suggestions based on entry type.
   *
   * @param  {SuggestionsDTO} rawSuggestions Raw suggestions to format.
   * @param  {object} req                    Request options.
   * @return {Array}                         Formatted suggestions.
   */
  format(rawSuggestions) {
    let fSuggestions = [];
    if (rawSuggestions instanceof SuggestionsDTO && Array.isArray(rawSuggestions.suggestions)) {
      rawSuggestions.suggestions.forEach(raw => {
        let pathType = rawSuggestions.testPath.startsWith('.') ? 'relative' : 'local';
        if (raw.type === 'dir') {
          fSuggestions.push(
            this._formatDirectory(`${raw.entry}`, rawSuggestions.prefix, rawSuggestions.searchPath, pathType)
          );
        }
        if (raw.type === 'file') {
          fSuggestions.push(this._formatFile(raw.entry, rawSuggestions.prefix, rawSuggestions.searchPath, pathType));
        }
        if (raw.type === 'bimodule') {
          fSuggestions.push(this._formatBiModule(raw.entry, rawSuggestions.prefix));
        }
      });
    }
    return fSuggestions;
  }

  /**
   * _formatBiModule - Format Node.js Built-in modules.
   *
   * @param  {string} entry  unformatted file entry.
   * @param  {string} prefix Replacement prefix.
   * @return {object}        Formated entry.
   */
  _formatBiModule(entry, prefix) {
    return {
      'displayText': entry,
      'text': entry,
      'replacementPrefix': stringUtils.escapeStringQuote(prefix),
      'type': 'snippet',
      'leftLabelHTML': '<span> Node Module </span>',
      'rightLabelHTML': '<span class="pi-rlabel bimodule">' + ` (Built-in) ${entry}</span>`,
      'description': 'This module is provided by Node.js ..',
      'descriptionMoreURL': 'https://nodejs.org/api/modules.html#modules_module_builtinmodules',
      'iconHTML': '<i class="icon-package"></i>'
    };
  }

  /**
   * _formatFile - Format a file entry.
   *
   * @param  {string} entry      unformatted file entry.
   * @param  {string} prefix     Replacement prefix.
   * @param  {string} searchPath Base entry search path.
   * @param  {string} pathType   Base entry search path type.
   * @return {object}            Formated entry.
   */
  _formatFile(entry, prefix, searchPath, pathType) {
    const pEntry = path.parse(entry);
    const source = pathType === 'local' ? 'Local' : 'Relative';
    return {
      'displayText': stringUtils.unescapeStringQuote(pEntry.name),
      'text': stringUtils.escapeStringQuote(pEntry.name),
      'replacementPrefix': stringUtils.escapeStringQuote(prefix),
      'type': 'class',
      'leftLabelHTML': '<span> Node Module </span>',
      'rightLabelHTML':
        '<span class="pi-rlabel file">' + `<span class="tag"> (${source}, File) </span>${pEntry.base}</span>`,
      'description': `${path.normalize(searchPath + '/' + stringUtils.unescapeStringQuote(entry))}`,
      'iconHTML': '<i class="icon-file-code"></i>',
      'filename': entry
    };
  }

  /**
   * _formatDirectory - Format a file entry.
   *
   * @param  {string} entry      unformatted directory entry.
   * @param  {string} prefix     Replacement prefix.
   * @param  {string} searchPath Base entry search path.
   * @param  {string} pathType   Base entry search path type.
   * @return {object}            Formated entry.
   */
  _formatDirectory(entry, prefix, searchPath, pathType) {
    const source = pathType === 'local' ? 'Local' : 'Relative';
    return {
      'displayText': stringUtils.unescapeStringQuote(entry),
      'text': stringUtils.escapeStringQuote(entry),
      'replacementPrefix': stringUtils.escapeStringQuote(prefix),
      'type': 'class',
      'leftLabelHTML': '<span> Node Module </span>',
      'rightLabelHTML': '<span class="pi-rlabel file">' + `<span class="tag"> (${source}, Dir) </span>${entry}/</span>`,
      'description': `${path.normalize(searchPath + '/' + stringUtils.unescapeStringQuote(entry))}`,
      'iconHTML': '<i class="icon-package"></i>',
      'filename': entry
    };
  }
}
NodeJSFormatter.id = 'NodeJSFormatter';
module.exports = NodeJSFormatter;