feat: support fetch remote rc file (#230)

* chore(gitignore): ignore .vscode

* feat: fetch rc from remote file

* chore: modify package.json info

* refactor: combine file config & remote config

* test: test function getConfigFromRemote

* test: getRemoteUrl function

* style: add logger when getting gren config

Author: lianghx-319

.gitignore

@@ -8,3 +8,4 @@ coverage
 dist
 bin
 test/**.js.xml
+.vscode

lib/gren-init.js

@@ -38,7 +38,7 @@ init()
             return;
         }
 
-        const currentConfig = utils.getConfigFromFile(process.cwd());
+        const currentConfig = utils.getGrenConfig(process.cwd());
         const fileContent = utils.writeConfigToFile(fileType, ObjectAssignDeep({}, currentConfig, data));
 
         fs.writeFileSync(fileType, fileContent);

lib/src/Program.js

@@ -1,6 +1,6 @@
 import GitHubInfo from './GitHubInfo';
 import program from 'commander';
-import { getConfigFromFile } from './_utils.js';
+import { getGrenConfig } from './_utils.js';
 
 /** Class creating a Commander program, managing the options passed via bash and config file. */
 class Program {
@@ -18,7 +18,7 @@ class Program {
 
         this.options = Object.assign(
             {},
-            getConfigFromFile(props.cwd, program.config),
+            getGrenConfig(props.cwd, program.config),
             this._getOptionsFromObject(this.program, this.defaults)
         );
     }

lib/src/_init.js

@@ -226,7 +226,7 @@ const getQuestions = async() => {
                 value: 'merge',
                 name: 'Merge these settings over existing ones'
             }],
-            when: () => Object.keys(utils.getConfigFromFile(process.cwd())).length > 0
+            when: () => Object.keys(utils.getGrenConfig(process.cwd())).length > 0
         },
         {
             name: 'fileType',

lib/src/_utils.js

@@ -4,6 +4,7 @@ const ora = require('ora');
 const YAML = require('json2yaml');
 const Path = require('path');
 const { js_beautify: beautify } = require('js-beautify');
+const requireFromUrl = require('require-from-url/sync');
 require('require-yaml');
 
 /**
@@ -176,6 +177,8 @@ function requireConfig(filepath) {
         return false;
     }
 
+    process.stdout.write(chalk.cyan(`Getting gren config from local file ${filepath}\n`));
+
     if (getFileNameFromPath(filepath).match(/\./g).length === 1) {
         return JSON.parse(fs.readFileSync(filepath, 'utf8'));
     }
@@ -187,7 +190,7 @@ function requireConfig(filepath) {
  * Get configuration from the one of the config files
  *
  * @since 0.6.0
- * @public
+ * @private
  *
  * @param  {string} path Path where to look for config files
  * @return {Object} The configuration from the first found file or empty object
@@ -292,6 +295,71 @@ function cleanConfig(confirm, path = process.cwd()) {
     });
 }
 
+/**
+ * judge whether to get config from remote uri
+ * @since  0.18.0
+ * @private
+ *
+ * @param {string} path
+ *
+ * @returns {string}
+ */
+function getRemoteUrl(path) {
+    const pkgPath = Path.join(path, 'package.json');
+    const pkgExist = fs.existsSync(pkgPath);
+    const { gren = '' } = pkgExist ? require(pkgPath) : {};
+    return gren;
+}
+
+/**
+ * get config from remote
+ * @since 0.18.0
+ * @private
+ *
+ * @param  {string} path Path where to look for config files
+ * @return {Object} The configuration from the first found file or empty object
+*/
+function getConfigFromRemote(url) {
+    if (!url) return null;
+
+    process.stdout.write(chalk.cyan(`Fetching gren config from remote: ${url}\n`));
+
+    let config = null;
+    try {
+        config = requireFromUrl(url);
+    } catch (error) {
+        // console.error(error);
+        process.stdout.write(chalk.cyan(`Fetched remote config fail: ${url}\n`));
+        throw new Error(error);
+    }
+
+    process.stdout.write(chalk.cyan(`Fetched remote config succeed`));
+
+    return config;
+}
+
+/**
+ * combine getConfigFromRemote & getGrenConfig
+ * @since 0.18.0
+ * @public
+ *
+ * @param  {string} path Path where to look for config files
+ * @return {Object} The configuration from the first found file or empty object
+*/
+function getGrenConfig(path, ...args) {
+    const remoteUrl = getRemoteUrl(path);
+    let config;
+    if (remoteUrl) {
+        config = getConfigFromRemote(remoteUrl);
+    }
+
+    if (!config) {
+        config = getConfigFromFile(path, ...args);
+    }
+
+    return config;
+}
+
 /**
  * Just a noop function
  */
@@ -305,6 +373,9 @@ module.exports = {
     dashToCamelCase,
     formatDate,
     getConfigFromFile,
+    getRemoteUrl,
+    getConfigFromRemote,
+    getGrenConfig,
     getFileExtension,
     getFileNameFromPath,
     getFileTypes,