clean.js

/**
 * @classification UNCLASSIFIED
 *
 * @module scripts.clean
 *
 * @copyright Copyright (C) 2018, Lockheed Martin Corporation
 *
 * @license Apache-2.0
 *
 * @owner Connor Doyle
 *
 * @author Josh Kaplan
 *
 * @description Removes directories and files created during npm/yarn install,
 * node mbee build, and all log files.
 */
/* eslint-disable jsdoc/require-description-complete-sentence */
// Rule disabled to allow list in description

// Node modules
const fs = require('fs');
const { execSync } = require('child_process');
const path = require('path');

const rmd = (process.platform === 'win32') ? 'RMDIR /S /Q' : 'rm -rf';
const rmf = (process.platform === 'win32') ? 'DEL /S /Q' : 'rm -rf';

// eslint-disable-next-line no-console
const log = (module.parent == null || typeof M === 'undefined') ? console.log : M.log.info;

// Error Check - Check if file was run directly or global M object is undefined
if (module.parent == null || typeof M === 'undefined') {
  clean();
}

/**
 * @description Cleans project directory of non-persistent items. Removes the following
 * artifacts of a build:
 * - public directory
 * - docs directory
 * - logs
 * - node_modules
 *
 * The following flags are supported:
 * --logs
 * --docs
 * --public
 * --node-modules
 * --all
 *
 * If NO flags are provided, defaults to `--all`
 *
 * @param {string} _args - Additional options to pass into the clean function.
 */
function clean(_args) {
  const root = path.join(__dirname, '..');

  log('Cleaning MBEE...');

  // Assign parameters to args. If no parameters, default to '--all'
  const args = (_args === undefined) ? [] : _args;

  // Clean logs
  if (args.length === 0 || args.includes('--all')) {
    log('Cleaning logs...');
    execSync(`${rmd} ${path.join(root, 'build')} ${path.join(root, 'logs')}/*`);
  }

  // Clean data
  if (args.includes('--all') || args.includes('--data')) {
    log('Cleaning data directory...');
    execSync(`${rmf} ${path.join(root, 'data', '*')}`);
  }

  // Clean node_modules
  if (args.includes('--all') || args.includes('--node-modules')) {
    log('Cleaning node_modules...');
    execSync(`${rmd} ${path.join(root, 'node_modules')}`);
  }

  // Clean plugins
  if (args.includes('--all') || args.includes('--plugins')) {
    log('Cleaning plugins...');
    // Read the plugins directory
    const plugins = fs.readdirSync(path.join(root, 'plugins'));

    // Remove routes.js from the list, we don't want to delete that file
    for (let i = 0; i < plugins.length; i++) {
      if (plugins[i] === 'routes.js') {
        plugins.splice(i, 1);
      }
    }

    // Format the string, concatenating full paths of all plugins
    const deleteString = plugins.map(p => path.join(root, 'plugins', p)).join(' ');
    execSync(`${rmd} ${deleteString}`);
  }

  log('MBEE Cleaned.');
}

module.exports = clean;