fix: Fix a bug in the projects with installed dependencies

CocaColf · CocaColf · commit 298c583fa7c0 · 2022-04-25T15:49:52.000+08:00
diff --git a/.eslintrc b/.eslintrc
@@ -12,6 +12,8 @@
     "rules": {
         "no-explicit-any": 0,
         "no-non-null-assertion": 0,
-        "no-useless-escape": 0
+        "no-useless-escape": 0,
+        "@typescript-eslint/no-var-requires": 0,
+        "no-empty": 0
     }
 }
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ You can also write configuration file named `.coderflyrc`, mainly to simplify al
     // ...
 }
 ```
+> The results are written to the impact_report.json file in the directory where the command was executed
 
 ![command line](./docs/pics/command_line.png)
 
@@ -116,10 +117,19 @@ interface ImpactReason {
 }
 ```
 
+### matchVueVersion
+
+Since the use of `vue-template-compiler` must be consistent with the `vue` version, otherwise an error will be reported, you must keep them both consistent before using `coderfly`. You can either manually install the corresponding version of `vue-template-compiler` in your project yourself, or you can use the API to do this in your code. Note that this operation needs to be called before using the other APIs.
+
 ## Example
 
 ```js
-import { diff, getAllFiles, getFuncTree, getImpacts } from "coderfly";
+// if necessary
+const { matchVueVersion } = require('coderfly/dist/match_version');
+
+matchVueVersion();
+
+const { diff, getAllFiles, getFuncTree, getImpacts } = require('coderfly');
 
 // diff
 const functionDiffInfo = diff();
diff --git a/bin/coderfly.js b/bin/coderfly.js
@@ -1,17 +1,13 @@
 #!/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 fs = require('fs');
+const path = require('path');
+const { program }  = require('commander');
+const ora = require('ora');
+const { diff, getAllFiles, getFuncTree, getImpacts } = require('../dist/index.js');
 const pkg = require('../package.json');
+const { CONFIG_FILENAME, TREE_FILE, REPORT_FILE } = require('../dist/const.js');
+const { parseAliasFromConfig, lookFileOrFolderUp } = require('../dist/utils/handle_config');
 
-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();
 
 program
@@ -108,41 +104,4 @@ function parseAliasFromOptions (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
@@ -50,6 +50,8 @@
 }
 ```
 
+> 分析结果会写入在执行命令的目录下的 impact_report.json 文件中
+
 ![command line](./pics/command_line.png)
 
 **使用 API**
@@ -115,10 +117,20 @@ interface ImpactReason {
 }
 ```
 
+### matchVueVersion
+
+由于 `vue-template-compiler` 的使用必须保持和 `vue` 版本一致，否则会报错，因此在使用 `coderfly` 前必须将二者保持一致。你可以自己手动在项目中安装对应的 `vue-template-compiler` 版本，也可以使用该 API 在代码中完成此操作。注意此操作需要在使用其他 API 之前调用
+
+
 ## 示例
 
 ```js
-import { diff, getAllFiles, getFuncTree, getImpacts } from "coderfly";
+// 如果有必要
+const { matchVueVersion } = require('coderfly/dist/match_version');
+
+matchVueVersion();
+
+const { diff, getAllFiles, getFuncTree, getImpacts } = require('coderfly');
 
 // diff
 const functionDiffInfo = diff();
diff --git a/package.json b/package.json
@@ -1,10 +1,9 @@
 {
   "name": "coderfly",
   "description": "Find function-level association impacts of code changes",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "CocaColf <cocacolf@gmail.com>",
   "main": "dist/index.js",
-  "type": "module",
   "bin": {
     "coderfly": "bin/coderfly.js"
   },
@@ -35,11 +34,10 @@
     "@types/lodash-es": "^4.17.6",
     "commander": "^9.1.0",
     "enhanced-resolve": "^5.9.2",
-    "execa": "^6.1.0",
+    "execa": "5.1.1",
     "lodash-es": "^4.17.21",
     "n-readlines": "^1.0.1",
-    "ora": "^6.1.0",
-    "parse-git-diff": "^0.0.6",
+    "ora": "5.4.1",
     "recast": "^0.20.5",
     "vue-template-compiler": "^2.6.14"
   }
diff --git a/src/const.ts b/src/const.ts
@@ -1,7 +1,13 @@
+import path from "path";
+
 export const ALLOW_EXT = ['.vue', '.js', '.ts'];
 export const UN_KNOWN = 'unknown';
 export const IS_TOP_SCOPE = '[is_top_scope]';
 
 export const MUSTACHE_TAG_REG  = /\{\{((?:.|\n)+?)\}\}/g;
 
 export const TEXT_NODE_TYPES = [2, 3];
+
+export const CONFIG_FILENAME = '.coderflyrc';
+export const TREE_FILE = path.resolve(process.cwd(), './file_tree.json');
+export const REPORT_FILE = path.resolve(process.cwd(), './impact_report.json');
diff --git a/src/match_version.ts b/src/match_version.ts
@@ -0,0 +1,30 @@
+import { commandSync } from "execa";
+import path from "path";
+import { lookFileOrFolderUp } from "./utils/handle_config.js";
+
+export function matchVueVersion () {
+    let vueVersion = 'latest';
+    let vueTemplateCompilerVersion = '';
+
+    try {
+        vueVersion = require('vue').version;
+        const vtcDir = require.resolve('vue-template-compiler');
+        if (vtcDir) {
+            vueTemplateCompilerVersion = require(`${path.dirname(vtcDir)}/package.json`).version;
+        }
+    } catch (e) {}
+
+    if (vueVersion && vueTemplateCompilerVersion && vueTemplateCompilerVersion === vueVersion) {
+        return;
+    }
+
+    // use yarn or npm
+    const yarnLockDir = lookFileOrFolderUp('yarn.lock', process.cwd());
+    if (yarnLockDir) {
+        try { commandSync('yarn remove vue-template-compiler') } catch {}
+        commandSync(`yarn add vue-template-compiler@${vueVersion}`);
+    } else {
+        try { commandSync('npm uninstall vue-template-compiler') } catch {}
+        commandSync(`npm install vue-template-compiler@${vueVersion}`);
+    }
+}
diff --git a/src/utils/function_change/diff.ts b/src/utils/function_change/diff.ts
@@ -1,9 +1,8 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import { execaCommandSync } from 'execa';
+import { commandSync } from 'execa';
 import lineByLine from 'n-readlines';
 import { parse, visit } from 'recast';
-import { createRequire } from 'module';
 import { parseComponent } from 'vue-template-compiler';
 import { DiffFunctionInfo, FunctionInfo } from '../../type';
 
@@ -23,7 +22,7 @@ export function getFunctionDiffInfo (filePath: string, commitSha?: string) {
         // treat it as a new file
         functionInfoBefore = {};
     } else {
-        const beforeCtx = execaCommandSync(`git cat-file blob ${blobId}`).stdout;
+        const beforeCtx = commandSync(`git cat-file blob ${blobId}`).stdout;
         const tempFile = `./temp_${path.posix.basename(filePath)}`;
         fs.writeFileSync(tempFile, beforeCtx);
         functionInfoBefore = getFunctionBlock(tempFile);
@@ -70,7 +69,6 @@ function getFunctionBlock (filePath: string) {
     }
 
     try {
-        const require = createRequire(import.meta.url);
         ast = parse(code, {
             parser: require('recast/parsers/babel'),
         });
@@ -214,7 +212,7 @@ function getFileCtxBeforeChange (filePath: string, commitSha?: string) {
         commitSha = latestCommitSha();
     }
 
-    const gitBlobs = execaCommandSync(`git ls-tree -r ${commitSha}`).stdout;
+    const gitBlobs = commandSync(`git ls-tree -r ${commitSha}`).stdout;
     const blobArr = gitBlobs.split('\n');
 
     for (const blobItem of blobArr) {
@@ -226,5 +224,5 @@ function getFileCtxBeforeChange (filePath: string, commitSha?: string) {
 }
 
 function latestCommitSha () {
-    return execaCommandSync('git rev-parse HEAD').stdout;
+    return commandSync('git rev-parse HEAD').stdout;
 }
diff --git a/src/utils/function_change/file_change.ts b/src/utils/function_change/file_change.ts
@@ -1,11 +1,11 @@
-import { execaCommandSync } from 'execa';
+import { commandSync } from 'execa';
 import { FileChange } from '../../type';
 
 const COMMANDS = ['git diff --name-status', 'git diff --name-status --staged'];
 
 const formatList = (str: string, type: string) => {
     const arr = str.split('\n').filter(item => {
-        const regex = new RegExp(`[${type}].*`)
+        const regex = new RegExp(`[${type}].*`);
         if (regex.test(item)) {
           return item !== undefined;
         }
@@ -23,7 +23,7 @@ export function getFileChange () {
     const typeList = ['M', 'D', 'A'];
     
     for (const command of COMMANDS) {
-      const changeInfo = execaCommandSync(command).stdout;
+      const changeInfo = commandSync(command).stdout;
 
       typeList.forEach(type => {
         const formatResult = formatList(changeInfo, type);
diff --git a/src/utils/function_change/index.ts b/src/utils/function_change/index.ts
@@ -1,3 +1,5 @@
+import path from "path";
+import { ALLOW_EXT } from "../../const.js";
 import { DiffInfo } from "../../type";
 import { getFunctionDiffInfo } from "./diff.js";
 import { getFileChange } from "./file_change.js";
@@ -11,6 +13,8 @@ export function diff () {
         const files = changedList[changeType];
 
         for (const file of files) {
+            if (!ALLOW_EXT.includes(path.extname(file))) continue;
+
             result.push({
                 file,
                 ...getFunctionDiffInfo(file)
diff --git a/src/utils/handle_config.ts b/src/utils/handle_config.ts
@@ -0,0 +1,39 @@
+import path from 'path';
+import fs from 'fs';
+import { NameAndPath } from '../type';
+
+export function lookFileOrFolderUp (target: string, baseDir: string) {
+    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 '';
+}
+
+export function parseAliasFromConfig (config: NameAndPath) {
+    Object.keys(config).forEach(alias => {
+        config[alias] = path.resolve(process.cwd(), config[alias]);
+    });
+
+    return config;
+}
diff --git a/src/utils/handle_file_utils.ts b/src/utils/handle_file_utils.ts
@@ -1,6 +1,5 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import { createRequire } from 'module';
 import { parse, visit } from 'recast';
 import { parseComponent, compile } from 'vue-template-compiler';
 import lineByLine from 'n-readlines';
@@ -16,7 +15,6 @@ import {
 } from '../type';
 import { getTemplateInfo } from './parse_template_ast.js';
 
-const require = createRequire(import.meta.url);
 const { create } = require('enhanced-resolve');
 
 function getAllFiles (folderPath: string): string[] {
diff --git a/tsconfig.json b/tsconfig.json
@@ -3,7 +3,7 @@
         "outDir": "./dist",
         "declaration": false,
         "target": "es6",
-        "module": "EsNext",
+        "module": "commonjs",
         "noImplicitAny": true,
         "moduleResolution": "node",
         "strict": true,
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`	`"rules": {`
`13`	`13`	`"no-explicit-any": 0,`
`14`	`14`	`"no-non-null-assertion": 0,`
`15`		`- "no-useless-escape": 0`
	`15`	`+ "no-useless-escape": 0,`
	`16`	`+ "@typescript-eslint/no-var-requires": 0,`
	`17`	`+ "no-empty": 0`
`16`	`18`	`}`
`17`	`19`	`}`