@corva/create-app 0.11.0-0 → 0.12.0-2

package/index.js

@@ -1,29 +1,37 @@
 #!/usr/bin/env node
 
-"use strict";
-
-const chalk = require("chalk");
-const figlet = require("figlet");
-const commander = require("commander");
-const fs = require("fs-extra");
-const inquirer = require("inquirer");
-const os = require("os");
-const path = require("path");
-const semver = require("semver");
-
-const uiScripts = require("./scripts/ui");
-const { ensureLatestVersion } = require("./scripts/utils/version");
-const utils = require("./helpers/utils.js");
-const metadata = require("./helpers/metadata.js");
-const manifestHelpers = require("./helpers/manifest.js");
-const versioning = require("./helpers/versioning.js");
-
-const packageConstants = require("./constants/package.js");
-const manifestConstants = require("./constants/manifest.js");
-
-const packageJson = require("./package.json");
-const { clear } = require("console");
-const spawn = require("cross-spawn");
+'use strict';
+
+const chalk = require('chalk');
+const figlet = require('figlet');
+const commander = require('commander');
+const fs = require('fs-extra');
+const inquirer = require('inquirer');
+const os = require('os');
+const path = require('path');
+const semver = require('semver');
+
+const uiScripts = require('./scripts/ui');
+const { ensureLatestVersion } = require('./scripts/utils/version');
+const utils = require('./helpers/utils.js');
+const manifestHelpers = require('./helpers/manifest.js');
+const versioning = require('./helpers/versioning.js');
+
+const packageConstants = 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 YARN_EXECUTABLE = 'yarn';
+
+let packageManager = YARN_EXECUTABLE;
+let useTypescript = false;
+
+const shouldUseYarn = () => packageManager === YARN_EXECUTABLE;
+const getLockFileName = (manager) =>
+  manager === YARN_EXECUTABLE ? 'yarn.lock' : 'package-lock.json';
 
 clear();
 
@@ -31,20 +39,18 @@ let projectName;
 let program;
 
 const APP_TYPES = {
-  UI: "ui",
-  NODE: "node"
+  UI: 'ui',
+  NODE: 'node',
 };
 
 function startingMessage() {
-  console.log(chalk.green("   Welcome to apps generator for:"));
-  console.log(
-    chalk.cyan(figlet.textSync("CORVA.AI", { horizontalLayout: "full" }))
-  );
+  console.log(chalk.green('   Welcome to apps generator for:'));
+  console.log(chalk.cyan(figlet.textSync('CORVA.AI', { horizontalLayout: 'full' })));
 }
 
 function checkNodeVersion() {
-  console.log("Checking node version...");
-  const unsupportedNodeVersion = !semver.satisfies(process.version, ">=10");
+  console.log('Checking node version...');
+  const unsupportedNodeVersion = !semver.satisfies(process.version, '>=10');
   if (unsupportedNodeVersion) {
     console.log(
       chalk.red(
@@ -57,35 +63,43 @@ function checkNodeVersion() {
   }
 }
 
-function checkArguments() {
+function checkOptions(opts) {
   let isValid = true;
   const values = {};
 
-  manifestConstants.MANIFEST_MANDATORY_KEYS.forEach(key => {
-    if (!program[key]) {
+  manifestConstants.MANIFEST_MANDATORY_KEYS.forEach((key) => {
+    if (!opts[key]) {
       isValid = false;
     }
-    values[key] = program[key];
+
+    values[key] = opts[key];
   });
 
   return {
     isValid,
-    values
+    values,
   };
 }
 
 async function initialChecks() {
-  program = new commander.Command(packageJson.name)
+  startingMessage();
+
+  program = new commander.Command('corva-create-app')
     .version(packageJson.version)
-    .arguments("<project-directory>")
-    .usage(`${chalk.green("<project-directory>")} [options]`)
-    .action(name => {
+    .argument('[project-directory]', 'project directory to work with')
+    .usage(`${chalk.green('<project-directory>')} [options]`)
+    .action((name) => {
       projectName = name;
     })
-    .on("--help", helpCommands)
-    .option("-z, --zip <type>", "zip app source");
+    .option('-z, --zip <type>', 'zip app source')
+    .option('-t, --useTypescript', 'use typescript or javascript', false)
+    .addOption(
+      new commander.Option(`-p, --packageManager <value>`, 'package manager to use')
+        .default(YARN_EXECUTABLE)
+        .choices(['npm', YARN_EXECUTABLE])
+    );
 
-  manifestConstants.MANIFEST_MANDATORY_KEYS.forEach(key => {
+  manifestConstants.MANIFEST_MANDATORY_KEYS.forEach((key) => {
     program.option(`--${key} [value]`);
   });
 
@@ -93,31 +107,32 @@ async function initialChecks() {
 
   checkNodeVersion();
 
-  if (program.zip) {
-    if (program.zip === APP_TYPES.UI) return uiScripts.zipAppSource();
+  const opts = program.opts();
+
+  packageManager = opts.packageManager || packageManager;
+  useTypescript = opts.useTypescript || useTypescript;
+
+  if (opts.zip) {
+    if (opts.zip === APP_TYPES.UI) {
+      return uiScripts.zipAppSource(shouldUseYarn());
+    }
 
     process.exit(0);
   }
 
-  // NOTE: Default action
-  await createApp();
-
-  if (typeof projectName === "undefined") {
-    console.error("Please specify the project directory:");
-    console.log(
-      `  ${chalk.cyan(program.name())} ${chalk.green("<project-directory>")}`
-    );
+  if (!projectName) {
+    console.error('Please specify the project directory:');
+    console.log(`  ${chalk.cyan(program.name())} ${chalk.green('<project-directory>')}`);
     console.log();
-    console.log("For example:");
-    console.log(
-      `  ${chalk.cyan(program.name())} ${chalk.green("my-react-app")}`
-    );
+    console.log('For example:');
+    console.log(`  ${chalk.cyan(program.name())} ${chalk.green('my-react-app')}`);
     console.log();
-    console.log(
-      `Run ${chalk.cyan(`${program.name()} --help`)} to see all options.`
-    );
+    console.log(`Run ${chalk.cyan(`${program.name()} --help`)} to see all options.`);
     process.exit(1);
   }
+
+  // NOTE: Default action
+  await createApp(opts);
 }
 
 async function initPackage(manifest) {
@@ -130,10 +145,7 @@ async function initPackage(manifest) {
 
   fs.mkdirSync(root);
 
-  fs.writeFileSync(
-    path.join(root, "manifest.json"),
-    JSON.stringify(manifest, null, 2) + os.EOL
-  );
+  fs.writeFileSync(path.join(root, 'manifest.json'), JSON.stringify(manifest, null, 2) + os.EOL);
 
   let runtime = manifest.settings.runtime;
 
@@ -141,10 +153,14 @@ async function initPackage(manifest) {
   // config for every possible version at this point, so just consolidate all versions of a runtime into a single
   // template directory.
   if (appType !== APP_TYPES.UI) {
-    if (runtime.startsWith("python")) {
-      runtime = "python";
-    } else if (runtime.startsWith("nodejs")) {
-      runtime = "node";
+    if (runtime.startsWith('python')) {
+      runtime = 'python';
+    } else if (runtime.startsWith('nodejs')) {
+      runtime = 'node';
+
+      if (useTypescript) {
+        runtime += '-ts';
+      }
     }
   }
 
@@ -153,181 +169,159 @@ async function initPackage(manifest) {
   installApp(root, appType, runtime);
 }
 
-function fillAppMETA() {
-  console.log("Please fill your app Metadata");
-
-  const prompts = Object.keys(manifestConstants.manifestOptions).map(key => ({
-    type: metadata.getType(manifestConstants.manifestOptions[key]),
-    name: key,
-    message: `${
-      typeof manifestConstants.manifestOptions[key] === "string"
-        ? "Enter"
-        : "Choose"
-    } ${key}`,
-    default: manifestConstants.manifestOptions[key],
-    choices: metadata.getChoices(manifestConstants.manifestOptions[key])
-  }));
-
-  inquirer.prompt(prompts).then(answers => {
-    const manifest = manifestHelpers.fillManifest(answers);
-    initPackage(manifest);
-  });
-}
 
-async function createApp() {
-  const { isValid, values } = checkArguments();
-
-  startingMessage();
+async function createApp(opts) {
+  const { isValid, values } = checkOptions(opts);
 
   if (isValid) {
-    Object.keys(values).forEach(key => {
+    Object.keys(values).forEach((key) => {
       console.log(`${key} : ${values[key]}`);
     });
+
     const manifest = manifestHelpers.fillManifest(values);
+
     await initPackage(manifest);
   } else {
-    inquirer
-      .prompt([
-        {
-          name: "appName",
-          message: "Enter app name:",
-          default: projectName
-        }
-      ])
-      .then(answers => {
-        console.info("App Name:", answers.appName);
-        fillAppMETA();
-      });
+    console.log('Please fill your app Metadata');
+
+    inquirer.prompt(manifestConstants.manifestOptions(projectName)).then((answers) => {
+      packageManager = answers.packageManager || packageManager;
+      useTypescript = answers.useTypescript || useTypescript;
+
+      const manifest = manifestHelpers.fillManifest(answers);
+
+      initPackage(manifest);
+    });
   }
 
   console.log();
 }
 
 function addTemplate(root, appType, runtime) {
-  console.log(chalk.green("Copying app template..."));
+  console.log(chalk.green('Copying app template...'));
   console.log();
 
-  let templateFolder = path.resolve(__dirname, "template", appType);
+  let templateFolder = path.resolve(__dirname, 'template', appType);
   let nameExclusion = appType;
+
   if (appType !== APP_TYPES.UI) {
-    templateFolder = path.resolve(__dirname, "template", appType, runtime);
+    templateFolder = path.resolve(__dirname, 'template', appType, runtime);
+
     nameExclusion = runtime;
   }
-  console.log(templateFolder);
+
   utils.copyFolderRecursiveSync(templateFolder, root, nameExclusion);
 
-  if (appType === APP_TYPES.UI) {
+  const gitignore = path.join(root, 'gitignore');
+
+  if (fs.pathExistsSync(gitignore)) {
     // We can't have .gitignore file in our templates.
     // It's missing when @corva/create-app is installed.
     // That's why we manually rename gitignore to .gitignore after copying template
 
-    fs.renameSync(path.join(root, "gitignore"), path.join(root, ".gitignore"));
+    fs.renameSync(gitignore, path.join(root, '.gitignore'));
   }
 
-  console.log(chalk.green("Done: copying app template!"));
+  console.log(chalk.green('Done: copying app template!'));
 }
 
 function configureApp(root, appType, runtime, manifest) {
   if (appType === APP_TYPES.UI) {
     addPackageJSON(root, manifest.application.name);
-  } else if (runtime === APP_TYPES.NODE) {
-    updatePackageJSON(root, manifest.application.name, appType, runtime);
+  } else if (runtime.startsWith(APP_TYPES.NODE)) {
+    updatePackageJSON(root, manifest.application.description, appType, runtime);
   }
 }
 
 function addPackageJSON(root, appName) {
   const packageJson = {
-    name: appName.replace(/\W/g, ""),
-    version: "0.0.1",
-    main: "src/index.js",
+    name: appName.replace(/\W/g, ''),
+    version: '0.0.1',
+    main: 'src/index.js',
     scripts: packageConstants.scripts,
-    ...packageConstants.dependencies
+    ...packageConstants.dependencies,
   };
 
-  fs.writeFileSync(
-    path.join(root, "package.json"),
-    JSON.stringify(packageJson, null, 2) + os.EOL
-  );
+  fs.writeFileSync(path.join(root, 'package.json'), JSON.stringify(packageJson, null, 2) + os.EOL);
 }
 
-function updatePackageJSON(root, appName, appType, runtime) {
-  const templateFolder = path.resolve(__dirname, "template", appType, runtime);
+function updatePackageJSON(root, description, appType, runtime) {
+  const templateFolder = path.resolve(__dirname, 'template', appType, runtime);
 
-  let packageJson = JSON.parse(
-    fs.readFileSync(path.join(templateFolder, "package.json"), "utf-8")
-  );
+  let packageJson = JSON.parse(fs.readFileSync(path.join(templateFolder, 'package.json'), 'utf-8'));
 
-  packageJson.name = appName.replace(/\W/g, "");
+  packageJson.name = projectName.replace(/\W/g, '-').toLowerCase();
+  packageJson.description = description;
 
-  fs.writeFileSync(
-    path.join(root, "package.json"),
-    JSON.stringify(packageJson, null, 2) + os.EOL
+  packageJson.scripts.bundle = packageJson.scripts.bundle.replace(
+    '$LOCKFILE',
+    getLockFileName(packageManager)
   );
+
+  fs.writeFileSync(path.join(root, 'package.json'), JSON.stringify(packageJson, null, 2) + os.EOL);
 }
 
 function installApp(appPath, appType, runtime) {
-  switch (appType) {
-    case "ui":
-      installUIApp(appPath);
+  switch (runtime) {
+    case 'python': {
       break;
+    }
+    default: {
+      installJsApp(appPath, appType);
+
+      break;
+    }
   }
 }
 
-function installUIApp(appPath) {
-  let command;
-  let args;
-  const useYarn = true;
+function installJsApp(appPath, appType) {
+  const command = packageManager;
+  const args = ['install'];
 
-  //@TODO: Add npm support
-  if (useYarn) {
-    command = "yarn";
-    args = ["install"];
-  }
-
-  console.log(chalk.yellow("Installing template dependencies using yarn..."));
-  const proc = spawn.sync(command, args, { stdio: "inherit", cwd: appPath });
+  console.log(chalk.yellow(`Installing template dependencies using ${command}...`));
+  const proc = spawn.sync(command, args, { stdio: 'inherit', cwd: appPath });
 
   if (proc.status !== 0) {
-    console.error(`\`${command} ${args.join(" ")}\` failed`);
+    console.error(`\`${command} ${args.join(' ')}\` failed`);
     return;
   }
 
-  console.log(chalk.green("Successfull project install"));
+  console.log(chalk.green('Successfull project install'));
 
   let initializedGit = false;
   if (versioning.tryGitInit(appPath)) {
     initializedGit = true;
     console.log();
-    console.log("Initialized a git repository.");
+    console.log('Initialized a git repository.');
   }
 
   if (initializedGit && versioning.tryGitCommit(appPath)) {
     console.log();
-    console.log("Created git commit.");
+    console.log('Created git commit.');
   }
 
   console.log();
   console.log(`Success! Created ${projectName} at ${appPath}`);
-  console.log("Inside that directory, you can run several commands:");
-  helpCommands();
-}
 
-function helpCommands() {
-  const useYarn = true;
+  if (appType === APP_TYPES.UI) {
+    console.log('Inside that directory, you can run several commands:');
+    helpCommands();
+  }
+}
 
-  const displayedCommand = useYarn ? "yarn" : "npm";
+async function helpCommands() {
+  const displayedCommand = packageManager;
+  const useYarn = shouldUseYarn();
 
   console.log();
   console.log(chalk.cyan(`  ${displayedCommand} start`));
-  console.log("    Starts the development server.");
+  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(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(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}zip`));
+  console.log('    Bundles the app into ZIP file in app root directory');
   console.log();
 }
 

package/package.json

@@ -1,61 +1,65 @@
 {
-  "name": "@corva/create-app",
-  "version": "0.11.0-0",
-  "keywords": [
-    "react"
-  ],
-  "private": false,
-  "description": "Create app to use it in CORVA.AI",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/corva-ai/create-corva-app",
-    "directory": "@corva/create-app"
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=10"
-  },
-  "scripts": {
-    "build": "echo \"build is not configured for package \\\"×\\\", skipping.\"",
-    "get-changelog": "conventional-changelog -r 2 -p angular",
-    "release": "git add -A && standard-version -a"
-  },
-  "bugs": {
-    "url": "https://github.com/facebook/create-react-app/issues"
-  },
-  "files": [
-    "index.js",
-    "constants",
-    "helpers",
-    "template",
-    "scripts"
-  ],
-  "bin": {
-    "create-corva-app": "./index.js"
-  },
-  "standard-version": {
-    "skip": {
-      "tag": true
+    "name": "@corva/create-app",
+    "version": "0.12.0-2",
+    "private": false,
+    "description": "Create app to use it in CORVA.AI",
+    "keywords": [
+        "react"
+    ],
+    "bugs": {
+        "url": "https://github.com/facebook/create-react-app/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/corva-ai/create-corva-app",
+        "directory": "@corva/create-app"
+    },
+    "license": "MIT",
+    "bin": {
+        "create-corva-app": "./index.js"
+    },
+    "files": [
+        "index.js",
+        "constants",
+        "helpers",
+        "template",
+        "scripts"
+    ],
+    "scripts": {
+        "lint": "prettier . --write",
+        "build": "echo \"build is not configured for package \\\"×\\\", skipping.\"",
+        "get-changelog": "conventional-changelog -r 2 -p angular",
+        "release": "git add -A && standard-version -a"
+    },
+    "dependencies": {
+        "archiver": "^5.0.0",
+        "chalk": "4.1.0",
+        "commander": "^8.2.0",
+        "conventional-changelog-cli": "^2.1.0",
+        "cross-spawn": "7.0.3",
+        "envinfo": "7.5.1",
+        "figlet": "^1.5.0",
+        "fs-extra": "9.0.1",
+        "hyperquest": "2.1.3",
+        "inquirer": "7.3.2",
+        "npm-api": "^1.0.0",
+        "semver": "7.3.2",
+        "tar-pack": "3.4.1",
+        "tmp": "0.2.1",
+        "validate-npm-package-name": "3.0.0"
+    },
+    "devDependencies": {
+        "@corva/eslint-config-browser": "^0.0.4",
+        "@corva/eslint-config-node": "^4.2.0",
+        "prettier": "^2.4.1",
+        "standard-version": "^9.0.0"
+    },
+    "engines": {
+        "node": ">=10"
+    },
+    "standard-version": {
+        "skip": {
+            "tag": true
+        }
     }
-  },
-  "dependencies": {
-    "archiver": "^5.0.0",
-    "chalk": "4.1.0",
-    "commander": "4.1.0",
-    "conventional-changelog-cli": "^2.1.0",
-    "cross-spawn": "7.0.3",
-    "envinfo": "7.5.1",
-    "figlet": "^1.5.0",
-    "fs-extra": "9.0.1",
-    "hyperquest": "2.1.3",
-    "inquirer": "7.3.2",
-    "npm-api": "^1.0.0",
-    "semver": "7.3.2",
-    "tar-pack": "3.4.1",
-    "tmp": "0.2.1",
-    "validate-npm-package-name": "3.0.0"
-  },
-  "devDependencies": {
-    "standard-version": "^9.0.0"
-  }
 }

package/scripts/ui/index.js

@@ -1,5 +1,5 @@
-const zipAppSource = require("./zipAppSource");
+const zipAppSource = require('./zipAppSource');
 
 module.exports = {
-  zipAppSource
+  zipAppSource,
 };