Vim 速查表

Vim 速查表（vim-cheatsheet-cn）

VS Code 扩展：在编辑器中直接打开 Vim 速查表，扩充你的 Vim 命令词汇量。中文汉化版。

本项目 Fork 自 andyalex234/vim-cheatsheet，在其基础上完成了速查表正文、测验题目与提示信息的完整中文汉化。特别感谢原作者 Andenet Alexander 及原项目提供的优秀基础。

简介

vim-cheatsheet-cn 将 Vim 速查表以 Webview 面板的形式直接嵌入 VS Code 编辑器，方便你在编码时随时查阅 Vim 命令，同时每次打开还会随机弹出一道小测验，帮助你巩固记忆。

功能特性

在编辑器侧边栏打开完整的 Vim 速查表，涵盖光标移动、插入模式、编辑、可视模式、寄存器、标记、宏、剪切粘贴、缩进、退出、搜索替换、差异对比等分类。
所有命令说明均已翻译为中文。
每次打开速查表时会随机出现一道 Vim 命令测验题。
速查表的颜色会自动适配当前主题，字体跟随用户偏好设置。

使用方法

按下 Ctrl + Shift + P（Windows/Linux）或 Cmd + Shift + P（Mac）打开命令面板。
搜索并执行 打开 Vim 速查表 命令。
速查表默认会在当前标签页旁的新标签页中打开，方便你一边编码一边查阅。

依赖

本扩展最好与 VSCodeVim 配合使用。

开发与构建

环境要求

Node.js 16 LTS 或以上
npm（随 Node.js 安装）

1. 安装依赖

npm install

2. 开发调试

用 VS Code 打开本项目，按 F5 启动扩展开发宿主窗口进行调试；或开启 webpack 监听自动重编译：

npm run watch

3. 编译打包产物

npm run package

该命令执行 webpack --mode production，在 dist/ 下生成 extension.js。

4. 打包为 VSIX 安装包

npx @vscode/vsce package --no-yarn

npx 会自动下载 @vscode/vsce，无需全局安装。
--no-yarn 让 vsce 使用 npm 而非 yarn 执行 prepublish 脚本（本项目已将 vscode:prepublish 改为 npm run package，二者配合可顺利打包）。
打包成功后在项目根目录生成 vim-cheatsheet-cn-1.0.0-cn.vsix（文件名由 package.json 的 name 与 version 决定）。

完整一条龙：npm install && npx @vscode/vsce package --no-yarn

安装 VSIX

code --install-extension vim-cheatsheet-cn-1.0.0-cn.vsix

或在 VS Code 扩展面板右上角 … → 从 VSIX 安装… 选择该文件。

常见问题

'yarn' 不是内部或外部命令：项目历史使用 yarn，现汉化版已改用 npm。若 vsce 仍提示使用 yarn，加 --no-yarn 参数；并确认 package.json 的 vscode:prepublish 为 npm run package。
Cannot find module ... https-proxy-agent/dist/index.js：npx 缓存损坏，删除后重试：
```
Remove-Item "$env:LOCALAPPDATA\npm-cache\_npx" -Recurse -Force
```
再重新执行 npx @vscode/vsce package --no-yarn。
打包报 README/LICENSE 错误：确保项目根目录存在 README.md 与 LICENSE.md。
请勿修改命令 ID：package.json 中的 vim-cheatsheet.open 是代码依赖的命令 ID，只能改其 title（显示名称），不要改 ID 本身。

发布到 GitHub

在 GitHub 新建仓库（例如 vim-cheatsheet-cn），不要勾选初始化 README。
在项目根目录初始化并推送：

git init
git add .
git commit -m "Initial commit: vim-cheatsheet 中文汉化版"
git branch -M main
git remote add origin https://github.com/mike-dutu0612/vim-cheatsheet-cn.git
git push -u origin main

发布 Release 并附带 VSIX：
- 本地打包出 vim-cheatsheet-cn-1.0.0-cn.vsix。
- 在 GitHub 仓库页面 → Releases → Draft a new release。
- 填写 tag（如 v1.0.0-cn），将 vsix 文件拖入附件区域，发布。

若要发布到 VS Code Marketplace，还需将 package.json 的 publisher 改为你自己的发布者 ID，并用 vsce publish（需 PAT）。仅 GitHub Release 分发 vsix 则无需此步。

发布说明

1.0.0-cn

基于原版 Vim Cheatsheet 的中文汉化版本，包含速查表正文、测验题目与提示信息的完整中文化。

致谢

特别感谢 andyalex234/vim-cheatsheet 及原作者 Andenet Alexander —— 本汉化版正是在该优秀项目基础上 Fork 并修改而成。
速查表内容源自社区维护的 Vim Cheatsheet。

License

沿用原项目许可证，详见 LICENSE.md。

dutu-mike