@corva/create-app 0.40.0-0 → 0.41.0-1

package/lib/{index.js → main.js}

@@ -1,47 +1,57 @@
-#!/usr/bin/env node
-
-'use strict';
-
-const chalk = require('chalk');
-const figlet = require('figlet');
-const { Command, CommanderError, Option } = require('commander');
-const fs = require('fs-extra');
-const inquirer = require('inquirer');
-const os = require('os');
-const path = require('path');
-const semver = require('semver');
-
-const {
+import chalk from 'chalk';
+import figlet from 'figlet';
+import { Command, CommanderError, Option } from 'commander';
+import fs from 'fs-extra';
+import inquirer from 'inquirer';
+import os from 'node:os';
+import path from 'node:path';
+import semver from 'semver';
+
+import {
   ensureLatestVersion,
   warnIfOutdated,
   ensureBumpVersion,
-} = require('./scripts/utils/version');
-const utils = require('./helpers/utils.js');
-const manifestHelpers = require('./helpers/manifest.js');
-const versioning = require('./helpers/versioning.js');
-
-const { getDefaultsForPackageJson } = require('./constants/package.js');
-const manifestConstants = require('./constants/manifest.js');
-
-const packageJson = require('../package.json');
-const { clear } = require('console');
-const spawn = require('cross-spawn');
-const { runFlow } = require('./flow');
-const { ERROR_ICON } = require('./constants/messages');
-const { StepError } = require('./flows/lib/step-error');
-const { RELEASE_FLOW } = require('./flows/release');
-const { RERUN_FLOW } = require('./flows/rerun');
-const { ZIP_FLOW } = require('./flows/zip');
-const { bumpVersionOptionDeprecated, bumpVersionOption } = require('./bump-version.option');
-const { Manifest } = require('./flows/lib/manifest');
-const { resolveAppRuntime } = require('./helpers/resolve-app-runtime');
-const { existsSync } = require('fs');
+} from './scripts/utils/version.js';
+import * as utils from './helpers/utils.js';
+import * as manifestHelpers from './helpers/manifest.js';
+import * as versioning from './helpers/versioning.js';
+
+import { getDefaultsForPackageJson } from './constants/package.js';
+import * as manifestConstants from './constants/manifest.js';
+
+import packageJson from '../package.json' assert { type: 'json' };
+import { clear } from 'node:console';
+import spawn from 'cross-spawn';
+import { runFlow } from './flow.js';
+import { ERROR_ICON } from './constants/messages.js';
+import { StepError } from './flows/lib/step-error.js';
+import { RELEASE_FLOW } from './flows/release.js';
+import { RERUN_FLOW } from './flows/rerun.js';
+import { ZIP_FLOW } from './flows/zip.js';
+import { bumpVersionOptionDeprecated, bumpVersionOption, apiKeyOption, envOption, silentOption } from './bump-version.option.js';
+import { Manifest } from './flows/lib/manifest.js';
+import { resolveAppRuntime } from './helpers/resolve-app-runtime.js';
+import { existsSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { logger } from './helpers/logger.js';
+import _ from 'lodash/fp.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const writejsonOptions = {
   spaces: 2,
   EOL: os.EOL,
 };
 
+const silencer = handler => async (...args) => {
+  const result = await handler(...args);
+
+  if (args[args.length - 2].silent && result) {
+    console.log(result);
+  }
+}
+
 function startingMessage() {
   clear();
   console.log(chalk.green('   Welcome to apps generator for:'));
@@ -49,11 +59,11 @@ function startingMessage() {
 }
 
 function checkNodeVersion() {
-  process.stdout.write('Checking node version...');
+  logger.write('Checking node version...');
 
   const unsupportedNodeVersion = !semver.satisfies(process.version, '>=16');
   if (unsupportedNodeVersion) {
-    console.log(
+    logger.log(
       chalk.red(
         `\nYou are using Node ${process.version}.\n\n` +
         `Please update to Node 16 or higher for a better, fully supported experience.\n`
@@ -62,7 +72,7 @@ function checkNodeVersion() {
     // Fall back to latest supported react-scripts on Node 4
     return process.exit(1);
   }
-  process.stdout.write('  ✅  \n');
+  logger.write('  ✅  \n');
 }
 
 function checkOptions(opts) {
@@ -89,7 +99,7 @@ const printDeprecationNotice = (param) =>
     ` Use ${chalk.cyan(`create-corva-app ${param} .`)} instead`
   );
 
-async function initialChecks() {
+export async function run() {
   const program = new Command()
     .hook('preAction', async () => {
       checkNodeVersion();
@@ -110,7 +120,7 @@ async function initialChecks() {
     const option = new Option(
       `${value.alias ? `-${value.alias}, ` : ''}--${value.name} [${(type !== 'undefined' && type) || 'string'
       }]`,
-      value.message
+      value.message,
     );
 
     if (value.choices) {
@@ -136,37 +146,12 @@ async function initialChecks() {
 
   createCommand
     .version(packageJson.version)
-    .addOption(
-      new Option(
-        '-z, --zip [string]',
-        chalk.bgYellow`DEPRECATED` + ` Use ${chalk.cyan`zip`} command instead`
-      )
-    )
-    .addOption(
-      new Option(
-        '--release',
-        chalk.bgYellow`DEPRECATED` + ` Use ${chalk.cyan`release`} command instead`
-      )
-    )
-    .addOption(bumpVersionOptionDeprecated);
 
   createCommand.action(async (dirName, options) => {
     if (options.zip || options.release) {
       options.bumpVersion = await ensureBumpVersion(options.bumpVersion);
     }
 
-    if (options.zip) {
-      printDeprecationNotice('zip');
-
-      return runFlow(ZIP_FLOW, { dirName, patterns: [], options });
-    }
-
-    if (options.release) {
-      printDeprecationNotice('release');
-
-      return runFlow(RELEASE_FLOW, { dirName, patterns: [], options });
-    }
-
     startingMessage();
 
     // NOTE: Default action
@@ -180,11 +165,12 @@ async function initialChecks() {
     .argument('[patterns...]', 'Additional patterns to zip', [])
     .addOption(bumpVersionOption)
     .addOption(new Option('--ignored-files [ignoredFiles...]', 'Patterns to skip zip', []))
-    .action(async (dirName, patterns, options) => {
+    .addOption(silentOption)
+    .action(silencer(async (dirName, patterns, options) => {
       options.bumpVersion = await ensureBumpVersion(options.bumpVersion);
 
-      return runFlow(ZIP_FLOW, { dirName, patterns, options });
-    });
+      return runFlow(ZIP_FLOW, { dirName, patterns, options }).then(_.get('zipFileName'))
+    }));
 
   program
     .command('release')
@@ -192,20 +178,30 @@ async function initialChecks() {
     .argument('<project-directory>', 'Project directory to work with')
     .argument('[patterns...]', 'Additional patterns to zip', [])
     .addOption(bumpVersionOption)
-    .addOption(new Option('--ignored-files [ignoredFiles...]', 'Patterns to skip zip', []))
+    .addOption(new Option('--ignored-files [string...]', 'Patterns to skip zip').default([]))
+    .addOption(silentOption)
+    .addOption(envOption)
+    .addOption(apiKeyOption)
+    .addOption(new Option('--notes [string]', 'Add custom notes to published app'))
+    .addOption(new Option('--label [string]', 'Put a label on the release').choices(['BETA', 'PROD']))
+    .addOption(new Option('--remove-on-fail [boolean]', 'Remove release if it fails during deployment').default(false))
+    // .addOption(new Option('--zip-file-name [string]', 'Prebuilt zip file name in dir'))
     .action(async (dirName, patterns, options) => {
       options.bumpVersion = await ensureBumpVersion(options.bumpVersion);
 
-      return runFlow(RELEASE_FLOW, { dirName, patterns, options });
+      await runFlow(RELEASE_FLOW, { dirName, patterns, options });
     });
 
   program
     .command('rerun')
     .description('Rerun app')
     .argument('<project-directory>', 'Project directory to work with')
+    .addOption(apiKeyOption)
+    .addOption(envOption)
+    .addOption(silentOption)
     .addOption(new Option('--assets [assets...]', 'Assets ids list', []))
-    .action(async (dirName, patterns, options) => {
-      return runFlow(RERUN_FLOW, { dirName, patterns, options });
+    .action(async (dirName, options) => {
+      await runFlow(RERUN_FLOW, { dirName, options });
     });
 
   try {
@@ -224,7 +220,7 @@ const handleError = (e) => {
     return;
   }
 
-  process.stdout.write(ERROR_ICON);
+  logger.write(ERROR_ICON);
 
   if (!(e instanceof StepError)) {
     console.error(chalk.red(e));
@@ -245,16 +241,16 @@ const handleCommanderError = (e) => {
         const commandName = program.args[0] || program._defaultCommandName;
 
         console.error('Please specify the project directory:');
-        console.log(
+        logger.log(
           `  ${chalk.cyan(program.name())} ${commandName} ${chalk.green('<project-directory>')}`
         );
-        console.log();
-        console.log('For example:');
-        console.log(
+        logger.log();
+        logger.log('For example:');
+        logger.log(
           `  ${chalk.cyan(program.name())} ${commandName} ${chalk.green('my-react-app')}`
         );
-        console.log();
-        console.log(
+        logger.log();
+        logger.log(
           `Run ${chalk.cyan(`${program.name()} help ${commandName}`)} to see all options.`
         );
       } else {
@@ -278,7 +274,7 @@ async function initPackage(projectName, opts) {
   const manifest = new Manifest(manifestHelpers.fillManifest(opts));
   const runtime = resolveAppRuntime(opts);
 
-  if (!await runtime.isRuntimeAvailable()) {
+  if (!(await runtime.isRuntimeAvailable())) {
     throw new Error(`Runtime "${opts.runtime}" is not available locally`);
   }
 
@@ -288,7 +284,7 @@ async function initPackage(projectName, opts) {
 
   const root = path.resolve(projectName);
 
-  console.log(`Creating a new Corva app in ${chalk.green(root)}.`);
+  logger.log(`Creating a new Corva app in ${chalk.green(root)}.`);
 
   if (fs.existsSync(root)) {
     throw new Error(`Directory already exists: ${root}`);
@@ -300,7 +296,7 @@ async function initPackage(projectName, opts) {
   await configureApp(root, manifest, runtime);
   await installApp(root, manifest, runtime);
 
-  console.log();
+  logger.log();
 }
 
 async function createApp(dirName, opts) {
@@ -308,7 +304,7 @@ async function createApp(dirName, opts) {
 
   if (isValid) {
     Object.keys(values).forEach((key) => {
-      console.log(`${key} : ${values[key]}`);
+      logger.log(`${key} : ${values[key]}`);
     });
 
     return initPackage(dirName, opts);
@@ -328,8 +324,8 @@ async function createApp(dirName, opts) {
  * @param {*} runtime
  */
 async function addTemplate(root, manifest, runtime) {
-  console.log(chalk.green('Copying app template...'));
-  console.log();
+  logger.log(chalk.green('Copying app template...'));
+  logger.log();
 
   const templateFolder = path.resolve(
     __dirname,
@@ -354,7 +350,7 @@ async function addTemplate(root, manifest, runtime) {
   // That's why we manually rename gitignore to .gitignore after copying template
   fs.renameSync(path.join(root, 'gitignore'), path.join(root, '.gitignore'));
 
-  console.log(chalk.green('Done: copying app template!'));
+  logger.log(chalk.green('Done: copying app template!'));
 }
 
 /**
@@ -380,7 +376,7 @@ async function configureApp(root, manifest, runtime) {
 
 const addNvmRc = async (root, manifest, runtime) => {
   await fs.outputFile(path.join(root, '.nvmrc'), `${runtime.version}\n`);
-}
+};
 
 const addTsConfigs = (root, manifest, runtime) => {
   if (runtime.language !== 'typescript') {
@@ -455,7 +451,7 @@ function addPackageJSON(root, manifest, runtime) {
     scripts: defaults.scripts,
     dependencies: defaults.dependencies,
     devDependencies: defaults.devDependencies,
-    ...(defaults.jest && { jest: defaults.jest })
+    ...(defaults.jest && { jest: defaults.jest }),
   };
 
   return fs.writeJSON(path.join(root, 'package.json'), packageJson, writejsonOptions);
@@ -469,12 +465,20 @@ function addPackageJSON(root, manifest, runtime) {
 async function installApp(root, manifest, runtime) {
   const command = manifest.isJs() ? runtime.packageManager : 'make';
   const args = ['install'];
-  const opts = { stdio: ['inherit', 'inherit', 'pipe'], cwd: root }
+  const opts = { stdio: ['inherit', 'inherit', 'pipe'], cwd: root };
 
-  console.log(chalk.yellow(`Installing template dependencies using ${runtime.packageManager}...`));
-  const proc = manifest.isJs() && existsSync(`${os.homedir()}/.nvm/nvm.sh`) ?
-    spawn.sync(`\\. ${os.homedir()}/.nvm/nvm.sh && nvm i && ${command} ${args.join(' ')}`, { shell: true, ...opts }) :
-    spawn.sync(command, args, opts);
+  if (process.env.CI && command === 'yarn') {
+    args.push('--cache-folder=".yarn-cache"');
+  }
+
+  logger.log(chalk.yellow(`Installing template dependencies using ${runtime.packageManager}...`));
+  const proc =
+    manifest.isJs() && existsSync(`${os.homedir()}/.nvm/nvm.sh`)
+      ? spawn.sync(`\\. ${os.homedir()}/.nvm/nvm.sh && nvm i && ${command} ${args.join(' ')}`, {
+        shell: true,
+        ...opts,
+      })
+      : spawn.sync(command, args, opts);
 
   if (proc.stderr) {
     const error = proc.stderr
@@ -491,20 +495,20 @@ async function installApp(root, manifest, runtime) {
     return;
   }
 
-  console.log(chalk.green('Successfull project install'));
+  logger.log(chalk.green('Successfull project install'));
 
   if (versioning.tryGitInit(root)) {
-    console.log();
-    console.log('Initialized a git repository.');
+    logger.log();
+    logger.log('Initialized a git repository.');
 
     if (versioning.tryGitCommit(root)) {
-      console.log();
-      console.log('Created git commit.');
+      logger.log();
+      logger.log('Created git commit.');
     }
   }
 
-  console.log();
-  console.log(`Success! Created ${manifest.name} at ${root}`);
+  logger.log();
+  logger.log(`Success! Created ${manifest.name} at ${root}`);
 
   helpCommands(manifest, runtime);
 }
@@ -516,20 +520,18 @@ async function helpCommands(manifest, { packageManager: displayedCommand }) {
 
   const useYarn = displayedCommand === 'yarn';
 
-  console.log('Inside that directory, you can run several commands:');
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} start`));
-  console.log('    Starts the development server.');
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}build`));
-  console.log('    Bundles the app into static files for production.');
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}zip`));
-  console.log('    Bundles the app into ZIP file in app root directory');
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}release`));
-  console.log('    Uploads the app ZIP to Corva');
-  console.log();
+  logger.log('Inside that directory, you can run several commands:');
+  logger.log();
+  logger.log(chalk.cyan(`  ${displayedCommand} start`));
+  logger.log('    Starts the development server.');
+  logger.log();
+  logger.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}build`));
+  logger.log('    Bundles the app into static files for production.');
+  logger.log();
+  logger.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}zip`));
+  logger.log('    Bundles the app into ZIP file in app root directory');
+  logger.log();
+  logger.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}release`));
+  logger.log('    Uploads the app ZIP to Corva');
+  logger.log();
 }
-
-initialChecks();

package/lib/scripts/utils/version.js

@@ -1,9 +1,10 @@
-const NpmApi = require('npm-api');
-const chalk = require('chalk');
-const semver = require('semver');
-const inquirer = require('inquirer');
+import NpmApi from 'npm-api';
+import chalk from 'chalk';
+import semver from 'semver';
+import inquirer from 'inquirer';
 
-const packageJson = require('../../../package.json');
+import packageJson from '../../../package.json' assert { type: 'json' };
+import { logger } from '../../helpers/logger.js';
 const npm = new NpmApi();
 
 const error = chalk.bold.red;
@@ -15,7 +16,7 @@ const getCurrentVersion = () => packageJson.version;
 const getLatestVersion = async () => npm.repo('@corva/create-app').prop('version');
 
 // NOTE: Stop process and show error if version is outdated
-async function ensureLatestVersion() {
+export async function ensureLatestVersion() {
   const currentVersion = getCurrentVersion();
   const latestVersion = await getLatestVersion();
 
@@ -36,8 +37,8 @@ async function ensureLatestVersion() {
 }
 
 // NOTE: Show user-friendly warning if version is outdated
-async function warnIfOutdated() {
-  process.stdout.write('Checking for updates...\n');
+export async function warnIfOutdated() {
+  logger.write('Checking for updates...\n');
 
   const currentVersion = getCurrentVersion();
   const latestVersion = await getLatestVersion();
@@ -55,7 +56,7 @@ async function warnIfOutdated() {
     `);
     console.log(warning(asterisks));
   } else {
-    process.stdout.write('  ✅  \n');
+    logger.write('  ✅  \n');
   }
 }
 
@@ -63,7 +64,7 @@ const PROMPT_MESSAGE = `Bumping package version:
 ${chalk.bold` Please select one of the options below:`}
   `;
 
-const ensureBumpVersion = async (bumpVersion) => {
+export const ensureBumpVersion = async (bumpVersion) => {
   if (bumpVersion) {
     return bumpVersion;
   }
@@ -95,7 +96,7 @@ const ensureBumpVersion = async (bumpVersion) => {
   return option === 'custom' ? custom : option;
 };
 
-async function getIncreasedVersion(version, { bumpVersion: releaseTypeOrNewVersion }) {
+export async function getIncreasedVersion(version, { bumpVersion: releaseTypeOrNewVersion }) {
   if (releaseTypeOrNewVersion === 'skip') {
     return version;
   }
@@ -106,5 +107,3 @@ async function getIncreasedVersion(version, { bumpVersion: releaseTypeOrNewVersi
 
   return semver.inc(version, releaseTypeOrNewVersion);
 }
-
-module.exports = { ensureLatestVersion, warnIfOutdated, getIncreasedVersion, ensureBumpVersion };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@corva/create-app",
-    "version": "0.40.0-0",
+    "version": "0.41.0-1",
     "private": false,
     "description": "Create app to use it in CORVA.AI",
     "keywords": [
@@ -15,10 +15,12 @@
         "directory": "@corva/create-app"
     },
     "license": "MIT",
+    "type": "module",
     "bin": {
-        "create-corva-app": "./bin/create-corva-app.js"
+        "create-corva-app": "./bin/create-corva-app.cjs"
     },
     "files": [
+        "bin/**/*.cjs",
         "bin/**/*.js",
         "lib/**/*.js",
         "templates",
@@ -33,7 +35,6 @@
     },
     "dependencies": {
         "archiver": "^5.3.0",
-        "axios": "^0.25.0",
         "chalk": "4.1.0",
         "commander": "^9.1.0",
         "cross-spawn": "7.0.3",
@@ -43,6 +44,7 @@
         "form-data": "^4.0.0",
         "fs-extra": "9.0.1",
         "glob": "^8.0.1",
+        "got": "^12.5.1",
         "inquirer": "^8.2.3",
         "is-glob": "^4.0.3",
         "lodash": "^4.17.21",

package/bin/create-corva-app.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-const { run } = require('../lib/app');
-
-run();

package/lib/app.js

@@ -1,9 +0,0 @@
-'use strict';
-
-const run = () => {
-  require('./');
-};
-
-module.exports = {
-  run,
-};

package/lib/flows/steps/release-get-app-key.js

@@ -1,16 +0,0 @@
-const { RELEASE } = require('../../constants/messages');
-
-const GET_APP_KEY_STEP = {
-  message: RELEASE.getAppKey,
-  fn: ({ manifest }) => {
-    const appKey = manifest.manifest.application.key;
-
-    if (!appKey) {
-      throw new Error(RELEASE.getAppKeyError);
-    }
-
-    return { appKey };
-  },
-};
-
-module.exports = { GET_APP_KEY_STEP };

package/lib/flows/steps/release-get-config.js

@@ -1,37 +0,0 @@
-const { RELEASE } = require('../../constants/messages');
-const { promises: fs } = require('fs');
-const dotenv = require('dotenv');
-const { resolve } = require('path');
-const { StepError } = require('../lib/step-error');
-
-async function getVarsFromDotEnv({ dirName }) {
-  try {
-    const envFile = await fs.readFile(resolve(dirName, '.env'));
-    return dotenv.parse(envFile);
-  } catch (error) {
-    return {};
-  }
-}
-
-const GET_RELEASE_CONFIG_STEP = {
-  message: RELEASE.getAuthToken,
-  fn: async ({ dirName }) => {
-    const parsedEnv = await getVarsFromDotEnv({ dirName });
-
-    const CORVA_API_ENV = process.env.CORVA_API_ENV || parsedEnv.CORVA_API_ENV;
-    const AUTH_TOKEN = process.env.AUTH_TOKEN || parsedEnv.AUTH_TOKEN;
-    const API_KEY = process.env.API_KEY || parsedEnv.API_KEY;
-
-    if (!AUTH_TOKEN && !API_KEY) {
-      throw new StepError(RELEASE.getAuthTokenError);
-    }
-
-    return {
-      CORVA_API_ENV: CORVA_API_ENV || 'production',
-      AUTH_TOKEN,
-      API_KEY,
-    };
-  },
-};
-
-module.exports = { GET_RELEASE_CONFIG_STEP };

package/lib/flows/steps/release-upload-zip-to-corva.js

@@ -1,25 +0,0 @@
-const { RELEASE } = require('../../constants/messages');
-const FormData = require('form-data');
-const { resolve } = require('path');
-const { createReadStream } = require('fs');
-const { StepError } = require('../lib/step-error');
-const { Api } = require('../lib/api');
-const { get } = require('lodash/fp');
-
-const UPLOAD_ZIP_TO_CORVA_STEP = {
-  message: RELEASE.uploadApp,
-  fn: async ({ zipFileName, appKey, CORVA_API_ENV, AUTH_TOKEN, API_KEY, dirName }) => {
-    const form = new FormData();
-    form.append('package', createReadStream(resolve(dirName, zipFileName)), 'archive.zip');
-
-    const api = new Api(CORVA_API_ENV, API_KEY, AUTH_TOKEN);
-    api.uploadPackages(appKey, form).catch((e) => {
-        throw new StepError(
-          `${get('response.data.message', e) || ''} \nPOST: ${uploadURL} failed.`,
-          { cause: e }
-        );
-      });
-  },
-};
-
-module.exports = { UPLOAD_ZIP_TO_CORVA_STEP };