feat: new switch v2 function

config/env/v2-development.js

@@ -0,0 +1,18 @@
+/**
+ * @fileOverview This is a variation of a SailsJS local.js file that uses env-lift to provide configuration overrides
+ * from environment variables.
+ */
+module.exports = require('../../index').switchV2(__filename, {
+  port: 1337,
+
+  environment: 'development',
+
+  models: {
+    connection: 'mySQL',
+    migrate: 'safe'
+  },
+
+  log: {
+    level: 'info'
+  }
+});

config/env/v2-internal.js

@@ -0,0 +1,17 @@
+/**
+ * @fileOverview This is a variation of a SailsJS local.js file that uses env-lift to provide configuration overrides
+ * from environment variables.
+ */
+module.exports = require('../../index').switchV2(__filename, {
+  port: 6060,
+
+  environment: 'v2-internal',
+
+  log: {
+    level: 'silly'
+  },
+
+  foo: {
+    bar: 'v2-dummy'
+  }
+});

index.js

@@ -1,4 +1,4 @@
-var path = require('path');
+const path = require('path');
 
 module.exports = {
   /**
@@ -42,7 +42,7 @@ module.exports = {
     }
 
     // Get the file name from which config will be loaded.
-    var targetFile = require.resolve(path.join(process.cwd(), 'config', 'env', process.env.SAILS_ENV));
+    const targetFile = require.resolve(path.join(process.cwd(), 'config', 'env', process.env.SAILS_ENV));
 
     // if the parent file name from which this module is called is same as the targetFile name then no need
     // to require the targetFile as we are already at the target File and we need that file's config.
@@ -57,6 +57,45 @@ module.exports = {
     // called and that is dynamic, so we need to make sure we are requiring the correct parent file everytime.
     delete require.cache[__filename];
 
+    // Finally return the target file's config.
+    return require(targetFile);
+  },
+
+  /**
+   * `delete require.cache()` might not work properly if there is any hook applied to require module, eg: require-in-the-middle
+   * switchV2() will expect parentFilename as an parameter and use that to compare with the targetFile.
+   *
+   * It will pick the env config based on the SAILS_ENV value. If a project has SAILS_ENV
+   * defined to some value then it expects that same file in the env/config file so that it
+   * will pick the config value from that file.
+   *
+   * @param env this is the current sails environment in which this module is used.
+   * @param parentFilename this is the filename of the module which is calling switchV2.
+   * @param defaultConfig this is the default config which is bases on NODE_ENV value
+   * @returns {config}
+   *
+   * @example
+   * // This is the env config file
+   * module.exports = require('sails-env-switch').switchV2(__filename, {
+   *    port: 8080,
+   *    name: 'Sample'
+   * });
+   */
+  switchV2: function (parentFilename, defaultConfig) {
+    // If SAILS_ENV is not defined, return the default config
+    if (!process.env.SAILS_ENV) {
+        return defaultConfig;
+    }
+
+    // Get the file name from which config will be loaded.
+    const targetFile = require.resolve(path.join(process.cwd(), 'config', 'env', process.env.SAILS_ENV));
+
+    // if the parent file name is same as the targetFile name then no need
+    // to require the targetFile as we are already at the target File and we need that file's config.
+    if (path.relative(targetFile, parentFilename) === '') {
+      return defaultConfig;
+    }
+
     // Finally return the target file's config.
     return require(targetFile);
   }