架构设计 & 分析范式

......
const { parseTs } = require(path.join(__dirname, './parse'));  // 解析模块
......

class CodeAnalysis {
  constructor(options) {
    ......
    // 私有属性
    this._scanSource = options.scanSource;                     // 扫描源配置信息
    this._analysisTarget = options.analysisTarget;             // 要分析的目标依赖配置
    this._blackList = options.blackList || [];                 // 需要标记的黑名单API配置
    this._scorePlugin = options.scorePlugin || null;           // 代码评分插件配置
    this._analysisPlugins = options.analysisPlugins || [];     // 代码分析插件配置
    // 公共属性
    this.pluginsQueue = [];                                    // Targer分析插件队列
    this.browserQueue = [];                                    // Browser分析插件队列
    this.importItemMap = {};                                   // importItem统计Map
    // this.apiMap = {};                                       // 未分类API统计Map（插件挂载）
    // this.typeMap = {};                                      // 类型API统计Map（插件挂载）
    // this.methodMap = {};                                    // 方法API统计Map（插件挂载）
    // this.browserMap = {};                                   // BrowserAPI统计Map（插件挂载）
    this.parseErrorInfos = [];                                 // 解析异常信息数组
    this.diagnosisInfos = [];                                  // 诊断日志信息数组
    this.scoreMap = {};                                        // 代码评分及建议Map
    ......
  }
  // API黑名单标记
  _blackTag() {
    ......
  }
  // 注册插件
  _installPlugins() {
    ......
  }
  // 链式调用检查，找出链路顶点node
  _checkPropertyAccess() {
    ......
  }
  // 执行分析插件队列中的checkFun函数
  _runAnalysisPlugins() {
    ......
  }
  // 执行分析插件队列中的afterHook函数
  _runAnalysisPluginsHook() {
    ......
  }
  // 分析import节点
  _findImportItems(ast, ...) {
    let importItems = {};
    // 处理imports相关map
    function dealImports(){
      // 处理importItems
    }
    // 遍历AST寻找import节点
    function walk(node) {
      ......
      tsCompiler.forEachChild(node, walk);
      // 分析引入情况
      dealImports();
      ......
    }
    walk(ast);
    // 返回 API 导入情况
    return importItems;
  }
  // API调用分析
  _dealAST(importItems, ast, ...) {
    ......
    const that = this;
    // 遍历AST
    function walk(node) {
        ......
        tsCompiler.forEachChild(node, walk);
        // 获取基础分析节点信息
        const { baseNode, depth, apiName } = that._checkPropertyAccess();
        // 执行分析插件
        that._runAnalysisPlugins();
        ......
    }
    walk(ast);
    // AST遍历结束，执行afterhook
    this._runAnalysisPluginsHook();
    ......
  }
  // 扫描代码文件
  _scanFiles() {
    let entrys = [];
    ......
    return entrys;
  }
  // 扫描代码文件 & 分析代码
  _scanCode() {
    ......
    const entrys = this._scanFiles();  // 扫描所有需要分析的代码文件
    // 遍历每个文件，依次（解析AST，分析import，分析API调用）
    entrys.forEach(()=>{
      ......
      const { ast, ...} = parseTs(...)                      // 将TS代码文件解析为 AST
      const importItems = this._findImportItems(ast, ...)   // 遍历 AST 分析 import 节点
      if(Object.keys(importItems).length >0){
          this._dealAST(importItems, ast, ...)              // 遍历 AST 分析 API 调用
      }
      ......
    })
    ......
  }
  // 记录诊断日志
  addDiagnosisInfo() {
    ......
  }
  // 入口函数
  analysis() {
    ......
    // 注册插件
    this._installPlugins();
    // 扫描分析代码
    this._scanCode();
    // 黑名单标记
    this._blackTag();
    // 代码评分
    this._scorePlugin();
    ......
  }
}

const { execSync } = require('child_process');                        // 子进程操作
const DefaultBranch = 'master';                                       // 默认分支常量
function getGitBranch() {                                             // 获取当前分支
    try{
        const branchName = execSync('git symbolic-ref --short -q HEAD', {
            encoding: 'utf8'
        }).trim();
        // console.log(branchName);
        return branchName;
    }catch(e){
        return DefaultBranch;
    }
}

module.exports = {
    scanSource: [{                                                    // 必须，待扫描源码的配置信息
        name: 'Market',                                                    // 必填，项目名称
        path: ['src'],                                                     // 必填，需要扫描的文件路径（基准路径为配置文件所在路径）
        packageFile: 'package.json',                                       // 可选，package.json 文件路径配置，用于收集依赖的版本信息
        format: null,                                                      // 可选, 文件路径格式化函数,默认为null,一般不需要配置
        httpRepo: `https://gitlab.xxx.com/xxx/-/blob/${getGitBranch()}/`   // 可选，项目gitlab/github url的访问前缀，用于点击行信息跳转，不填则不跳转
    }],
    analysisTarget: 'framework',                                      // 必须，要分析的目标依赖名
    analysisPlugins: [],                                              // 可选，自定义分析插件，默认为空数组，一般不需要配置
    blackList: ['app.localStorage.set'],                              // 可选，需要标记的黑名单api，默认为空数组
    browserApis: ['window','document','history','location'],          // 可选，要分析的BrowserApi，默认为空数组
    reportDir: 'report',                                              // 可选，生成代码分析报告的目录，默认为'report',不支持多级目录配置
    reportTitle: 'Market依赖调用分析报告',                              // 可选，分析报告标题，默认为'依赖调用分析报告'
    isScanVue: true,                                                  // 可选，是否要扫描分析vue中的ts代码，默认为false
    scorePlugin: 'default',                                           // 可选，评分插件: Function|'default'|null, default表示运行默认插件，默认为null表示不评分
    alarmThreshold: 90                                                // 可选，开启代码告警的阈值分数(0-100)，默认为null表示关闭告警逻辑 (CLI模式生效)
}