generator-effective/generators/helper/index.js

a opinionated and progressive generator to make package.json and thousands of configs effective

'use strict';
const path = require('path');
const yaml = require('js-yaml');
const cosmiconfig = require('cosmiconfig');
/**
 * quick way to remove item from array
 * @param {Array.<string>} array list
 * @param {string} item item ready to be removed
 */
exports.quickRemove = function(array = [], item) {
  if (!Array.isArray(array)) return;
  const index = array.indexOf(item);
  if (index === -1) return;
  array.splice(index, 1);
};

/**
 * write config back to configuration file
 * @param {Generator} generator yoeman generator
 * @param {string} filepath configuration file path
 * @param {Object} config config data
 */
exports.writeConfig = function(generator, filepath, config) {
  switch (path.extname(filepath)) {
    case '.js':
      generator.log(
        `don't suport to update config with .js extension: ${filepath}`
      );
      return;
    case '。yaml':
    case '.yml':
      generator.fs.write(filepath, yaml.safeDump(config));
      return;
    case '.json':
    default:
      generator.fs.writeJSON(filepath, config);
      break;
  }
};

/**
 * seach config
 * @param {Generator} generator yoeman generator
 * @param {string} modulename config module name
 * @returns {null|CosmiconfigResult} the found config
 */
exports.searchConfig = function(generator, modulename) {
  const explorer = cosmiconfig(modulename, {
    ignoreEmptySearchPlaces: false,
    stopDir: generator.destinationRoot(),
  });
  return explorer.searchSync();
};

/**
 * seach config from disk and yoeman fs memory
 * @param {Generator} generator yoeman generator
 * @param {string} modulename config module name
 * @param {string} filenameInMemory config module name
 * @returns {null|CosmiconfigResult} the found config
 */
exports.searchConfigExtended = function(
  generator,
  modulename,
  filenameInMemory
) {
  // first, search config on dist
  const result = exports.searchConfig(generator, modulename);

  // then, load through yoeman memory fs
  const filepath =
    (result && result.filepath) || generator.destinationPath(filenameInMemory);
  const content = generator.fs.read(filepath);
  if (!content) {
    // be consistent with cosmiconfig searchSync
    return null;
  }
  let config;
  switch (path.extname(filenameInMemory)) {
    case '.yml':
    case '.yaml': {
      config = yaml.safeLoad(content);
      break;
    }
    case '.json':
    default:
      config = JSON.parse(content);
      break;
  }
  // be consistent with cosmiconfig searchSync
  return {
    filepath,
    config,
  };
};

/**
 * cast non-array property to array
 * @param {Object} config config data
 * @param {string} key the property key
 */
exports.castToArray = function(config, key) {
  if (!Array.isArray(config[key])) {
    config[key] = config[key] === undefined ? [] : [config[key]];
  }
};

/**
 * auto choose npm or yarn to install deps
 * @param {Generator} generator yeoman generator
 */
exports.installDependencies = function(generator) {
  let options = {
    npm: true,
  };
  if (exports.usingYarn(generator)) {
    options = {
      yarn: true,
    };
  }
  generator.installDependencies({
    ...options,
    bower: false,
  });
};

/**
 * detect user is using yarn or not
 * @param {Generator} generator yeoman generator
 * @returns {boolean} result
 */
exports.usingYarn = function(generator) {
  return generator.fs.exists(generator.destinationPath('yarn.lock'));
};

/**
 * relative path with dot slash
 * @param {string} from source directory
 * @param {string} to target directory
 * @returns {string} relative path
 */
exports.relative = function(from, to) {
  const result = path.relative(from, to);
  return result.startsWith('../') ? result : `./${result}`;
};