CodeAsk 开源项目入门指南

项目概览：理解核心架构

CodeAsk 是一款基于大语言模型（LLM）的代码阅读工具，旨在帮助开发者快速理解复杂代码库、检测安全漏洞并生成结构化分析报告。项目采用现代化前端框架构建，通过直观的界面提供代码可视化和智能分析功能。

核心目录解析

以下是按开发频率从高到低排序的核心目录结构：

1. src/components/ - 包含所有UI组件，是日常开发中修改最频繁的目录
2. src/store/ - 状态管理中心，处理应用数据流转
3. src/pages/ - 页面组件，定义应用路由对应的视图
4. src/helpers/ - 工具函数集合，提供各类辅助功能
5. src/assets/ - 静态资源目录，包含图标、字体等资源

📚 延伸阅读：核心组件源码：src/components/

关键文件功能

• package.json：项目依赖配置中心，定义了项目的脚本命令和依赖包
• vite.renderer.config.ts：前端构建配置，控制Vite打包流程
• forge.config.ts：Electron应用打包配置，定义应用分发选项

核心模块解析：功能实现原理

代码视图模块

该模块负责代码文件的展示与交互，支持语法高亮和代码折叠功能。核心组件为CodeViewPage，位于src/pages/CodeViewPage.tsx。

全局分析模块

提供代码库级别的深度分析功能，可生成项目结构报告和代码质量评估。主要实现位于src/store/useGlobalAnalysisStore.ts。

本地化模块

支持多语言界面切换，通过src/localization/i18n.ts配置语言资源，目前已支持中、英、日三种语言。

📚 延伸阅读：多语言配置：src/localization/

快速启动：从环境准备到运行

环境检查脚本

🔧 目标：验证开发环境是否满足要求
命令：

node -v && npm -v && git --version

预期结果：显示Node.js (v14+)、npm (v6+)和Git版本信息，无错误提示

项目克隆与依赖安装

🔧 目标：获取代码并安装依赖
命令：

git clone https://gitcode.com/gh_mirrors/co/CodeAsk
cd CodeAsk
npm install

预期结果：项目文件下载完成，node_modules目录生成，无安装错误

开发环境启动

🔧 目标：启动开发服务器
命令：

npm run dev

预期结果：Electron应用启动，显示CodeAsk主界面

📌 常见启动故障排除：

• 端口占用：使用lsof -i:3000查找占用进程并终止
• 依赖冲突：删除node_modules和package-lock.json后重新安装
• 编译错误：检查Node.js版本是否符合package.json中engines要求

📚 延伸阅读：启动脚本定义：package.json

配置管理：定制你的开发环境

基础配置文件

项目核心配置文件位于根目录：

• tsconfig.json：TypeScript编译选项
• eslint.config.mjs：代码检查规则
• postcss.config.ts：CSS预处理配置

多环境配置方案

推荐采用环境变量文件区分配置：

1. 创建.env.development（开发环境）
2. 创建.env.production（生产环境）
3. 在代码中使用process.env.VAR_NAME访问

示例配置：

# .env.development
API_URL=http://localhost:3000/api
LOG_LEVEL=debug

配置项优先级规则

📌 配置加载顺序（从高到低）：

1. 命令行参数（如npm run dev -- --debug）
2. 环境变量（process.env）
3. 环境特定文件（如.env.development）
4. 默认配置文件（config/default.json）

自定义分析模板

🔧 目标：添加自定义代码分析规则
操作：编辑src/data/prompt-templates.json文件，添加新的分析模板

示例：

{
  "templates": [
    {
      "id": "security-check",
      "name": "安全漏洞检测",
      "prompt": "分析以下代码中的安全漏洞，重点检查SQL注入和XSS风险：\n\n{{code}}"
    }
  ]
}

预期结果：在全局分析面板中可选择新添加的"安全漏洞检测"模板

📚 延伸阅读：分析模板定义：src/data/prompt-templates.json