Qwerty Learner VSCode 插件技术文档

Qwerty Learner VSCode 插件技术文档

qwerty-learner-vscode 为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 VSCode 摸🐟版 / Words learning and English muscle memory training software designed for keyboard workers for VSCode 项目地址: https://gitcode.com/gh_mirrors/qw/qwerty-learner-vscode

1. 安装指南

1.1 安装前准备

• 确保你已经安装了 Visual Studio Code (VSCode)，最低版本要求为 1.53.0。
• 如果你使用的是中文输入法，请在安装和使用插件时关闭中文输入法，以避免可能的 Bug。

1.2 安装步骤

1. 打开 VSCode。
2. 进入扩展市场，搜索 Qwerty Learner。
3. 找到 Qwerty Learner VSCode 插件，点击安装。
4. 安装完成后，重启 VSCode 以确保插件生效。

2. 项目的使用说明

2.1 启动插件

• Mac: 使用快捷键 Control + Shift + Q 启动插件。
• Win: 使用快捷键 Shift + Alt + Q 启动插件。

启动后，插件会屏蔽用户对文档的输入，用户只需关注状态栏上的单词进行打字练习。

2.2 章节和词典选择

• 打开 VSCode 命令面板 (cmd + shift + p 或 ctrl + shift + p)。
• 输入 Qwerty 前缀，即可看到插件提供的命令。
  • Change Chapter: 切换章节。
  • Change Dictionary: 切换词典。
  • Start/Pause: 开关插件，功能等价于一键启动快捷键。
  • Toggle Word Visibility: 切换是否展示单词（默写模式）。
  • Toggle Read Only Mode: 开关只读模式。
  • Toggle Chapter Cycle Mode: 章节循环模式。

2.3 快捷配置

• Mac: 使用快捷键 Control + Shift + C 启用/禁用章节循环模式。
• Win: 使用快捷键 Shift + Alt + C 启用/禁用章节循环模式。

2.4 进阶配置

• 在 VSCode 设置面板中搜索 Qwerty，可以修改以下配置：
  • highlightWrongColor: 输入错误时单词的颜色。
  • highlightWrongDelay: 输入错误时清空输入的延迟时间。
  • keySound: 是否开启键盘音。
  • phonetic: 是否开启音标。
  • chapterLength: 每个章节包含的单词数量。
  • wordExerciseTime: 每个单词的练习次数。
  • readOnlyInterval: 只读模式中单词切换间隔时间。
  • voiceType: 是否开启发音。
  • placeholder: 未输入时的占位符。
  • random: 是否章节内单词顺序随机。
  • chapterCycle: 是否章节循环。

3. 项目API使用文档

3.1 监听用户输入

• 插件通过监听用户当前输入文档的改变来实现打字练习功能。
• 当用户输入时，插件会自动删除用户输入的文字，不会对文档内容造成影响。

3.2 处理输入错误

• 当用户输入速度较快（特别是同时按下多个键）时，可能会导致删除不完全。
• 用户可以自行删除输入，插件会继续正常工作。

4. 项目安装方式

4.1 通过 VSCode 扩展市场安装

• 打开 VSCode，进入扩展市场，搜索 Qwerty Learner。
• 找到 Qwerty Learner VSCode 插件，点击安装。

4.2 通过 GitHub 安装

• 访问 Qwerty Learner GitHub 项目。
• 下载项目源码，按照项目说明进行本地安装。

通过以上步骤，你可以顺利安装并使用 Qwerty Learner VSCode 插件，提升你的打字速度和英语肌肉记忆。

qwerty-learner-vscode 为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 VSCode 摸🐟版 / Words learning and English muscle memory training software designed for keyboard workers for VSCode 项目地址: https://gitcode.com/gh_mirrors/qw/qwerty-learner-vscode