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

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.12.0-2](https://github.com/corva-ai/create-corva-app/compare/v0.12.0-1...v0.12.0-2) (2021-09-21)
+
+
+### Features
+
+* add typescript app templates ([f256b39](https://github.com/corva-ai/create-corva-app/commit/f256b3970b4a2f426c6f87ddd10fe5c957757658))
+* **DC-2167:** updated node templates to use latest sdk ([#118](https://corvaqa.atlassian.net/browse/118)) ([c9dc93a](https://github.com/corva-ai/create-corva-app/commit/c9dc93a07a48b06f4c0831bcd95aca4fd5b5504c))
+
+## [0.12.0-1](https://github.com/corva-ai/create-corva-app/compare/v0.12.0-0...v0.12.0-1) (2021-09-20)
+
+
+### Features
+
+* **DC-2204:** Add .env file to gitignore ([cb598d6](https://github.com/corva-ai/create-corva-app/commit/cb598d654dcd78f20ce93c6dcf7bf4282cad47c9))
+
+## [0.12.0-0](https://github.com/corva-ai/create-corva-app/compare/v0.11.0-0...v0.12.0-0) (2021-09-14)
+
+
+### Features
+
+* **DC-2132:** add scheduler type to manifest template ([#112](https://corvaqa.atlassian.net/browse/112)) ([4955186](https://github.com/corva-ai/create-corva-app/commit/4955186a4d2e5ee8c0d5a3e44ecd54752d561de3))
+
 ## [0.11.0-0](https://github.com/corva-ai/create-corva-app/compare/v0.10.0-0...v0.11.0-0) (2021-08-31)
 
 ## [0.10.0-0](https://github.com/corva-ai/create-corva-app/compare/v0.9.0-0...v0.10.0-0) (2021-08-18)

package/README.md

@@ -0,0 +1,57 @@
+# @corva/create-app
+
+Apps generator for [corva.ai](https://corva.ai).
+
+## Prerequisites
+
+- NodeJs 12+ (https://nodejs.org/en/download/)
+
+## Installation
+
+```sh
+npm i -g @corva/create-app
+```
+
+## Usage
+
+`corva-create-app` provides a user-friendly CLI wizard to create an app.
+
+```sh
+Usage: corva-create-app <project-directory> [options]
+
+Arguments:
+  project-directory             project directory to work with
+
+Options:
+  -V, --version                 output the version number
+  -z, --zip <type>              zip app source
+  -t, --useTypescript           use typescript or javascript (default: false)
+  -p, --packageManager <value>  package manager to use (choices: "npm", "yarn", default: "yarn")
+  --appType [value]
+  --appKey [value]
+  --appName [value]
+  --category [value]
+  --segments [value]
+  --runtime [value]
+  -h, --help                    display help for command
+```
+
+## Examples
+
+### Create a UI application
+
+```sh
+create-corva-app test --appName "Test" --segments "drilling" --category "wellDesign" --appKey "some-company.test.ui" --appType "ui" --runtime "ui"
+```
+
+### Create a NodeJs TypeScript application
+
+```sh
+create-corva-app test --appName "Test" --segments "drilling" --category "wellDesign" --appKey "some-company.test.scheduler" --appType "scheduler" --runtime "nodejs12.x" -t
+```
+
+### Create a Python application
+
+```sh
+create-corva-app test --appName "Test" --segments "drilling" --category "analytics" --appKey "some-company.test.stream" --appType "stream" --runtime "python3.8"
+```

package/constants/manifest.js

@@ -1,30 +1,29 @@
 const defaultManifest = {
   format: 1,
   license: {
-    type: "MIT",
-    url: "https://www.oandgexample.com/license/",
+    type: 'MIT',
+    url: 'https://www.oandgexample.com/license/',
   },
   developer: {
-    name: "O&G Company",
-    identifier: "oandgc",
+    name: 'O&G Company',
+    identifier: 'oandgc',
     authors: [],
   },
   application: {
-    type: "ui",
-    key: "app.key-goes-here",
-    visibility: "private",
-    name: "Name of My App",
-    description:
-      "This is the description of my app. You can do great things with it!",
-    summary: "More information about this app goes here",
-    category: "",
-    website: "https://www.oandgexample.com/my-app/",
-    segments: ["drilling", "completion"],
+    type: 'ui',
+    key: 'app.key-goes-here',
+    visibility: 'private',
+    name: 'Name of My App',
+    description: 'This is the description of my app. You can do great things with it!',
+    summary: 'More information about this app goes here',
+    category: '',
+    website: 'https://www.oandgexample.com/my-app/',
+    segments: ['drilling', 'completion'],
   },
   settings: {
     entrypoint: {
-      file: "index.js",
-      function: "handler",
+      file: 'index.js',
+      function: 'handler',
     },
     environment: {},
   },
@@ -37,8 +36,8 @@ const defaultUIAppManifest = {
   },
   settings: {
     entrypoint: {
-      file: "src/index.js",
-      function: "handler",
+      file: 'src/index.js',
+      function: 'handler',
     },
     environment: {},
   },
@@ -47,8 +46,8 @@ const defaultUIAppManifest = {
 const defaultDataAppNodeManifest = {
   settings: {
     entrypoint: {
-      file: "index.js",
-      function: "handler",
+      file: 'index.js',
+      function: 'handler',
     },
     timeout: 120,
     memory: 128,
@@ -59,8 +58,8 @@ const defaultDataAppNodeManifest = {
 const defaultDataAppPythonManifest = {
   settings: {
     entrypoint: {
-      file: "lambda_function",
-      function: "lambda_handler",
+      file: 'lambda_function',
+      function: 'lambda_handler',
     },
     timeout: 120,
     memory: 128,
@@ -68,43 +67,86 @@ const defaultDataAppPythonManifest = {
   },
 };
 
-const defaultSchedulerAppSettings = {
-  app: {
-    cron_string: "*/5 * * * *",
-  },
+const defaultTimeSchedulerSettings = {
+  scheduler_type: 'data_time',
+  cron_string: '*/5 * * * *',
 };
 
-const MANIFEST_MANDATORY_KEYS = [
-  'appType',
-  'appKey',
-  'appName',
-  'category',
-  'segments',
-  'runtime'
-];
+const defaultDepthSchedulerSettings = {
+  scheduler_type: 'data_depth',
+  depth_milestone: 1,
+};
 
-const manifestOptions = {
-  developerName: "O&G Company",
-  developerIdentifier: "oandgc",
+const MANIFEST_MANDATORY_KEYS = ['appType', 'appKey', 'appName', 'category', 'segments', 'runtime'];
 
-  appType: ["ui", "scheduler", "stream", "task"],
-  appKey: "app.key-goes-here",
-  appName: "Name of My App",
-  description:
-    "This is the description of my app. You can do great things with it!",
-  summary: "More information about this app goes here",
-  category: "",
-  website: "https://www.oandgexample.com/my-app/",
-  segments: ["drilling", "completion"],
-  runtime: ["ui", "python3.8", "nodejs12.x"]
-};
+const manifestOptions = (projectName) => [
+  { name: 'developerName', message: 'Enter the Developer Name', default: 'O&G Company' },
+  { name: 'developerIdentifier', message: 'Enter the Developer Identifier', default: 'oandgc' },
+  {
+    type: 'rawlist',
+    name: 'appType',
+    message: 'Choose the App Type',
+    default: 'ui',
+    choices: ['ui', 'scheduler', 'stream', 'task'],
+  },
+  { name: 'appKey', message: 'Enter the App Key', default: 'app.key-goes-here' },
+  { name: 'appName', message: 'Enter the App Name', default: projectName },
+  {
+    name: 'description',
+    message: 'Enter description',
+    default: 'This is the description of my app. You can do great things with it!',
+  },
+  {
+    name: 'summary',
+    message: 'Enter summary',
+    default: 'More information about this app goes here',
+  },
+  { name: 'category', message: 'Enter category', default: '' },
+  { name: 'website', message: 'Enter website', default: 'https://www.oandgexample.com/my-app/' },
+  {
+    type: 'rawlist',
+    name: 'segments',
+    message: 'Choose segments',
+    choices: ['drilling', 'completion'],
+  },
+  {
+    type: 'rawlist',
+    name: 'runtime',
+    message: 'Choose runtime',
+    choices: ['python3.8', 'nodejs12.x'],
+    when: (answers) => answers.appType !== 'ui',
+  },
+  {
+    type: 'rawlist',
+    name: 'packageManager',
+    message: 'Please select the desired package manager',
+    default: 'yarn',
+    choices: ['yarn', 'npm'],
+    when: (answers) => !answers.runtime || !answers.runtime.startsWith('python'),
+  },
+  {
+    type: 'confirm',
+    name: 'useTypescript',
+    message: 'Would you like to use TypesScript?',
+    default: false,
+    when: (answers) => answers.runtime && answers.runtime.startsWith('nodejs'),
+  },
+  {
+    type: 'rawlist',
+    name: 'schedulerType',
+    message: 'Choose schedulerType',
+    choices: ['data_time', 'data_depth', 'natural_time'],
+    when: (answers) => answers.appType === 'scheduler',
+  },
+];
 
 module.exports = {
   defaultManifest,
   defaultUIAppManifest,
   defaultDataAppNodeManifest,
   defaultDataAppPythonManifest,
-  defaultSchedulerAppSettings,
+  defaultTimeSchedulerSettings,
+  defaultDepthSchedulerSettings,
   manifestOptions,
   MANIFEST_MANDATORY_KEYS,
 };

package/constants/package.js

@@ -1,36 +1,35 @@
 const dependencies = {
   devDependencies: {
-    "postcss-loader": "4.1.0"
+    'postcss-loader': '4.1.0',
   },
   dependencies: {
-    "@corva/ui": "latest",
-    "@material-ui/core": "4.11.2",
-    "@material-ui/icons": "4.9.1",
-    "@material-ui/lab": "4.0.0-alpha.57",
-    "@material-ui/pickers": "3.2.10",
-    classnames: "2.2.6",
-    "corva-convert-units": "1.10.17",
-    highcharts: "8.1.2",
-    "highcharts-react-official": "2.2.2",
-    lodash: "^4.17.4",
-    "mapbox.js": "3.2.1",
-    moment: "2.23.0",
-    "moment-timezone": "0.5.23",
-    "prop-types": "^15.6.1",
-    react: "17.0.1",
-    "react-dom": "17.0.1"
-  }
+    '@corva/ui': 'latest',
+    '@material-ui/core': '4.11.2',
+    '@material-ui/icons': '4.9.1',
+    '@material-ui/lab': '4.0.0-alpha.57',
+    '@material-ui/pickers': '3.2.10',
+    'classnames': '2.2.6',
+    'corva-convert-units': '1.10.17',
+    'highcharts': '8.1.2',
+    'highcharts-react-official': '2.2.2',
+    'lodash': '^4.17.4',
+    'mapbox.js': '3.2.1',
+    'moment': '2.23.0',
+    'moment-timezone': '0.5.23',
+    'prop-types': '^15.6.1',
+    'react': '17.0.1',
+    'react-dom': '17.0.1',
+  },
 };
 
 const scripts = {
-  build: "webpack --config=./config-overrides.js --mode production",
-  start:
-    "webpack-dev-server --config=./config-overrides.js --open --mode development",
-  zip: "create-corva-app --zip ui",
-  lint: "eslint --cache ./src/"
+  build: 'webpack --config=./config-overrides.js --mode production',
+  start: 'webpack-dev-server --config=./config-overrides.js --open --mode development',
+  zip: 'create-corva-app --zip ui',
+  lint: 'eslint --cache ./src/',
 };
 
 module.exports = {
   dependencies,
-  scripts
+  scripts,
 };

package/helpers/manifest.js

@@ -1,9 +1,12 @@
-const manifestConstants = require("../constants/manifest.js");
+const manifestConstants = require('../constants/manifest.js');
 
 function fillManifest(answers) {
+  const runtime = answers.runtime || 'ui';
+
   const defaultManifestProperties = _defaultManifestProperties({
     type: answers.appType,
-    runtime: answers.runtime
+    // fallback to UI
+    runtime,
   });
 
   const manifest = {
@@ -13,7 +16,7 @@ function fillManifest(answers) {
       ...manifestConstants.defaultManifest.developer,
       ...defaultManifestProperties.developer,
       name: answers.developerName,
-      identifier: answers.developerIdentifier
+      identifier: answers.developerIdentifier,
     },
     application: {
       ...manifestConstants.defaultManifest.application,
@@ -25,13 +28,13 @@ function fillManifest(answers) {
       summary: answers.summary,
       category: answers.category,
       website: answers.website,
-      segments: [answers.segments]
+      segments: [answers.segments],
     },
     settings: {
       ...defaultManifestProperties.settings,
-      runtime: answers.runtime,
-      ...defaultAppSettings({ type: answers.appType }),
-    }
+      runtime,
+      ...defaultAppSettings({ type: answers.appType, schedulerType: answers.schedulerType }),
+    },
   };
 
   return manifest;
@@ -49,14 +52,24 @@ function _defaultManifestProperties({ type, runtime }) {
   return manifestConstants.defaultDataAppNodeManifest;
 }
 
-function defaultAppSettings({ type }) {
-  if (type === 'scheduler') {
-    return manifestConstants.defaultSchedulerAppSettings;
+function defaultAppSettings({ type, schedulerType }) {
+  if (!schedulerType) {
+    return {};
   }
 
-  return {};
+  const schedulerAppSettings =
+    schedulerType == 'data_depth'
+      ? manifestConstants.defaultDepthSchedulerSettings
+      : manifestConstants.defaultTimeSchedulerSettings;
+
+  return {
+    app: {
+      ...schedulerAppSettings,
+      scheduler_type: schedulerType || 'data_time',
+    },
+  };
 }
 
 module.exports = {
-  fillManifest
+  fillManifest,
 };

package/helpers/utils.js

@@ -1,5 +1,5 @@
-const path = require("path");
-const fs = require("fs-extra");
+const path = require('path');
+const fs = require('fs-extra');
 
 function copyFileSync(source, target) {
   let targetFile = target;

package/helpers/versioning.js

@@ -1,9 +1,9 @@
-const execSync = require("child_process").execSync;
+const execSync = require('child_process').execSync;
 
 function isInGitRepository(appPath) {
   try {
-    execSync("git rev-parse --is-inside-work-tree", {
-      stdio: "ignore",
+    execSync('git rev-parse --is-inside-work-tree', {
+      stdio: 'ignore',
       cwd: appPath,
     });
     return true;
@@ -17,25 +17,25 @@ function tryGitInit(appPath) {
     if (isInGitRepository()) {
       return false;
     }
-    execSync("git --version", { stdio: "ignore", cwd: appPath });
+    execSync('git --version', { stdio: 'ignore', cwd: appPath });
 
-    execSync("git init", { stdio: "ignore", cwd: appPath });
-    console.log("Initialized git repo in app");
+    execSync('git init', { stdio: 'ignore', cwd: appPath });
+    console.log('Initialized git repo in app');
     return true;
   } catch (e) {
-    console.warn("Git repo not initialized", e);
+    console.warn('Git repo not initialized', e);
     return false;
   }
 }
 
 function tryGitCommit(appPath) {
   try {
-    execSync("git add -A", { stdio: "ignore", cwd: appPath });
+    execSync('git add -A', { stdio: 'ignore', cwd: appPath });
     execSync('git commit -m "Initialize project using Create React App"', {
-      stdio: "ignore",
+      stdio: 'ignore',
       cwd: appPath,
     });
-    console.log("Added first git commit");
+    console.log('Added first git commit');
     return true;
   } catch (e) {
     // We couldn't commit in already initialized git repo,
@@ -43,11 +43,11 @@ function tryGitCommit(appPath) {
     // In the future, we might supply our own committer
     // like Ember CLI does, but for now, let's just
     // remove the Git files to avoid a half-done state.
-    console.warn("Git commit not created", e);
-    console.warn("Removing .git directory...");
+    console.warn('Git commit not created', e);
+    console.warn('Removing .git directory...');
     try {
       // unlinkSync() doesn't work on directories.
-      fs.removeSync(path.join(appPath, ".git"));
+      fs.removeSync(path.join(appPath, '.git'));
     } catch (removeErr) {
       // Ignore.
     }
@@ -57,7 +57,7 @@ function tryGitCommit(appPath) {
 
 function shouldUseYarn(appPath) {
   try {
-    execSync("yarnpkg --version", { stdio: "ignore", cwd: appPath });
+    execSync('yarnpkg --version', { stdio: 'ignore', cwd: appPath });
     return true;
   } catch (e) {
     return false;