★ FEATURED ARTICLE 教程开发工具【免费下载链接】githugGit your game on!项目地址https://gitcode.com/gh_mirrors/gi/githug点击查看免费下载导读Githug 是一个基于 Ruby 的交互式 Git 学习工具口号是 Git Your Game On。它以一系列难度递增的关卡为载体要求玩家在真实的 Git 仓库环境中执行正确的 git 命令来过关把枯燥的命令记忆变成动手实战。本文将以项目根目录 README.md 为主线完整讲解 Githug 的安装运行、四大游戏命令、关卡编写 DSL、关卡测试方法并结合仓库源码如 lib/githug/level.rb、lib/githug/cli.rb、lib/githug/game.rb 等深入剖析其底层实现。读完本文你不仅能立即上手玩通全部关卡还能亲手为 Githug 编写并测试一个新关卡。一、Githug 是什么以实战为核心的 Git 教学游戏Githug 的设计初衷是给你一种学习 Git 的实用方式。它内置一系列关卡每个关卡都要求你使用 git 命令达到正确结果——换句话说它不是考背诵而是考操作。玩家在游戏目录git_hug中真实地执行git init、git add、git commit等命令由 Githug 检查仓库状态并判定是否过关。与 Git 自带的教程不同Githug 的关卡覆盖了 Git 工作流的方方面面。从源码中可以看到完整关卡清单定义在 lib/githug/level.rb 的LEVELS数组中共 50 余关按学习路径排列init, config, add, commit, clone, clone_to_folder, ignore, include, status, number_of_files_committed, rm, rm_cached, stash, rename, restructure, log, tag, push_tags, commit_amend, commit_in_future, reset, reset_soft, checkout_file, remote, remote_url, pull, remote_add, push, diff, blame, branch, checkout, checkout_tag, checkout_tag_over_branch, branch_at, delete_branch, push_branch, merge, fetch, rebase, rebase_onto, repack, cherry-pick, grep, rename_commit, squash, merge_squash, reorder, bisect, stage_lines, find_old_branch, revert, restore, conflict, submodule, contribute每个关卡文件对应levels/目录下的同名.rb文件例如 levels/add.rb、levels/merge.rb、levels/bisect.rb。从LEVELS的排列顺序可以看出教学节奏从init初始化仓库起步历经暂存、提交、分支、合并、变基、樱桃拣选、二分定位、解决冲突直到最后一关contribute向 Githug 仓库提交贡献。关卡编号就是数组下标加 1因此githug reset merge_squash与githug reset 47效果相同详见 lib/githug/cli.rb 的加载逻辑。二、安装与启动2.1 环境要求PrerequisitesGithug 官方声明支持 Linux、OS X 和 Windows。唯一的前提是 Ruby 环境需要 Ruby 1.8.7 或更高版本README 原始声明注意README 的 FAQ 同时明确指出当前版本在 Ruby 3.0.0 及以上不受支持推荐使用 3.0.0 以下版本优先 2.7.1。这点在安装前务必确认。检查 Ruby 版本ruby --version如果未安装 Ruby请按照 Ruby 官方文档的安装指引进行安装本文不展开外部链接按官方说明操作即可。2.2 通过 gem 安装安装 Githug 只需一条命令gem install githug如果遇到权限报错可以加sudo重试sudo gem install githug该 gem 的元信息定义在 githug.gemspec 中依赖grit ~ 2.3.0用于读写 Git 仓库对象、thor ~ 0.14.6命令行框架、rake 11开发依赖rspec ~ 2.8.0。2.3 使用 Docker 运行README 提到社区提供了一份非官方的 Docker 镜像位于 Docker Hub由 odiraneyya 提供。仓库根目录的 Dockerfile 展示了这类镜像的构建思路基于ruby:slim基础镜像安装man与git保留 man 手册页以便玩家在关卡中查阅命令帮助将源码加入镜像后执行gem build与gem install *.gem随后自动运行echo y | githug创建初始进度并通过~/.bash_profile/~/.bash_logout脚本在会话进入/退出时保存与恢复关卡进度记录于$DATA_PATH卷中。如果你希望在容器化的教学/评分环境中使用 Githug这份 Dockerfile 是一个很好的参考起点。2.4 启动游戏安装完成后先切换到你想存放游戏资产关卡工作目录的位置然后运行githug首次运行时Githug 会提示你创建游戏目录No githug directory found, do you wish to create one? [yn]输入y继续输入n取消并退出。这一流程对应 lib/githug/cli.rb 中的make_directory!实现先检查当前目录下是否已有git_hug目录有则提示进入否则询问用户并创建git_hug目录后进入。也就是说游戏资产与关卡练习全部存放在git_hug目录内玩家在该目录中执行 git 命令完成关卡。三、四大游戏命令Githug 提供 4 个游戏命令定义于 lib/githug/cli.rb命令作用源码要点githug play默认命令检查当前关卡的解法是否正确由 Thor 的default_task :play设为默认任务见 lib/githug/cli.rbgithug hint给出当前关卡提示如果有调用level.show_hint见 lib/githug/level.rbgithug reset重置当前关卡或重置到指定关卡名/路径支持按数字编号、关卡名或文件路径加载githug levels列出全部关卡遍历Level.list并输出#N: name格式3.1 play默认的过关检测由于play是默认任务直接运行githug等价于githug play。其执行流程在 lib/githug/game.rb 中若玩家没有当前关卡profile.level为 nil输出 Welcome to Githug! 并自动进入第一关否则加载当前关卡调用level.solve执行关卡自带的solution代码块通过则输出绿色 Congratulations, you have solved the level! 并推进到下一关level_bump失败则输出红色 Sorry, this solution is not quite right!累计尝试次数每失败 3 次超过 2 次后会额外提示你可以使用githug hint和githug reset。通关后的level_bump会将当前关卡记入已完成列表计算下一关并调用setup_level初始化新关卡环境见 lib/githug/profile.rb。3.2 hint按需索要提示githug hint会从当前关卡的提示中取一条输出。提示有两种形态单个hint do ... end代码块或多个提示组成的hints [...]数组。若为数组形式show_hint会依据玩家进度文件中记录的current_hint_index依次循环展示见 lib/githug/level.rb若关卡未定义任何提示则输出 No hints available for this level.。3.3 reset重置与跳关githug reset的重置目标由load_level智能解析lib/githug/cli.rb不带参数重置当前关卡从玩家进度读取纯数字参数按关卡编号加载githug reset 47已有关卡名按名字加载githug reset merge_squash其他路径当作关卡文件路径直接加载githug reset PATH_TO_YOUR_LEVEL用于测试自建关卡。reset命令最终调用level.setup_level它会先执行repo.reset清空git_hug目录中除.、..、.profile.yml之外的所有文件并重建.gitignore见 lib/githug/repository.rb再执行关卡自身的setup代码块最后打印关卡完整描述。3.4 levels查看关卡列表githug levels会以#编号: 名称的格式逐行输出全部关卡方便你了解自己当前所处的位置以及后续要挑战的内容。四、编写关卡Githug 的关卡 DSL这是 README 的核心章节也是 Githug 最值得研究的设计用一套极简 Ruby DSL 描述一个关卡。关卡文件本质上是一个在Githug::Level实例上下文中instance_eval执行的 Ruby 脚本见 lib/githug/level.rb。4.1 最小关卡示例README 给出了一个完整示例对应仓库中的 levels/add.rbdifficulty 1 description There is a file in your folder called README, you should add it to your staging area setup do repo.init FileUtils.touch(README) end solution do return false unless repo.status.files.keys.include?(README) return false if repo.status.files[README].untracked true end hint do puts You can type git in your shell to get a list of available git commands end其中difficulty、description和solution是必填项。4.2 DSL 方法逐个解析结合 lib/githug/level.rb 的源码各 DSL 方法的语义如下方法必填作用源码difficulty num是设置关卡难度星级展示时以*个数体现level.rb#L54-L56description ...是设置关卡文字描述full_description会连同名称、编号、难度一起打印level.rb#L58-L60setup do ... end否初始化关卡环境默认情况下 Githug 会先清空游戏目录再执行本块level.rb#L67-L69solution do ... end是判定玩家是否过关返回true/falselevel.rb#L62-L65hint do ... end否定义单条提示level.rb#L71-L73hints [...]否定义多条提示数组玩家每次githug hint依次获取level.rb#L75-L774.3 repo 对象与 grit gem关卡内所有repo调用都指向 lib/githug/repository.rb 中的Repository实例。该类的method_missing会把未知方法转发给底层 grit gem 的Grit::Repo对象repository.rb#L39-L44因此你可以直接使用大多数 git 相关操作repo.init初始化一个空仓库若已存在则不做处理见 repository.rb#L35-L37repo.add、repo.commit、repo.commit_all、repo.status、repo.commits、repo.config等均由 grit 提供。例如 levels/checkout.rb 的 setup 直接使用repo.initrepo.add(README)repo.commit_all(initial commit)构建仓库levels/merge_squash.rb 则用repo.git.native :checkout, {b true}, long-feature-branch创建并切换分支。注意Repository#init是 Githug 自己定义的方法区别于 grit 的同名方法其语义是初始化仓库已存在则跳过。4.4 init_from_level从预置仓库初始化关卡对于需要复杂 Git 历史多分支、多提交、指定 commit hash的关卡逐个用代码构造太繁琐。Githug 提供了init_from_level方法setup do init_from_level end其实现见 lib/githug/level.rb把levels/你的关卡名/目录中的全部内容复制到游戏目录再把预置的.githug目录改名为.git从而把一份完整的 Git 仓库移植为当前关卡环境。README 推荐按以下步骤准备这类关卡素材mkdir yourlevel在levels/下创建关卡素材目录cd yourlevel并git init执行一些 git 操作构建历史提交、分支等重要把.git改名为.githug避免被当作子模块处理cd ../并git add yourlevel把素材提交进 Githug 仓库。仓库中的 levels/blame/含 config.rb、levels/merge/含 file1、levels/stash/含 lyrics.txt、levels/bisect/含 makefile、prog.rb、test.rb都是这种做法的实际例子。以 levels/blame.rb 为例它的 setup 只有三行——init_from_level载入预置历史、把分支改名为 master而 solution 则通过repo.commit(97bdd0cc...).author.name精确定位某次提交的作者并让玩家输入答案。4.5 solution 的判定技巧不止于 true/falsesolution代码块可以写任意 Ruby 逻辑常见做法包括检查仓库状态如 levels/add.rb 检查 README 是否已暂存repo.status.files[README].untracked为假检查文件内容如 levels/stage_lines.rb 用git diff --no-ext-diff --no-color --staged的输出去匹配特定改动行验证玩家是否只暂存了第一个 feature 的改动检查提交历史如 levels/rebase.rb 比较repo.commits(feature).map(:message)是否等于期望的提交信息序列交互式提问如 levels/config.rb 用request(What is your name?)读取玩家输入并与repo.config[user.name]比对组合系统命令如 levels/merge_squash.rb 同时校验提交数量repo.commits.size 3与合并后的文件内容。solution代码块在执行时会被Level#solve包裹level.rb#L98-L102任何异常都会被吞掉并返回false保证关卡不会因脚本错误而崩溃。4.6 多提示写法除了单个hint还可以用数组提供多级提示玩家多次执行githug hint会按顺序获取hints [ You can type git in your shell to get a list of available git commands, Check the man for git add]参考 spec/support/files/test_level.rb一个关卡甚至可以同时定义hints和hinthints优先被展示。五、测试关卡5.1 手动测试流程README 给出了测试自建关卡的最快路径进入你的 githug 仓库目录运行githug reset PATH_TO_YOUR_LEVEL载入并初始化该关卡按关卡要求解决它运行githug test PATH_TO_YOUR_LEVEL验证解法。其中githug test --errors会输出 solution 方法的错误堆栈方便调试。对应实现见 lib/githug/cli.rb 与 lib/githug/game.rbtest命令把默认的solve吞异常替换为test不吞异常因此--errors能暴露真实的 Ruby 异常。5.2 集成测试如果为新关卡编写集成测试测试用例位于 spec/githug_spec.rb并且必须按顺序运行before(:all)会先rake build、安装 gem、用echo y | githug初始化/tmp/git_hug目录之后每个用例都依赖前一个关卡已通关。若某关卡不便自动化测试如rename_commit、squash、reorder、conflict、contributeREADME 要求至少添加一个skip_level测试用例见 spec/githug_spec.rb 中的skip_level辅助方法就像contribute关卡那样。Rakefile 中默认任务即运行rspec见 Rakefile。六、底层运行机制速览为了写出高质量的关卡理解 Githug 的几个核心对象会很有帮助Profile进度档案lib/githug/profile.rb 用 YAML 文件.profile.yml持久化玩家的level、current_attempts、current_hint_index、completed_levels等状态。每个新关卡的 setup 都会清空这些计数。Game游戏循环lib/githug/game.rb 负责加载关卡 → 判定解法 → 晋级/提示的主循环。Repository仓库封装lib/githug/repository.rb 包装 grit提供reset清场、init建仓、valid?判断是否已是仓库以及向 grit 的透明转发。UI交互层lib/githug/ui.rb 封装输入输出ask实现[yn]问答error/success分别以红色/绿色输出在 Windows检测到OS环境变量下会自动去掉 ANSI 颜色码。扩展兼容层lib/githug/extensions/grit/ruby1.9.rb 为旧版 Ruby/grit 提供String#b、PACK_IDX_SIGNATURE等兼容补丁。七、FAQ常见问题与解决办法7.1 答案没有被正确检查这是 README 明确记录的一个常见问题项目方表示正在积极修复。目前的解决办法是把默认分支名改回master再重置当前关卡git config --global init.defaultBranch master githug reset这样从当前关卡开始默认分支就是master。这与关卡实现也吻合——你会发现levels/下许多关卡的 setup 都带有system git branch -m master一行如 levels/add.rb正是为了把仓库默认分支统一改为 master保证 solution 中的分支判断逻辑稳定。7.2githug命令无法工作Githug 当前不支持 Ruby 3.0.0 及以上版本请使用 3.0.0 以下版本优先 2.7.1使用 rvmrvm install 2.7.1 rvm use 2.7.1使用 rbenvrbenv install 2.7.1 rbenv global 2.7.1八、如何参与贡献README 的贡献流程如下Fork 仓库在levels目录中新建一个关卡方法见上文编写关卡把关卡名加入 lib/githug/level.rb 的LEVELS数组中的合适位置例如commit关卡应放在add、init关卡之后与教学顺序一致确保关卡可以正常过关方法见上文测试关卡提交 Pull Request。仓库中的Todo List也提到两个演进方向为关卡添加后续内容如针对某个命令的更多信息以及增加更多关卡。最后一关 levels/contribute.rb 的设计正是鼓励玩家完成这一贡献流程它克隆官方仓库到/tmp/githug检查玩家的user.name/user.email是否已出现在仓库提交记录中——一个别出心裁的终极关卡。结语Githug 的价值在于把学 Git变成玩 Git每一个关卡都是一个真实的仓库环境每一次过关都是对真实工作流的演练。通过本文你既掌握了它的安装、四大命令与常见问题处理也深入理解了关卡 DSL 与底层源码实现——接下来要做的就是运行githug亲手把LEVELS数组里的每一个关卡打通。赞分享教程开发工具【免费下载链接】githugGit your game on!项目地址https://gitcode.com/gh_mirrors/gi/githug点击查看免费下载相关推荐Githug DSL完全指南轻松编写Git学习关卡的终极教程Githug DSL完全指南轻松编写Git学习关卡的终极教程 Githug是一个创新的Git学习工具通过游戏化的方式让用户在实际操作中掌握Git命令。这个项教程开发工具Git学习游戏Githug终极指南如何通过55个关卡掌握Git技能Git学习游戏Githug终极指南如何通过55个关卡掌握Git技能 Githug是一款专为Git学习设计的互动游戏通过55个精心设计的关卡让你在实践中掌握教程开发工具Githug关卡开发终极指南如何创建自定义Git学习关卡Githug关卡开发终极指南如何创建自定义Git学习关卡 Githug是一个通过游戏化方式学习Git命令的实用工具它提供了完整的关卡开发框架让开发者能够创教程开发工具创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
阅读完成 · 觉得有帮助？
