@adobe/aem-cli 15.0.0

package/src/abstract-server.cmd.js

@@ -0,0 +1,143 @@
+/*
+ * 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.
+ */
+import opn from 'open';
+import chalk from 'chalk-template';
+import fs from 'fs/promises';
+import fse from 'fs-extra';
+import { resetContext } from './fetch-utils.js';
+import { AbstractCommand } from './abstract.cmd.js';
+
+export class AbstractServerCommand extends AbstractCommand {
+  constructor(logger) {
+    super(logger);
+    this._httpPort = -1;
+    this._bindAddr = null;
+    this._tls = false;
+    this._tlsCertPath = undefined;
+    this._tlsKeyPath = undefined;
+    this._scheme = 'http';
+    this._stopping = false;
+    this._cache = null;
+  }
+
+  withHttpPort(p) {
+    this._httpPort = p;
+    return this;
+  }
+
+  withBindAddr(a) {
+    this._bindAddr = a;
+    return this;
+  }
+
+  withTLS(tlsKeyPath, tlsCertPath) {
+    if (tlsKeyPath && tlsCertPath) {
+      this._tls = true;
+      this._tlsKeyPath = tlsKeyPath;
+      this._tlsCertPath = tlsCertPath;
+    }
+    return this;
+  }
+
+  withOpen(o) {
+    this._open = o === 'false' ? false : o;
+    return this;
+  }
+
+  withCache(value) {
+    this._cache = value;
+    return this;
+  }
+
+  withKill(value) {
+    this._kill = value;
+    return this;
+  }
+
+  get project() {
+    return this._project;
+  }
+
+  async doStop() {
+    if (this._project) {
+      await this._project.stop();
+      delete this._project;
+    }
+    await resetContext();
+  }
+
+  async stop() {
+    if (this._stopping) {
+      return;
+    }
+    this._stopping = true;
+    await this.doStop();
+    this.emit('stopped', this);
+  }
+
+  async initSeverOptions() {
+    if (this._cache) {
+      await fse.ensureDir(this._cache);
+      this._project.withCacheDirectory(this._cache);
+    }
+
+    if (this._tls) {
+      if (
+        !this._tlsCertPath
+        || !this._tlsKeyPath
+      ) {
+        throw Error(chalk`{red If using TLS, you must provide both tls cert and tls key...one or both not found }`);
+      }
+      // read each file
+      try {
+        const key = await fs.readFile(this._tlsKeyPath);
+        const cert = await fs.readFile(this._tlsCertPath);
+        this._project.withTLS(key, cert);
+        // if all of that works, switch to https scheme
+        this._scheme = 'https';
+      } catch (e) {
+        throw Error(chalk`{red Unable to read the tls key key or cert file. }`);
+      }
+    }
+    if (this._httpPort >= 0) {
+      this._project.withHttpPort(this._httpPort);
+    }
+    if (this._bindAddr) {
+      this._project.withBindAddr(this._bindAddr);
+    }
+  }
+
+  async run() {
+    await this.init();
+    await this._project.start();
+    this.emit('started', this);
+    if (this._open) {
+      await this.open(this._open);
+    }
+  }
+
+  async open(href) {
+    let url;
+    try {
+      url = new URL(href.startsWith('/')
+        ? `${this._project.server.scheme}://${this._project.server.hostname}:${this._project.server.port}${href}`
+        : href);
+    } catch (e) {
+      throw Error('invalid argument for --open. either provide an relative url starting with \'/\' or an absolute http(s) url.');
+    }
+    if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+      throw Error(`refuse to open non http(s) url (--open): ${url}`);
+    }
+    this.log.info(`opening default browser: ${url.href}`);
+    await opn(url.href);
+  }
+}

package/src/abstract.cmd.js

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+import EventEmitter from 'events';
+import { getOrCreateLogger } from './log-common.js';
+
+export class AbstractCommand extends EventEmitter {
+  constructor(logger) {
+    super();
+    this._initialized = false;
+    this._logger = logger || getOrCreateLogger();
+    this._directory = process.cwd();
+  }
+
+  withDirectory(dir) {
+    this._directory = dir;
+    return this;
+  }
+
+  get log() {
+    return this._logger;
+  }
+
+  get directory() {
+    return this._directory;
+  }
+
+  async init() {
+    if (!this._initialized) {
+      this._initialized = true;
+    }
+    return this;
+  }
+}

package/src/cli-util.js

@@ -0,0 +1,74 @@
+/*
+ * 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.
+ */
+import chalk from 'chalk-template';
+
+const spinnerFrames = process.platform === 'win32'
+  ? ['-', '\\', '|', '/']
+  : ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+
+export const createSpinner = (msg) => {
+  const hideCursor = () => {
+    this.running = false;
+    // ensure we quit after ctrl+c and show cursor again
+    process.stdout.write('\u001b[?25h');
+    process.exit(0);
+  };
+  process.once('SIGINT', hideCursor);
+
+  return {
+    i: 0,
+    running: false,
+    s: process.stdout,
+    written: false,
+
+    run() {
+      if (this.running) {
+        if (msg) {
+          this.s.write(chalk`{cyan ${spinnerFrames[this.i]}} ${msg}`);
+          this.s.cursorTo(0);
+        } else {
+          this.s.write(chalk`{cyan ${spinnerFrames[this.i]}}`);
+          this.s.moveCursor(-1);
+        }
+        this.written = true;
+        this.i = (this.i + 1) % spinnerFrames.length;
+        setTimeout(this.run.bind(this), 100);
+      }
+    },
+
+    start() {
+      if (!this.s.moveCursor) {
+        return this;
+      }
+      this.s.write('\u001b[?25l');
+      this.running = true;
+      this.run();
+      return this;
+    },
+
+    stop() {
+      this.s.write('\u001b[?25h');
+      this.running = false;
+      if (this.written) {
+        this.s.clearLine(1);
+      }
+      process.removeListener('SIGINT', hideCursor);
+      return this;
+    },
+  };
+};
+
+export async function prompt(rl, question) {
+  return new Promise((resolve) => {
+    rl.question(question, resolve);
+  });
+}

package/src/cli.js

@@ -0,0 +1,137 @@
+/*
+ * 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.
+ */
+import yargs from 'yargs';
+import camelcase from 'camelcase';
+import path from 'path';
+import chalk from 'chalk-template';
+import { resetContext } from './fetch-utils.js';
+
+const MIN_MSG = 'You need at least one command.';
+
+function envAwareStrict(args, aliases) {
+  const specialKeys = ['$0', '--', '_'];
+
+  const hlxEnv = {};
+  Object
+    .keys(process.env)
+    .forEach((key) => {
+      if (key.startsWith('HLX_')) {
+        throw new Error(chalk`{red warning:} The environment prefix "HLX_" is not supported anymore. Please use "AEM_" instead.`);
+      }
+      if (key.startsWith('AEM_')) {
+        hlxEnv[camelcase(key.substring(4))] = key;
+      }
+    });
+
+  const unknown = [];
+  Object.keys(args).forEach((key) => {
+    if (specialKeys.indexOf(key) === -1 && !(key in hlxEnv) && !(key in aliases)) {
+      unknown.push(key);
+    }
+  });
+
+  if (unknown.length > 0) {
+    return unknown.length === 1 ? `Unknown argument: ${unknown[0]}` : `Unknown arguments: ${unknown.join(', ')}`;
+  }
+  if (path.basename(process.argv[1]) === 'hlx') {
+    return chalk`{red warning:} The "hlx" command is deprecated. Please use "aem" instead.`;
+  }
+  return true;
+}
+
+/**
+ * Adds the default logging options.
+ * @param argv Yargs
+ * @returns {Yargs} the args
+ */
+function logArgs(argv) {
+  return argv
+    .option('log-file', {
+      alias: 'logFile',
+      describe: 'Log file (use "-" for stdout)',
+      type: 'string',
+      array: true,
+      default: '-',
+    })
+    .option('log-level', {
+      alias: 'logLevel',
+      describe: 'Log level',
+      type: 'string',
+      choices: ['silly', 'debug', 'verbose', 'info', 'warn', 'error'],
+      default: 'info',
+    });
+}
+
+export default class CLI {
+  constructor() {
+    this._failFn = (message, err, argv) => {
+      const msg = err && err.message ? err.message : message;
+      if (msg) {
+        // eslint-disable-next-line no-console
+        console.error(msg);
+      }
+      if (msg === MIN_MSG || /.*Unknown argument.*/.test(msg) || /.*Not enough non-option arguments:.*/.test(msg)) {
+        // eslint-disable-next-line no-console
+        console.error('\n%s', argv.help());
+      }
+      process.exit(1);
+    };
+  }
+
+  withCommandExecutor(name, exec) {
+    this._commands[name].executor = exec;
+    return this;
+  }
+
+  onFail(fn) {
+    this._failFn = fn;
+    return this;
+  }
+
+  async initCommands() {
+    if (!this._commands) {
+      this._commands = {};
+      for (const cmd of ['up', 'hack', 'import']) {
+        if (!this._commands[cmd]) {
+          // eslint-disable-next-line no-await-in-loop
+          this._commands[cmd] = (await import(`./${cmd}.js`)).default();
+        }
+      }
+    }
+    return this;
+  }
+
+  async run(args) {
+    await this.initCommands();
+    const argv = yargs();
+    Object.values(this._commands)
+      .forEach((cmd) => argv.command(cmd));
+
+    logArgs(argv)
+      .strictCommands(true)
+      .scriptName('aem')
+      .usage('Usage: $0 <command> [options]')
+      .parserConfiguration({ 'camel-case-expansion': false })
+      .env('AEM')
+      .check((a) => envAwareStrict(a, argv.parsed.aliases))
+      .showHelpOnFail(true)
+      .fail(this._failFn)
+      .exitProcess(args.indexOf('--get-yargs-completions') > -1)
+      .demandCommand(1, MIN_MSG)
+      .epilogue('use <command> --help to get command specific details.\n\nfor more information, find our manual at https://github.com/adobe/helix-cli')
+      .help()
+      .parse(args);
+
+    // reset fetch connections so that process can terminate
+    await resetContext();
+  }
+}

package/src/config/config-utils.js

@@ -0,0 +1,49 @@
+/*
+ * 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.
+ */
+import chalk from 'chalk-template';
+import semver from 'semver';
+import GitUtils from '../git-utils.js';
+import pkgJson from '../package.cjs';
+
+/**
+ * Checks if the .env file is ignored by git.
+ * @param dir the current directory
+ * @returns {Promise<void>}
+ */
+export async function validateDotEnv(dir = process.cwd()) {
+  if (await GitUtils.isIgnored(dir, '.env')) {
+    return;
+  }
+  process.stdout.write(chalk`
+{yellowBright Warning:} Your {cyan '.env'} file is currently not ignored by git. 
+This is typically not good because it might contain secrets 
+which should never be stored in the git repository.
+
+`);
+}
+
+/**
+ * Checks if the given version is supported.
+ * @param version {string} current node version
+ * @param stdout {WritableStream} to report the warninf
+ */
+export function checkNodeVersion(version = process.version, stdout = process.stdout) {
+  const supported = pkgJson.engines.node;
+  if (!semver.satisfies(version, supported)) {
+    stdout.write(chalk`
+{yellowBright Warning:} The current node version {cyan ${version}} does not satisfy 
+the supported version range {cyan ${supported}}.
+You might encounter unexpected errors.   
+
+`);
+  }
+}

package/src/fetch-utils.js

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2021 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.
+ */
+import { keepAlive } from '@adobe/fetch';
+import { getProxyForUrl } from 'proxy-from-env';
+import nodeFetch from 'node-fetch';
+import { HttpProxyAgent } from 'http-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+
+const CONTEXT_CACHE = {
+  default: null,
+  insecure: null,
+};
+
+/**
+ * @type {ProxyHandler}
+ */
+const httpProxyHandler = {
+  apply(target, thisArg, argArray) {
+    // check if HTTP proxy is defined for the url
+    const /** @type URL */ [url, init = {}] = argArray;
+    const href = String(url); // ensure string
+    const proxyUrl = getProxyForUrl(href);
+    if (proxyUrl) {
+      const agent = href.startsWith('https://')
+        ? new HttpsProxyAgent(proxyUrl)
+        : new HttpProxyAgent(proxyUrl);
+      // eslint-disable-next-line no-console
+      console.debug(`using proxy ${proxyUrl}`);
+      return nodeFetch(url, {
+        ...init,
+        agent,
+      });
+    }
+    return target.apply(thisArg, argArray);
+  },
+};
+
+// create global context that is used by all commands and can be reset for CLI to terminate
+export function getFetch(allowUnauthorized) {
+  const cacheName = allowUnauthorized ? 'insecure' : 'default';
+  let cache = CONTEXT_CACHE[cacheName];
+  if (!cache) {
+    const context = keepAlive({ rejectUnauthorized: !allowUnauthorized });
+    cache = {
+      context,
+      fetch: new Proxy(context.fetch, httpProxyHandler),
+    };
+    CONTEXT_CACHE[cacheName] = cache;
+  }
+  return cache.fetch;
+}
+
+export async function resetContext() {
+  await CONTEXT_CACHE.default?.context.reset();
+  await CONTEXT_CACHE.insecure?.context.reset();
+}