feat: apply one-step process api

Author: CocaColf

README.md

@@ -61,6 +61,13 @@ module.exports = {
 see the [API](#api) or [Example](#example).
 ## API
 
+### coderfly
+
+The API for the complete process is included, use this for a one-step process if you don't need control the process yourself.
+
+**Params**
+
+- srcPath: string. It's source code folder path
 ### diff
 
 Get the changes of the function by the changes of the file.
@@ -124,6 +131,21 @@ Since the use of `vue-template-compiler` must be consistent with the `vue` versi
 
 ## Example
 
+**Easy to use**
+
+```js
+// if necessary
+const { matchVueVersion } = require('coderfly/dist/match_version');
+
+matchVueVersion();
+
+const { coderfly } = require('coderfly');
+
+coderfly('./src');
+```
+
+
+**If you want you control the process yourself**
 ```js
 // if necessary
 const { matchVueVersion } = require('coderfly/dist/match_version');

docs/README_CN.md

@@ -61,6 +61,17 @@ module.exports = {
 
 ## API 
 
+### coderfly
+
+API集大成者，如果不需要自己字定义过程，用这个一步到位即可.
+
+**Params**
+
+- srcPath: string. It's source code folder path
+
+**Params**
+
+- srcPath: string，源码文件夹路径
 ### diff
 
 根据本地文件变动，输出函数修改情况。

src/const.ts

@@ -9,6 +9,8 @@ export const MUSTACHE_TAG_REG  = /\{\{((?:.|\n)+?)\}\}/g;
 
 export const TEXT_NODE_TYPES = [2, 3];
 
+export const CODERFLY_FOLDER = path.resolve(process.cwd(), '.coderfly');
 export const CONFIG_FILENAME = '.coderflyrc.js';
-export const TREE_FILE = path.resolve(process.cwd(), './file_tree.json');
-export const REPORT_FILE = path.resolve(process.cwd(), './impact_report.json');
+export const MATCHED_VUE = path.resolve(CODERFLY_FOLDER, 'matched_vue');
+export const TREE_FILE = path.resolve(CODERFLY_FOLDER, 'file_tree.json');
+export const REPORT_FILE = path.resolve(CODERFLY_FOLDER, 'impact_report.json');

src/index.ts

@@ -1,7 +1,59 @@
+import path from 'path';
+import fs from 'fs';
 import { diff } from './utils/function_change/index.js';
-import { getAllFiles, getFuncTree } from './utils/handle_file_utils.js';
+import { confirmFolderExist, getAllFiles, getFuncTree } from './utils/handle_file_utils.js';
 import { getImpacts, findWhoCallMe } from './impact.js';
 import { getTemplateInfo } from './utils/parse_template_ast.js';
+import { CONFIG_FILENAME, REPORT_FILE } from './const.js';
+import { lookFileOrFolderUp } from './utils/handle_config.js';
+import { ImpactReason } from './type.js';
+
+async function coderfly (srcPath: string) {
+    let alias = {};
+    const configFolder = lookFileOrFolderUp(CONFIG_FILENAME, path.resolve(process.cwd(), srcPath));
+
+    if (configFolder) {
+        const configFile = path.resolve(configFolder, CONFIG_FILENAME);
+
+        try {
+            alias = require(configFile);
+        } catch (error){
+            // do nothing
+        }
+    }
+
+    confirmFolderExist();
+
+    const functionDiffInfo = diff();
+
+    const files = getAllFiles(path.resolve(process.cwd(), srcPath));
+
+    const tree = getFuncTree(files, {
+        alias
+    });
+
+    const allFunctions: ImpactReason[] = [];
+    functionDiffInfo.forEach(item => {
+        const file = path.resolve(process.cwd(), item.file);
+
+        item.total.forEach(fn => {
+            allFunctions.push({
+                filePath: file,
+                name: fn,
+                paths: [[fn, file]]
+            });
+        });
+    });
+
+    const impactReport: any[] = [];
+
+    allFunctions.forEach(item => {
+        const impact = getImpacts(tree, item);
+        impactReport.push(impact);
+    });
+
+    fs.writeFileSync(REPORT_FILE, JSON.stringify(impactReport, null, 4));
+}
 
 export {
     getAllFiles,
@@ -10,4 +62,5 @@ export {
     getImpacts,
     findWhoCallMe,
     diff,
+    coderfly,
 };

src/utils/handle_file_utils.ts

@@ -4,7 +4,7 @@ import { visit } from 'recast';
 import { parse } from '@babel/parser';
 import { parseComponent, compile } from 'vue-template-compiler';
 import lineByLine from 'n-readlines';
-import { ALLOW_EXT, IS_TOP_SCOPE, TS_DECLARATION_EXT, UN_KNOWN } from '../const.js';
+import { ALLOW_EXT, CODERFLY_FOLDER, IS_TOP_SCOPE, TS_DECLARATION_EXT, UN_KNOWN } from '../const.js';
 import { 
     AllFuncsInfo, 
     FileAstInfo, 
@@ -462,11 +462,17 @@ function isAllowExt (filePath: string) {
     return ALLOW_EXT.includes(path.extname(filePath)) && filePath.indexOf(TS_DECLARATION_EXT) === -1;
 }
 
+function confirmFolderExist () {
+    if (!fs.existsSync(CODERFLY_FOLDER)) {
+        fs.mkdirSync(CODERFLY_FOLDER);
+    }
+}
 
 export {
     getFileInfo,
     getVueScriptRealStartLine,
     getFuncTree,
     getAllFiles,
     isAllowExt,
+    confirmFolderExist,
 };