Cursor Fake Machine 项目实战指南

一、项目架构速览 📊

当你首次接触一个新项目时，是不是常常对着一堆文件感到无从下手？别担心，我们用可视化的方式帮你快速理清项目骨架：

cursor-fake-machine/
├── .vscode/               # VS Code专属配置
├── test/                  # 测试用例目录
├── CHANGELOG.md           # 项目更新日志
├── LICENSE.md             # 开源许可协议
├── README.md              # 项目说明文档
├── eslint.config.mjs      # ESLint配置
├── extension.js           # 扩展核心逻辑
├── icon.png               # 扩展图标
├── jsconfig.json          # JS配置文件
├── package.json           # 项目元数据
├── pnpm-lock.yaml         # 依赖锁定文件
└── vsc-extension-quickstart.md  # 扩展开发指南

💡 快速定位技巧：核心业务代码在extension.js，项目配置看package.json，代码规范检查找eslint.config.mjs

二、核心文件解析 🔍

2.1 扩展入口：extension.js

问题：如何快速理解扩展的启动流程？

extension.js是整个扩展的"大脑"，负责处理激活和销毁逻辑：

// extension.js
// 扩展激活时执行
function activate(context) {
    // 注册命令、监听事件等初始化操作
    console.log('扩展已激活');
}

// 扩展停用前执行
function deactivate() {
    // 清理资源，避免内存泄漏
    console.log('扩展已停用');
}

exports.activate = activate;
exports.deactivate = deactivate;

💡 关键逻辑：activate方法是扩展功能的入口点，所有命令注册和事件监听都应在这里完成

2.2 项目配置中心：package.json

问题：如何确认项目的依赖和可用脚本？

package.json就像项目的"身份证"，记录了所有关键信息：

{
  "name": "cursor-fake-machine",
  "version": "1.0.0",
  "main": "./extension.js",
  "scripts": {
    "test": "node ./test/extension.test.js"
  },
  "engines": {
    "vscode": "^1.80.0"
  },
  "dependencies": {
    // 项目依赖
  }
}

💡 实用技巧：通过scripts字段可以快速查看可用命令，如npm run test执行测试

三、配置实战指南 ⚙️

3.1 解决依赖安装慢：.npmrc配置

问题：安装依赖时速度太慢怎么办？

.npmrc文件可以配置npm镜像源，大幅提升依赖安装速度：

# .npmrc
registry=https://registry.npm.taobao.org/  # 使用淘宝镜像

💡 配置效果：将默认npm仓库替换为国内镜像，依赖下载速度提升5-10倍

3.2 代码质量保障：eslint.config.mjs

问题：如何确保团队代码风格一致？

eslint.config.mjs定义了代码检查规则：

// eslint.config.mjs
module.exports = {
    extends: ['eslint:recommended'],
    rules: {
        'indent': ['error', 4],         // 强制4空格缩进
        'quotes': ['error', 'double'],  // 强制双引号
        'no-console': 'warn'            // 警告console语句
    }
};

💡 使用建议：提交代码前运行npx eslint .检查，避免代码风格问题

四、开发与测试流程 🚀

4.1 环境准备

首先克隆项目到本地：

git clone https://gitcode.com/gh_mirrors/cu/cursor-fake-machine
cd cursor-fake-machine
pnpm install  # 安装依赖

4.2 运行测试

项目测试文件位于test/extension.test.js，执行测试命令：

pnpm test  # 运行所有测试用例

4.3 扩展图标说明

项目使用icon.png作为扩展图标，图片内容为一个几何图形与表情组合的设计，用于在VS Code扩展市场展示：

五、常见问题解决 🛠️

5.1 依赖冲突

问题：安装依赖时出现版本冲突？

解决方案：删除pnpm-lock.yaml后重新安装：

rm pnpm-lock.yaml
pnpm install

5.2 扩展激活失败

检查点：

1. 确保package.json中的main字段指向正确的入口文件
2. 检查extension.js是否正确导出activate和deactivate函数
3. 查看VS Code开发者控制台(Help > Toggle Developer Tools)获取错误信息

💡 调试技巧：按F5启动扩展开发宿主，实时查看运行日志