@google/dscc-gen/src/util.ts

Create component & connector projects with sane defaults.

/**
 * @license
 * Copyright 2018 Google LLC
 *
 * Licensed 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
 *
 * https://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 CONDITIONS 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';
import {Spinner} from 'cli-spinner';
import * as execa from 'execa';
import {ExecaReturnValue, Options} from 'execa';
import * as fs from 'fs';
import {Answers} from 'inquirer';

export const readDir = (path: string): string[] => {
  const data = fs.readdirSync(path);
  return data;
};

export const readFile = (filePath: string, encoding: string): string => {
  return fs.readFileSync(filePath, encoding);
};

export const writeFile = (
  filePath: string,
  data: string,
  encoding: string
): boolean => {
  fs.writeFileSync(filePath, data, encoding);
  return true;
};

export const fileExists = (filePath: string): Promise<boolean> => {
  return new Promise((resolve, _) => {
    // The callback version (fs.exists) is deprecated so using synchronous
    // version (that isn't).
    const exists = fs.existsSync(filePath);
    resolve(exists);
  });
};

export interface Std {
  out: string;
  err: string;
}

export const npmInstall = async (
  projectPath: string,
  answers: Answers
): Promise<ExecaReturnValue> => {
  const execOptions: Options = {cwd: projectPath};
  if (answers.yarn) {
    return execa('yarn', [], execOptions);
  } else {
    return execa('npm', ['install'], execOptions);
  }
};

export const pause = async (millis: number): Promise<void> => {
  return new Promise((resolve, _) => {
    setInterval(() => {
      resolve();
    }, millis);
  });
};

export const spinnify = async <T>(
  spinnerText: string,
  fn: () => Promise<T>
): Promise<T> => {
  const spinner = new Spinner(spinnerText);
  spinner.start();
  try {
    return await fn();
  } finally {
    spinner.stop(true);
  }
};

export const format = {
  green: chalk.bold.rgb(15, 157, 88),
  blue: chalk.bold.rgb(66, 133, 244),
  yellow: chalk.bold.rgb(244, 160, 0),
  red: chalk.bold.rgb(219, 68, 55),
};

export const assertNever = (x: never): never => {
  throw new Error('Unexpected object: ' + x);
};