[Minor] [Feature] allow user to change app's root directory (#1760)

packages/xarc-app-dev/src/config/archetype.ts

@@ -15,7 +15,12 @@ let cachedArchetype = null;
  * @returns options - final options with defaults and env applied
  */
 module.exports = function getDevOptions(user: XarcOptions = {}) {
+  //checking for cwd from xclap or from env
+  const cwd = user.cwd || process.env.XARC_CWD || process.cwd();
+  process.env.XARC_CWD = cwd;
+
   if (cachedArchetype) {
+    // if cached is already runnig
     cachedArchetype._fromCache = true;
     // maintained for backwards compatibility
     return cachedArchetype;
@@ -24,7 +29,7 @@ module.exports = function getDevOptions(user: XarcOptions = {}) {
   // first get legacy configs
   const legacy = getDevArchetypeLegacy();
   // try to read xarc-options.json if it exist and merge it into legacy
-  const xarcOptions = loadXarcOptions();
+  const xarcOptions = loadXarcOptions(cwd, false);
   user = _.merge({}, xarcOptions, user);
   const proxy = getEnvProxy();
 
@@ -40,6 +45,7 @@ module.exports = function getDevOptions(user: XarcOptions = {}) {
   // merge the rest into top level
   _.merge(legacy, {
     ...user,
+    cwd,
     webpackOptions: undefined,
     babelOptions: undefined,
     addOnFeatures: undefined

packages/xarc-app-dev/src/config/get-dev-proxy.ts

@@ -5,8 +5,11 @@ const Path = require("path");
 const Fs = require("fs");
 
 let cachedProxy = null;
+import { loadXarcOptions } from "../lib/utils";
 
 module.exports = function createDevProxy() {
+  const xarcOptions = loadXarcOptions();
+  const xarcCwd = xarcOptions.cwd;
   if (cachedProxy) {
     return cachedProxy;
   }
@@ -65,8 +68,8 @@ module.exports = function createDevProxy() {
 
     const searchDirs = ["", "config", "test", "src"];
     for (const f of searchDirs) {
-      const key = Path.resolve(f, "dev-proxy.key");
-      const cert = Path.resolve(f, "dev-proxy.crt");
+      const key = Path.resolve(xarcCwd, f, "dev-proxy.key");
+      const cert = Path.resolve(xarcCwd, f, "dev-proxy.crt");
       if (Fs.existsSync(key) && Fs.existsSync(cert)) {
         return { key, cert };
       }

packages/xarc-app-dev/src/config/jest/jest.config.ts

@@ -13,14 +13,15 @@ const jestMajVersion = parseInt(jestPkg.version.split(".")[0], 10);
 import { loadXarcOptions } from "../../lib/utils";
 
 const xarcOptions = loadXarcOptions();
+const xarcCwd = xarcOptions.cwd;
 
 const { enableTypeScript } = xarcOptions.babel;
 
 // https://jestjs.io/docs/en/configuration.html#testregex-string
 const scrTypes = enableTypeScript ? "jt" : "j";
 const testRegex = `(/_?_tests?_?_/.*|(\\.|\/)(test|spec))\\.[${scrTypes}]sx?$`;
 
-const rootDir = process.cwd();
+const rootDir = xarcCwd;
 
 const jestDefaultConfig = {
   rootDir,

packages/xarc-app-dev/src/config/karma/karma.conf.coverage.ts

@@ -16,8 +16,12 @@ const webpackCovCfg = require(customCheck.getWebpackStartConfig(
   "../webpack/webpack.config.coverage",
   false
 ));
+import { loadXarcOptions } from "../../lib/utils";
 
 module.exports = function(config) {
+  const xarcOptions = loadXarcOptions();
+  const xarcCwd = xarcOptions.cwd;
+
   karmaConf(config);
   const settings = {
     reporters: ["spec", "sonarqubeUnit", "coverage"],
@@ -28,12 +32,12 @@ module.exports = function(config) {
         { type: "lcov", subdir: "." },
         { type: "text", subdir: "." }
       ],
-      dir: Path.resolve("coverage", "client")
+      dir: Path.resolve(xarcCwd, "coverage", "client")
     },
     sonarQubeUnitReporter: {
       sonarQubeVersion: "5.x",
       outputFile: "gunit.xml",
-      outputDir: Path.resolve("coverage", "client"),
+      outputDir: Path.resolve(xarcCwd, "coverage", "client"),
       useBrowserName: false
     }
   };

packages/xarc-app-dev/src/config/karma/karma.conf.dev.ts

@@ -13,12 +13,15 @@ export {};
 const loadUserConfig = require("./util/load-user-config");
 const Path = require("path");
 const browserSettings = require("./browser-settings");
+import { loadXarcOptions } from "../../lib/utils";
 
 module.exports = function(config) {
+  const xarcOptions = loadXarcOptions();
+  const xarcCwd = xarcOptions.cwd;
   const settings = {
     frameworks: ["mocha"],
     reporters: ["spec"],
-    basePath: process.cwd(), // repository root.
+    basePath: xarcCwd, // repository root.
     files: [
       // Test bundle (must be created via `npm run dev|server-test`)
       "http://127.0.0.1:3001/assets/bundle.js"

packages/xarc-app-dev/src/config/karma/karma.conf.ts

@@ -6,6 +6,7 @@ const customCheck = require("@xarc/webpack/lib/util/custom-check");
 const loadUserConfig = require("./util/load-user-config");
 const browserSettings = require("./browser-settings");
 const loadElectrodeDll = require("./util/load-electrode-dll");
+import { loadXarcOptions } from "../../lib/utils";
 
 function getXarcOptPlugins() {
   try {
@@ -54,7 +55,9 @@ function getArchetypeOptPlugins() {
 let MAIN_PATH;
 
 try {
-  MAIN_PATH = require.resolve(Path.resolve("test/karma-entry"));
+  const xarcOptions = loadXarcOptions();
+  const xarcCwd = xarcOptions.cwd;
+  MAIN_PATH = require.resolve(Path.resolve(xarcCwd, "test/karma-entry"));
 } catch (err) {
   if (getXarcOptPlugins()) {
     MAIN_PATH = require.resolve("./entry-xarc.js");
@@ -89,8 +92,10 @@ module.exports = function(config) {
     console.error("ERROR: @xarc/opt-karma not found - running karma tests is not possible");
     plugins = [];
   }
+  const xarcOptions = loadXarcOptions();
+  const xarcCwd = xarcOptions.cwd;
   const settings = {
-    basePath: process.cwd(),
+    basePath: xarcCwd,
     frameworks: ["mocha", "intl-shim"],
     files: DLL_PATHS.concat(MAIN_PATH),
     plugins,
@@ -123,12 +128,12 @@ module.exports = function(config) {
         { type: "lcov", subdir: "." },
         { type: "text", subdir: "." }
       ],
-      dir: Path.resolve("coverage", "client")
+      dir: Path.resolve(xarcCwd, "coverage", "client")
     },
     sonarQubeUnitReporter: {
       sonarQubeVersion: "5.x",
       outputFile: "gunit.xml",
-      outputDir: Path.resolve("coverage", "client"),
+      outputDir: Path.resolve(xarcCwd, "coverage", "client"),
       useBrowserName: false
     },
     captureTimeout: 100000,

packages/xarc-app-dev/src/config/load-dev.ts

@@ -7,13 +7,16 @@ export {};
 
 const Path = require("path");
 const optionalRequire = require("optional-require")(require);
+import { loadXarcOptions } from "../lib/utils";
 
 function checkTopDevArchetype(devArchName) {
-  const topPkg = optionalRequire(Path.resolve("package.json"));
+  const xarcOptions = loadXarcOptions();
+  const xarcCwd = xarcOptions.cwd;
+  const topPkg = optionalRequire(Path.resolve(xarcCwd, "package.json"));
   if (topPkg && topPkg.name === devArchName) {
     // In case @xarc/app is being used for test/dev in the -dev archetype
     // resolve config/archetype in @xarc/app-dev's own dir
-    return optionalRequire(Path.resolve("config/archetype"));
+    return optionalRequire(Path.resolve(xarcCwd, "config/archetype"));
   } else {
     return optionalRequire(`${devArchName}/config/archetype`);
   }

packages/xarc-app-dev/src/config/opt2/xarc-options.ts

@@ -76,4 +76,10 @@ export type XarcOptions = {
    * options related to babel transpiler
    */
   babelOptions?: BabelOptions;
+
+  /**
+   * option for app directory if passed to loadXarcDevTasks using xclap.ts
+   * e.g: loadXarcDevTasks(null, { cwd: "/actual-dir-of-app" });
+   */
+  cwd?: string;
 };

packages/xarc-app-dev/src/lib/app-dev-middleware.ts

@@ -12,6 +12,8 @@ import {
   WEBPACK_EVENT_STATS
 } from "./dev-admin/webpack-dev-relay";
 
+import { loadXarcOptions } from "./utils";
+
 class AppDevMiddleware {
   webpackDev: any;
 
@@ -43,7 +45,9 @@ class AppDevMiddleware {
     if (!_.isEmpty(data.refreshModules)) {
       data.refreshModules.forEach(m => {
         try {
-          const moduleFullPath = require.resolve(Path.resolve(m));
+          const xarcOptions = loadXarcOptions();
+          const xarcCwd = xarcOptions.cwd;
+          const moduleFullPath = require.resolve(Path.resolve(xarcCwd, m));
           delete require.cache[moduleFullPath];
         } catch (err) {
           //

packages/xarc-app-dev/src/lib/babel-run.ts

@@ -20,14 +20,14 @@ import { loadXarcOptions } from "../lib/utils";
 const serverDir = process.argv[2] || "src/server";
 
 let start;
-
+const xarcOptions = loadXarcOptions();
+const xarcCwd = xarcOptions.cwd;
 try {
   // Try to load user's dev.js under src/server
-  start = require(Path.resolve(serverDir, "dev.js"));
+  start = require(Path.resolve(xarcCwd, serverDir, "dev.js"));
 } catch (e) {
-  const xarcOptions = loadXarcOptions();
-  const cwdNM = Path.resolve("node_modules");
-  const cwd = process.cwd();
+  const cwdNM = Path.resolve(xarcCwd, "node_modules");
+  const cwd = xarcCwd;
 
   // fallback to default action that loads babel-register and then requires
   // src/server, under which there should be an index.js file.
@@ -44,7 +44,7 @@ try {
     cache: true
   });
 
-  const fullServerDir = Path.resolve(serverDir);
+  const fullServerDir = Path.resolve(xarcCwd, serverDir);
 
   start = require(fullServerDir);
 }