holisticon/angularjs-common

View on GitHub
etc/helpers.js

Summary

Maintainability
A
2 hrs
Test Coverage
const path = require('path');
const util = require('util');
const debugLog = util.debuglog('@holisticon/angularjs-common/helpers');
const defaultAppConfig = require('./appConfig');
const providedAppConfig = require(process.env.APP_CONFIG || './appConfig');

// Helper functions
var ROOT = path.resolve(__dirname, '..');

function hasProcessFlag(flag) {
  return process.argv.join('').indexOf(flag) > -1;
}

function isWebpackDevServer() {
  return process.argv[1] && !!(/webpack-dev-server$/.exec(process.argv[1]));
}

function root(args) {
  args = Array.prototype.slice.call(arguments, 0);
  return path.join.apply(path, [ROOT].concat(args));
}

function checkNodeImport(context, request, cb) {
  if (!path.isAbsolute(request) && request.charAt(0) !== '.') {
    cb(null, 'commonjs ' + request);
    return;
  }
  cb();
}


/**
 * Takes the default config and merge it with the provided overwrites
 * @param overwrittenConfig with overwrites
 * @returns config object
 * @example
 *      {
 *      src: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/test/app',
 *     test: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/test/specs',
 *     templates: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/scripts/templates',
 *     srcPath: 'test/app',
 *     testPath: 'test/specs',
 *     testSpecs: 'test/specs/**\/*.spec.ts',
 *     testBundlePath: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/etc/spec-bundle.js',
 *     testTitle: 'Holisticon - AngularBuildCommon',
 *     srcApp: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/test/app',
 *     srcSASS: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/test/app/scss',
 *     srcI18N: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/test/app/app/i18n',
 *     srcIMG: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/test/app/img',
 *     index: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/test/app/index.html',
 *     dist: '/Users/mreinhardt/Documents/Programmierung/repositories/git/job/holisticon/angular-common/dist',
 *     distPath: 'dist',
 *     additionalWebpackOptions: false
  *    }
 */
function mergeAppConfig(overwrittenConfig) { /*eslint complexity: [error, 24]*/
  var appConfig = overwrittenConfig || {},
    basePath = path.resolve(process.cwd()),
    appName = appConfig.appName || defaultAppConfig.appName,
    srcPath = appConfig.srcPath || defaultAppConfig.srcPath,
    testPath = appConfig.testPath || defaultAppConfig.testPath,
    sourceResolved = path.resolve(basePath, srcPath),
    testPathResolved = path.resolve(basePath, testPath),
    templatesPath = appConfig.templatesPath || defaultAppConfig.templatesPath,
    distPath = appConfig.distPath || defaultAppConfig.distPath,
    genPath = appConfig.genPath || defaultAppConfig.genPath,
    templatesResolved = path.resolve(basePath, templatesPath);
  var indexFiles = defaultAppConfig.indexFiles,
    junit;
  if (appConfig.indexFiles) {
    indexFiles = appConfig.indexFiles;
  } else {
    // refresh with current source path
    indexFiles[0].template = path.resolve(srcPath, 'index.html');
  }
  if (appConfig.junit) {
    junit = {
      outputDir: path.resolve(basePath, appConfig.junit.dir), // results will be saved as $outputDir/$browserName.xml
      outputFile: 'TEST-' + appConfig.junit.title + '.xml', // if included, results will be saved as $outputDir/$browserName/$outputFile
      suite: appConfig.junit.title, // suite will become the package name attribute in xml testsuite element
      useBrowserName: false // add browser name to report and classes names
    }
  } else {
    junit = {
      outputDir: path.resolve(basePath, 'dist', 'test-reports'), // results will be saved as $outputDir/$browserName.xml
      outputFile: 'TEST-' + defaultAppConfig.junit.title + '.xml', // if included, results will be saved as $outputDir/$browserName/$outputFile
      suite: defaultAppConfig.junit.title, // suite will become the package name attribute in xml testsuite element
      useBrowserName: false // add browser name to report and classes names
    }
  }
  var config = {
    srcPath: srcPath,
    testPath: testPath,
    src: sourceResolved,
    test: testPathResolved,
    junit: junit,
    templates: templatesResolved || srcPath + '/' + templatesPath,
    templatesPath: templatesPath,
    srcSASS: appConfig.srcSASS || path.resolve(sourceResolved, 'scss'),
    srcI18N: appConfig.srcI18N || path.resolve(sourceResolved, 'app', 'i18n'),
    srcIMG: appConfig.srcIMG || path.resolve(sourceResolved, 'img'),
    modulesPath: appConfig.modulesPath || path.resolve(basePath, 'node_modules'),
    testSpecs: testPath + (appConfig.testSpecs || '/specs/**/*.js'),
    distPath: distPath,
    dist: appConfig.dist || path.resolve(distPath),
    genPath: genPath,
    indexFiles: indexFiles,
    gen: appConfig.gen || path.resolve(genPath),
    chunks: appConfig.chunks || defaultAppConfig.chunks,
    globals: appConfig.globals || defaultAppConfig.globals,
    entry: appConfig.entry || defaultAppConfig.entry,
    mangle: appConfig.mangle || defaultAppConfig.mangle,
    proxy: appConfig.proxy || defaultAppConfig.proxy,
    title: appConfig.title || defaultAppConfig.title
  };
  debugLog('Using following appConfig:', config);
  return config;
}

/**
 * Use the provided (as process.env var) config file and merge it with the default
 */
function getAppConfig() {
  return mergeAppConfig(providedAppConfig);
}

exports.mergeAppConfig = mergeAppConfig;
exports.getAppConfig = getAppConfig;
exports.hasProcessFlag = hasProcessFlag;
exports.isWebpackDevServer = isWebpackDevServer;
exports.root = root;
exports.checkNodeImport = checkNodeImport;