@platformos/pos-cli/lib/files.js

Manage your platformOS application

const path = require('path');
const fs = require('fs');
const glob = require('fast-glob');

const logger = require('./logger');
const dir = require('./directories');

const config = {
  CONFIG: '.pos',
  LEGACY_CONFIG: '.marketplace-kit',
  IGNORE_LIST: '.posignore',
  templateValues: 'template-values.json'
};

const _paths = customConfig => [customConfig, config.CONFIG, config.LEGACY_CONFIG];

const _getConfigPath = customConfig => {
  const firstExistingConfig = _paths(customConfig).filter(fs.existsSync)[0];
  logger.Debug(`[_getConfigPath] First existing config file: ${firstExistingConfig}`);
  return path.resolve(firstExistingConfig || config.CONFIG);
};

const _readJSON = (filePath, opts = { exit: true }) => {
  if (fs.existsSync(filePath)) {
    logger.Debug(`[_readJSON] File exist: ${filePath}.`);

    const fileContent = fs.readFileSync(filePath, { encoding: 'utf8' });

    try {
      return JSON.parse(fileContent);
    } catch (error) {
      logger.Debug(`${error.message}`);
      logger.Error(`${filePath} is not a valid JSON file. Use https://jsonlint.com to lint your JSON syntax.`, {
        exit: false
      });
      logger.Error(`Error thrown by the parser: ${error.message}`, { exit: opts.exit });
    }
  } else {
    logger.Debug(`[_readJSON] File doesnt exist: ${filePath}`);
    return {};
  }
};

const _readIgnoreList = filePath => {
  if (fs.existsSync(filePath) === false) {
    return [];
  }

  const rules = fs
    .readFileSync(filePath, { encoding: 'utf8' })
    .split('\n')
    .filter(Boolean) // remove empty lines
    .filter(line => line.indexOf('#') !== 0); // remove commented lines

  return rules;
};

const _getAssets = async () => {
  const appAssets = fs.existsSync(`${dir.currentApp()}/assets`) ? await glob(`${dir.currentApp()}/assets/**`) : [];
  const modulesAssets = fs.existsSync(dir.MODULES) ? await glob('modules/*/{private,public}/assets/**') : [];

  return [...appAssets, ...modulesAssets] || [];
};

const methods = {
  readJSON: _readJSON,
  getConfigPath: _getConfigPath,
  getConfig: () => {
    const configPath = _getConfigPath(process.env.CONFIG_FILE_PATH);
    logger.Debug(`[getConfig] Looking for config in: ${configPath}`);
    return _readJSON(configPath) || {};
  },
  getAssets: _getAssets,
  getIgnoreList: ignoreListPath => _readIgnoreList(ignoreListPath || config.IGNORE_LIST) || []
};

module.exports = Object.assign({}, config, methods);