@corva/create-app 0.48.0-1 → 0.48.0-3

package/README.md

@@ -44,23 +44,25 @@ Arguments:
   project-directory               project directory to work with (default: "Current working dir")
 
 Options:
-  --appKey [string]               Enter the App Key (default: "app.key-goes-here")
-  --appName [string]              Enter the App Name
-  --appType [string]              Choose the App Type (choices: "ui", "scheduler", "stream", "task", default: "ui")
-  --category [string]             Enter category (default: "")
+  --developerName [string]        Enter the Developer Name (default: "O&G Company")
+  --developerIdentifier [string]  Enter the Developer Identifier (default: "oandgc")
+  --appType                       Choose the App Type (choices: "ui", "scheduler", "stream", "task")
+  --schedulerType                 Choose the scheduler type (choices: "1", "2", "4")
   --cronString [string]           Provide CRON string for the scheduler (default: "*/5 * * * *")
   --depthMilestone [number]       Provide depth milestone for the scheduler (default: 1)
+  --logType                       Choose the log type (choices: "time", "depth")
+  --appName [string]              Enter the App Name (default: "Corva Dev Center App")
   --description [string]          Enter description (default: "This is the description of my app. You can do great things with it!")
-  --developerIdentifier [string]  Enter the Developer Identifier (default: "oandgc")
-  --developerName [string]        Enter the Developer Name (default: "O&G Company")
-  --runtime [string]              Choose runtime (choices: "ui", "nodejs16.x", "python3.8", "python3.9")
-  --schedulerType [number]        Choose the scheduler type (choices: "1", "2", "4", default: 1)
-  --segments [string]             Choose segments (choices: "drilling", "completion")
   --summary [string]              Enter summary (default: "More information about this app goes here")
+  --category [string]             Enter category (default: "")
   --website [string]              Enter website (default: "https://www.oandgexample.com/my-app/")
-  -p, --packageManager [string]   Please select the desired package manager (choices: "yarn", "npm", default: "yarn")
+  --segments                      Choose segments (choices: "drilling", "completion")
+  --runtime                       Choose runtime (choices: "ui", "nodejs16.x", "python3.8", "python3.9")
+  -p, --packageManager            Please select the desired package manager (choices: "yarn", "npm")
   -t, --useTypescript [boolean]   Would you like to use TypesScript? (default: false)
   --silent [boolean]              Only log result of the operation (default: false)
+  --no-dependencies-install       Skip installing dependencies
+  --no-git-init                   Skip initializing git repository
 ```
 
 ### Examples

package/lib/constants/manifest.js

@@ -34,7 +34,11 @@ export const defaultManifest = {
 
 export const defaultUIAppManifest = {
   application: {
-    ui: { initial_size: { w: 4, h: 10 } },
+    ui: {
+      initial_size: { w: 4, h: 10 },
+      multi_rig: false,
+      full_screen_report: false,
+    },
   },
   settings: {
     entrypoint: {
@@ -240,4 +244,12 @@ export const manifestOptions = (projectName = 'Corva Dev Center App') => [
     message: 'Only log result of the operation',
     default: false,
   },
+  {
+    name: 'no-dependencies-install',
+    message: 'Skip installing dependencies',
+  },
+  {
+    name: 'no-git-init',
+    message: 'Skip initializing git repository',
+  },
 ];

package/lib/constants/package.js

@@ -71,7 +71,7 @@ const tsUiPackage = {
 const nodeNpmScripts = {
   'bundle': 'create-corva-app zip .',
   'test': 'npm audit --production && npm run unit',
-  'unit': 'jest --setupFiles dotenv/config',
+  'unit': 'jest',
   'lint': 'eslint --ext .js,.ts .',
   'lint:fix': 'eslint --ext .js,.ts --fix .',
 };
@@ -121,6 +121,9 @@ const nodeNpmPackage = {
   dependencies: nodeDependencies,
   devDependencies: nodeDevDependencies,
   scripts: nodeNpmScripts,
+  jest: {
+    setupFiles: ['dotenv/config'],
+  },
 };
 
 const nodeYarnPackage = {
@@ -135,6 +138,7 @@ const nodeTsNpmPackage = {
   jest: {
     preset: 'ts-jest',
     testEnvironment: 'node',
+    ...nodeNpmPackage.jest,
   },
 };
 

package/lib/helpers/versioning.js

@@ -23,7 +23,7 @@ export function isInGitRepository(appPath) {
 
 export function tryGitInit(appPath) {
   try {
-    if (isInGitRepository()) {
+    if (isInGitRepository(appPath)) {
       debug('is in git repository');
 
       return false;
@@ -50,7 +50,6 @@ export function tryGitCommit(appPath) {
       stdio: 'ignore',
       cwd: appPath,
     });
-    logger.log('Added first git commit');
 
     return true;
   } catch (e) {

package/lib/main.js

@@ -130,10 +130,11 @@ export async function run() {
 
   manifestConstants.manifestOptions().forEach((value) => {
     const type = typeof value.default;
-    const option = new Option(
-      `${value.alias ? `-${value.alias}, ` : ''}--${value.name} [${(type !== 'undefined' && type) || 'string'}]`,
-      value.message,
-    );
+    const cliType = type === 'undefined' ? (value.choices ? ' [string]' : '') : ` [${type}]`;
+    const alias = value.alias ? `-${value.alias}, ` : '';
+    const optionString = `${alias}--${value.name}${cliType}`;
+
+    const option = new Option(optionString, value.message);
 
     if (value.choices) {
       if (typeof value.choices === 'function') {
@@ -377,7 +378,15 @@ async function initPackage(projectName, opts) {
 
   await addTemplate(root, manifest, runtime);
   await configureApp(root, manifest, runtime);
-  await installApp(root, manifest, runtime);
+
+  opts.dependenciesInstall && (await installDependencies(root, manifest, runtime));
+
+  opts.gitInit && (await initVersioning(root, manifest, runtime));
+
+  logger.log();
+  logger.log(`Success! Created ${chalk.green(manifest.name)} at ${chalk.yellow(root)}`);
+
+  helpCommands(manifest, runtime);
 
   logger.log();
 }
@@ -538,68 +547,78 @@ function addPackageJSON(root, manifest, runtime) {
 }
 
 /**
- *
  * @param {string} root
  * @param {import('./flows/lib/manifest').Manifest} manifest
+ * @param {import('./helpers/resolve-app-runtime.js').Runtime} runtime
+ * @returns {Promise<void>}
+ * @throws {Error}
+ * @throws {import('child_process').ExecException}
+ * @throws {import('child_process').SpawnSyncReturns<Buffer>}
  */
-async function installApp(root, manifest, runtime) {
+async function installDependencies(root, manifest, runtime) {
   const command = manifest.isJs() ? runtime.packageManager : 'make';
 
-  if (!IS_WINDOWS || manifest.isJs()) {
-    const args = ['install'];
-    const opts = { stdio: ['inherit', 'inherit', 'pipe'], cwd: root };
-
-    if (process.env.CI && command === 'yarn') {
-      args.push('--cache-folder=".yarn-cache"');
-    }
+  if (IS_WINDOWS && !manifest.isJs()) {
+    logger.log();
+    logger.log(`⚠️ ${chalk.yellow('Please install project dependencies manually')}`);
 
-    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
-        .toString('utf8')
-        .split('\n')
-        // NOTE: filter out warnings caused by @corva/ui peer dependencies
-        .filter((line) => !line.includes('@corva/ui'))
-        .join('\n');
-
-      console.log(error);
-    }
+    return;
+  }
 
-    if (proc.status !== 0) {
-      console.error(`\`${command} ${args.join(' ')}\` failed`);
+  const args = ['install'];
+  const opts = { stdio: ['inherit', 'inherit', 'pipe'], cwd: root };
 
-      return;
-    }
+  if (process.env.CI && command === 'yarn') {
+    args.push('--cache-folder=".yarn-cache"');
+  }
 
-    logger.log(chalk.green('Successfull project install'));
-  } else {
-    logger.log();
-    logger.log(`⚠️ ${chalk.yellow('Please install project dependencies manually')}`);
+  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
+      .toString('utf8')
+      .split('\n')
+      // NOTE: filter out warnings caused by @corva/ui peer dependencies
+      .filter((line) => !line.includes('@corva/ui'))
+      .join('\n');
+
+    console.log(error);
   }
 
-  if (versioning.tryGitInit(root)) {
-    logger.log();
-    logger.log('Initialized a git repository.');
+  if (proc.status !== 0) {
+    console.error(`\`${command} ${args.join(' ')}\` failed`);
 
-    if (versioning.tryGitCommit(root)) {
-      logger.log();
-      logger.log('Created git commit.');
-    }
+    return;
   }
 
+  logger.log(chalk.green('Successfull project install'));
+}
+
+/**
+ *
+ * @param {string} root
+ */
+async function initVersioning(root) {
   logger.log();
-  logger.log(`Success! Created ${chalk.green(manifest.name)} at ${chalk.yellow(root)}`);
 
-  helpCommands(manifest, runtime);
+  if (!versioning.tryGitInit(root)) {
+    logger.log('Already in a git repository. Skipping git initialization.');
+
+    return;
+  }
+
+  if (versioning.tryGitCommit(root)) {
+    logger.log();
+    logger.log('Created git commit');
+  }
 }
 
 async function helpCommands(manifest, { packageManager: displayedCommand }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@corva/create-app",
-  "version": "0.48.0-1",
+  "version": "0.48.0-3",
   "private": false,
   "description": "Create an app to use it in CORVA.AI",
   "keywords": [