@adobe/helix-cli/src/abstract.cmd.js

/*
 * Copyright 2018 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

'use strict';

const EventEmitter = require('events');
const chalk = require('chalk');
const { HelixConfig, IndexConfig } = require('@adobe/helix-shared');
const { getOrCreateLogger } = require('./log-common');
const ConfigUtils = require('./config/config-utils.js');

class AbstractCommand extends EventEmitter {
  constructor(logger) {
    super();
    this._initialized = false;
    this._logger = logger || getOrCreateLogger();
    this._helixConfig = new HelixConfig().withLogger(this._logger);
    this._indexConfig = new IndexConfig().withLogger(this._logger);
  }

  withDirectory(dir) {
    this._helixConfig.withDirectory(dir);
    this._indexConfig.withDirectory(dir);
    return this;
  }

  get log() {
    return this._logger;
  }

  get directory() {
    return this._helixConfig.directory;
  }

  // eslint-disable-next-line class-methods-use-this
  get requireConfigFile() {
    return true;
  }

  withConfigFile(file) {
    this._helixConfig.withConfigPath(file);
    return this;
  }

  withIndexConfigFile(file) {
    this._indexConfig.withConfigPath(file);
    return this;
  }

  get config() {
    if (!this._initialized) {
      throw Error('illegal access to #config before initialized');
    }
    return this._helixConfig;
  }

  get indexConfig() {
    return this._indexConfig;
  }

  async init() {
    if (!this._initialized) {
      if (!await this._helixConfig.hasFile()) {
        if (this.requireConfigFile) {
          this.log.error(chalk`No {cyan helix-config.yaml}. Please add one before deployment.`);
          this.log.info(chalk`You can auto generate a default config with\n{grey $ hlx deploy --add=default}\n`);
          throw Error();
        } else {
          // set default config
          this._helixConfig.withSource(await ConfigUtils.createDefaultConfig(this.directory));
        }
      }
      await this._indexConfig.init();
      await this._helixConfig.init();
      this._initialized = true;
    }
    return this;
  }

  async reloadConfig() {
    if (!this._initialized) {
      return this.init();
    }
    this._helixConfig = new HelixConfig()
      .withLogger(this._helixConfig.log)
      .withConfigPath(this._helixConfig.configPath)
      .withDirectory(this._helixConfig.directory);
    if (!await this._helixConfig.hasFile()) {
      // set default config
      this._helixConfig.withSource(await ConfigUtils.createDefaultConfig(this.directory));
    }
    await this._helixConfig.init();
    this._indexConfig = await (new IndexConfig()
      .withLogger(this._indexConfig.log)
      .withConfigPath(this._indexConfig.configPath)
      .withDirectory(this._indexConfig.directory)
      .init());
    return this;
  }
}

module.exports = AbstractCommand;