feat(@embark/cmd): enable using engine with no embark.json

And show a message to run embark init if there is no embark.json

Author: jrainville

packages/core/core/src/config.ts

@@ -107,6 +107,7 @@ export class Config {
   constructor(options) {
     this.env = options.env || 'default';
     this.webServerConfig = options.webServerConfig;
+    this.embarkConfig = options.embarkConfig;
     this.configDir = options.configDir || DEFAULT_CONFIG_PATH;
     this.chainsFile = options.chainsFile;
     this.plugins = options.plugins;
@@ -181,12 +182,6 @@ export class Config {
       interceptLogs = true;
     }
 
-    if (!fs.existsSync(options.embarkConfig)) {
-      this.logger.error(__('Cannot find file %s Please ensure you are running this command inside the Dapp folder', options.embarkConfig));
-      process.exit(1);
-    }
-
-    this.embarkConfig = fs.readJSONSync(options.embarkConfig);
     this.embarkConfig.plugins = this.embarkConfig.plugins || {};
 
     this.plugins = new Plugins({

packages/core/engine/src/defaultEmbarkJson.js

@@ -0,0 +1,18 @@
+module.exports = {
+  contracts: ["contracts/**"],
+  app: {},
+  buildDir: "dist/",
+  config: "config/",
+  versions: {
+    solc: "0.6.1"
+  },
+  plugins: {
+  },
+  options: {
+    solc: {
+      "optimize": true,
+      "optimize-runs": 200
+    }
+  },
+  generationDir: "embarkArtifacts"
+};

packages/core/engine/src/index.ts

@@ -8,6 +8,7 @@ import {
 } from 'embark-core';
 import { normalizeInput } from 'embark-utils';
 import { Logger } from 'embark-logger';
+import defaultEmbarkJson from './defaultEmbarkJson';
 const EMBARK_PROCESS_NAME = 'embark';
 
 export class Engine {
@@ -60,7 +61,7 @@ export class Engine {
     this.env = options.env;
     this.client = options.client;
     this.locale = options.locale;
-    this.embarkConfig = options.embarkConfig;
+    this.embarkConfig = options.embarkConfig || defaultEmbarkJson;
     this.interceptLogs = options.interceptLogs;
     this.version = options.version;
     this.logFile = options.logFile;
@@ -90,14 +91,15 @@ export class Engine {
       logger: this.logger,
       events: this.events,
       context: this.context,
+      embarkConfig: this.embarkConfig,
       webServerConfig: this.webServerConfig,
       version: this.version,
       package: this.package,
       locale: this.locale,
       client: this.client,
       ipc: this.ipc
     });
-    this.config.loadConfigFiles({embarkConfig: this.embarkConfig, interceptLogs: this.interceptLogs});
+    this.config.loadConfigFiles({interceptLogs: this.interceptLogs});
     this.plugins = this.config.plugins;
 
     if (this.interceptLogs || this.interceptLogs === undefined) {
@@ -194,7 +196,7 @@ export class Engine {
     });
   }
 
-  serviceMonitor(_options) {
+  serviceMonitor() {
     this.servicesMonitor = new ServicesMonitor({ events: this.events, logger: this.logger, plugins: this.plugins });
 
     if (this.servicesMonitor) {
@@ -212,7 +214,7 @@ export class Engine {
     }
   }
 
-  coreComponents(_options) {
+  coreComponents() {
     // TODO: should be made into a component
     this.processManager = new ProcessManager({
       events: this.events,

packages/embark/src/bin/embark.js

@@ -4,12 +4,6 @@
 // on babel to achieve the same goal.
 // See: https://node.green/
 
-// KEY ASSUMPTION: for a DApp to be valid, from embark's perspective, it must
-// have a parsable embark.json file in its top-level directory; if that
-// requirement changes in the future then this script must be revised.
-// Hypothetical example of such a change: embark config info may be included in
-// package.json under `{"embark": {...}}` -or- stored in an embark.json file.
-
 function main() {
   if (whenNoShim()) return;
   var invoked = thisEmbark();
@@ -46,7 +40,7 @@ function main() {
   process.env.PKG_PATH = pkgJson.dirname;
   var embark = select(invoked, local);
   process.env.EMBARK_PATH = embark.pkgDir;
-  embark.exec();
+  embark.exec(embarkJson);
 }
 
 // -----------------------------------------------------------------------------
@@ -77,9 +71,9 @@ function EmbarkBin(binpath, kind) {
   this.pkgJson = undefined;
 }
 
-EmbarkBin.prototype.exec = function () {
+EmbarkBin.prototype.exec = function (embarkJson) {
   var Cmd = require('../cmd/cmd');
-  var cli = new Cmd();
+  var cli = new Cmd({embarkConfig: embarkJson.json});
   if(_logged) { console[this.loglevel](); }
   cli.process(process.argv);
 };
@@ -352,11 +346,16 @@ Json.prototype.log = function () {
 
 Json.prototype.loglevel = 'warn';
 
-Json.prototype.logMissingFile = function () {
+Json.prototype.logMissingFile = function (doReport) {
+  if (doReport === undefined) {
+    doReport = true;
+  }
   var missing;
   if (!this.realpath) {
     missing = true;
-    reportMissingFile(this.filepath, this.loglevel);
+    if (doReport) {
+      reportMissingFile(this.filepath, this.loglevel);
+    }
   }
   return missing;
 };
@@ -411,9 +410,14 @@ EmbarkJson.prototype.log = function () {
 };
 
 EmbarkJson.prototype.logMissingFile = function () {
-  if (isDappCmd(this.cmd) && Json.prototype.logMissingFile.call(this)) {
-    reportMissingFile_DappJson(this.cmd, this.loglevel, 'embark', 'in');
-    exitWithError();
+  if (Json.prototype.logMissingFile.call(this, false)) {
+    // Use default embark.json
+    if (isDappCmd(this.cmd)) {
+      // TODO add message about embark init once it's available
+      embarklog['warn']('No embark.json file found.\n' +
+        'You can find a basic embark.json file here: https://github.com/embarklabs/embark/blob/master/dapps/templates/boilerplate/embark.json');
+      exitWithError();
+    }
   }
 };