feat(command line): Support command line usage

CocaColf · CocaColf · commit 3c96427ec884 · 2022-04-15T15:54:22.000+08:00
diff --git a/README.md b/README.md
@@ -30,16 +30,21 @@ This project is still under development and has not been published to the npm ye
 
 ## Usage
 
-**Using the API**
+**Using the command line**
 
-see the [API](#api) or [Example](#example).
+`coderfly check <folder path>`
 
-**Using the command line**
+Options:
 
-> Not yet finished
+- alias: Set path alias, alias and path should be linked with a **colon**. eg: `coderfly check ./src -alias src:./src static:./public`
 
-- [ ] Using command line: `cci check <folder path>`
+- t or tree: Export the file tree to a file, the file defaults to `file_tree.json`. eg: `coderfly check ./src -t`
 
+![command line](./docs/pics/command_line.png)
+
+**Using the API**
+
+see the [API](#api) or [Example](#example).
 ## API
 
 ### diff
diff --git a/bin/coderfly.js b/bin/coderfly.js
@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import { program } from 'commander';
+import { createRequire } from "module";
+import ora from 'ora';
+import { diff, getAllFiles, getFuncTree, getImpacts } from '../dist/index.js';
+const require = createRequire(import.meta.url);
+const pkg = require('../package.json');
+
+const TREE_FILE = path.resolve(process.cwd(), './file_tree.json');
+const REPORT_FILE = path.resolve(process.cwd(), './impact_report.json');
+const newsBoy = ora();
+
+program
+    .version(pkg.version)
+    .usage('<command>')
+    .description('Find function-level association impacts of code changes');
+
+program
+    .command('check <srcPath>')
+    .option('-alias, --alias <alias:path...>', 'set path alias')
+    .option('-t, --tree', 'export the file tree to a file')
+    .description('check association impacts of code changes')
+    .action((srcPath, options) => {
+        let alias = {};
+
+        if (options.alias) {
+            alias = parseAlias(options.alias);
+        }
+
+        const functionDiffInfo = diff();
+        newsBoy.succeed(' Function diff completed ');
+
+        const files = getAllFiles(path.resolve(process.cwd(), srcPath));
+
+        const tree = getFuncTree(files, {
+            alias
+        });
+        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}`);
+        }
+
+        let allFunctions = [];
+        functionDiffInfo.forEach(item => {
+            const file = path.resolve(process.cwd(), item.file);
+
+            item.total.forEach(fn => {
+                allFunctions.push({
+                    filePath: file,
+                    name: fn,
+                    paths: [[fn, file]]
+                });
+            });
+        });
+
+        let impactReport = [];
+
+        allFunctions.forEach(item => {
+            let impact = getImpacts(tree, item);
+            impactReport.push(impact);
+        });
+        newsBoy.succeed(' Association analysis completed ');
+        
+        fs.writeFileSync(REPORT_FILE, JSON.stringify(impactReport, null, 4));
+
+        newsBoy.info(`Job done! You can check the result from ${REPORT_FILE}`);
+    });
+
+program.parse(process.argv);
+
+function parseAlias (alias) {
+    let result = {};
+    if (typeof alias === 'string') {
+        alias = [alias];
+    }
+
+    for (let item of alias) {
+        if (!/\S+:\S+/g.test(item)) {
+            continue;
+        }
+
+        const splitRes = item.split(':');
+
+        // because it's key:value, so compare with 2
+        if (splitRes.length !== 2) {
+            continue;
+        }
+
+        result[splitRes[0]] = path.resolve(process.cwd(), splitRes[1]);
+    }
+
+    return result;
+}
+
diff --git a/docs/README_CN.md b/docs/README_CN.md
@@ -28,15 +28,21 @@
 
 ## 使用
 
-**使用 API**
+**使用命令行**
 
-可以参考 [API](#api) 或者[示例代码](#示例)
+`coderfly check <folder path>`
 
-**使用命令行**
+参数:
+
+- `alias`: 设置路径别名, 别名和路径要以 **:** 连接。示例： `coderfly check ./src -alias src:./src static:./public`
 
-> 当前还未实现
+- `t` 或者 `tree`: 将文件树以文件形式输出，默认为 `file_tree.json`。 示例： `coderfly check ./src -t`
 
-- [ ] 使用命令行 `cci check <folder path>`
+![command line](./pics/command_line.png)
+
+**使用 API**
+
+可以参考 [API](#api) 或者[示例代码](#示例)
 
 ## API 
 
diff --git a/docs/pics/command_line.png b/docs/pics/command_line.png
diff --git a/package.json b/package.json
@@ -4,6 +4,13 @@
   "main": "index.js",
   "license": "MIT",
   "type": "module",
+  "bin": {
+    "coderfly": "bin/coderfly.js"
+  },
+  "files": [
+    "bin",
+    "dist"
+  ],
   "scripts": {
     "build": "rm -rf dist/ && tsc && find ./dist -type f|xargs dos2unix",
     "lint": "eslint . --ext .ts",
@@ -20,10 +27,12 @@
   "dependencies": {
     "@babel/parser": "^7.17.8",
     "@types/lodash-es": "^4.17.6",
+    "commander": "^9.1.0",
     "enhanced-resolve": "^5.9.2",
     "execa": "^6.1.0",
     "lodash-es": "^4.17.21",
     "n-readlines": "^1.0.1",
+    "ora": "^6.1.0",
     "parse-git-diff": "^0.0.6",
     "recast": "^0.20.5",
     "vue-template-compiler": "^2.6.14"
diff --git a/yarn.lock b/yarn.lock
