create-desktop-shortcuts/src/helpers.js

Easy API to create desktop shortcuts with Node

'use strict';

/**
 * @file    File contains helper functions used by different files in the library.
 * @author  TheJaredWilcurt
 */

const os = require('os');

const helpers = {
  /**
   * Helper function for human readable logging. Calls customLogger
   * if passed in, or uses console.error to log human readable
   * warnings and errors. Used to report invalid API settings or
   * errors that occur during execution.
   *
   * @example
   * throwError(options, 'Message', err);
   *
   * @param {object} options  The user's options containing verbose and customLogger settings
   * @param {string} message  The text to be logged
   * @param {object} [error]  Optional object with additional details
   */
  throwError: function (options, message, error) {
    if (options.verbose && options.customLogger) {
      options.customLogger(message, error);
    } else if (options.verbose) {
      console.error(
        '_________________________\n' +
        'Create-Desktop-Shortcuts:\n' +
        message,
        error
      );
    }
  },
  /**
   * Resolves paths that start with a tilde to the user's
   * home directory.
   *
   * @example
   * // '/home/bob/GitHub/Repo/file.png'
   * resolveTilde('~/GitHub/Repo/file.png');
   *
   * @param  {string} filePath  '~/GitHub/Repo/file.png'
   * @return {string}           '/home/bob/GitHub/Repo/file.png'
   */
  resolveTilde: function (filePath) {
    if (!filePath || typeof(filePath) !== 'string') {
      return undefined;
    }

    // '~/folder/path' or '~' not '~alias/folder/path'
    if (filePath.startsWith('~/') || filePath === '~') {
      return filePath.replace('~', os.homedir());
    }

    return filePath;
  },
  /**
   * Replaces all environment variables with their actual value.
   * Keeps intact non-environment variables using '%'.
   *
   * @example
   * // 'C:\Users\bob\Desktop\AMD64'
   * resolveWindowsEnvironmentVariables('C:\Users\%USERNAME%\Desktop\%PROCESSOR_ARCHITECTURE%');
   *
   * @param  {string} filePath  The input file path with percents.
   * @return {string}           The resolved file path.
   */
  resolveWindowsEnvironmentVariables: function (filePath) {
    if (!filePath || typeof(filePath) !== 'string') {
      return undefined;
    }

    /**
     * Returns the value stored in the process.env for a given
     * environment variable. Or the original '%ASDF%' string if
     * not found.
     *
     * @example
     * replaceEnvironmentVariable('%USERNAME%', 'USERNAME');
     *
     * @param  {string} withPercents     '%USERNAME%'
     * @param  {string} withoutPercents  'USERNAME'
     * @return {string}                  'bob' || '%USERNAME%'
     */
    function replaceEnvironmentVariable (withPercents, withoutPercents) {
      let found = process.env[withoutPercents];
      // 'C:\Users\%USERNAME%\Desktop\%asdf%' => 'C:\Users\bob\Desktop\%asdf%'
      return found || withPercents;
    }

    // 'C:\Users\%USERNAME%\Desktop\%PROCESSOR_ARCHITECTURE%' => 'C:\Users\bob\Desktop\AMD64'
    filePath = filePath.replace(/%([^%]+)%/g, replaceEnvironmentVariable);

    return filePath;
  }
};

module.exports = helpers;