Merge pull request #2 from CocaColf/feat/support_config_file

CocaColf · web-flow · commit 2838291657fd · 2022-04-18T16:52:53.000+08:00
feat(command): support custom config file for run command
diff --git a/README.md b/README.md
@@ -40,6 +40,18 @@ Options:
 
 - `t` or `tree`: Export the file tree to a file, the file defaults to `file_tree.json`. eg: `coderfly check ./src -t`
 
+Configuration file:
+
+You can also write configuration file named `.coderflyrc`, mainly to simplify alias. Note: **It must be written in json form**.
+
+```js
+// .coderflyrc
+{
+    "src": "./test",
+    // ...
+}
+```
+
 ![command line](./docs/pics/command_line.png)
 
 **Using the API**
diff --git a/bin/coderfly.js b/bin/coderfly.js
@@ -9,6 +9,7 @@ import { diff, getAllFiles, getFuncTree, getImpacts } from '../dist/index.js';
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
 
+const CONFIG_FILENAME = '.coderflyrc';
 const TREE_FILE = path.resolve(process.cwd(), './file_tree.json');
 const REPORT_FILE = path.resolve(process.cwd(), './impact_report.json');
 const newsBoy = ora();
@@ -27,11 +28,24 @@ program
         let alias = {};
 
         if (options.alias) {
-            alias = parseAlias(options.alias);
+            alias = parseAliasFromOptions(options.alias);
+        } else {
+            const configFolder = lookFileOrFolderUp(CONFIG_FILENAME, path.resolve(process.cwd(), srcPath));
+
+            if (configFolder) {
+                let configFile = path.resolve(configFolder, CONFIG_FILENAME);
+
+                try {
+                    let config = JSON.parse(fs.readFileSync(configFile));
+                    alias = parseAliasFromConfig(config);
+                } catch (error){
+                    // do nothing
+                }
+            }
         }
 
         const functionDiffInfo = diff();
-        newsBoy.succeed(' Function diff completed ');
+        newsBoy.succeed(' Function diff completed ');     
 
         const files = getAllFiles(path.resolve(process.cwd(), srcPath));
 
@@ -41,7 +55,7 @@ program
         newsBoy.succeed(' File tree build completed ');
         if (options.tree) {
             fs.writeFileSync(TREE_FILE, JSON.stringify(tree, null, 4));
-            newsBoy.info(`You can check file tree from ${TREE_FILE}`);
+            newsBoy.info(` You can check file tree from ${TREE_FILE} `);
         }
 
         let allFunctions = [];
@@ -67,12 +81,12 @@ program
         
         fs.writeFileSync(REPORT_FILE, JSON.stringify(impactReport, null, 4));
 
-        newsBoy.info(`Job done! You can check the result from ${REPORT_FILE}`);
+        newsBoy.info(` Job done! You can check the result from ${REPORT_FILE} `);
     });
 
 program.parse(process.argv);
 
-function parseAlias (alias) {
+function parseAliasFromOptions (alias) {
     let result = {};
     if (typeof alias === 'string') {
         alias = [alias];
@@ -96,3 +110,39 @@ function parseAlias (alias) {
     return result;
 }
 
+function parseAliasFromConfig (config) {
+    Object.keys(config).forEach(alias => {
+        config[alias] = path.resolve(process.cwd(), config[alias]);
+    });
+
+    return config;
+}
+
+function lookFileOrFolderUp (target, baseDir) {
+    const cwd = process.cwd();
+    let oldPath = '';
+    let newPath;
+
+    if (baseDir) {
+        if (path.isAbsolute(baseDir)) {
+            newPath = baseDir;
+        } else {
+            newPath = path.resolve(cwd, baseDir);
+        }
+    } else {
+        newPath = cwd;
+    }
+
+    while (oldPath !== newPath) {
+        oldPath = newPath;
+        const files = fs.readdirSync(newPath);
+        for (const file of files) {
+            if (file === target) {
+                return newPath;
+            }
+        }
+        newPath = path.dirname(oldPath);
+    }
+    return '';
+};
+
diff --git a/docs/README_CN.md b/docs/README_CN.md
@@ -38,6 +38,18 @@
 
 - `t` 或者 `tree`: 将文件树以文件形式输出，默认为 `file_tree.json`。 示例： `coderfly check ./src -t`
 
+配置文件：
+
+你也可以编写 `.coderflyrc` 配置文件，这样更方便 alias 的书写。注意：**这个文件要编写为 json 形式**。
+
+```js
+// .coderflyrc
+{
+    "src": "./test",
+    // ...
+}
+```
+
 ![command line](./pics/command_line.png)
 
 **使用 API**
