【VS Code】Windows10下VS Code配置Ruby语言环境
文章目錄
- 0. Ruby官方文檔
- 1. 下載安裝Ruby
- 2. 下載安裝插件
- 3. 安裝Ruby依賴
- 4. 書寫Ruby單文件下配置文件
- 5. 嘗試調試Ruby代碼
這篇文章屬于本人參考諸多博客、教程、文檔等資料，所撰寫的「Windows10上配置VS Code」系列文章之一，內容隨時可能發生更新變動，歡迎關注和收藏VS Code系列配置總目錄一文以作備忘。
不管怎樣，獲取了VS Code編輯器之后，我們將在VS Code中配置Ruby的語言學習環境，目前還缺少Ruby的編譯器和解釋器，缺少支持插件和配置代碼……不過，有關VSCode和Ruby的配合使用，我也不是太懂，慢慢學慢慢改吧……同樣的，我會在個人代碼庫 CodeWorld 中建立 Code_Ruby 文件夾，里面的文件夾是 Ruby_Single 和 Ruby_Multiple ，分別存放不同的分類代碼文件夾，即程序運行目標分別是單個源代碼文件或少數幾個源代碼文件的組合。
0. Ruby官方文檔
訪問這一網站https://ruby-doc.org/，可以看到Ruby的核心API、標準庫API文檔、起步教程和其他亂七八糟的東西：
不過感覺排版不是很好，可以訪問這一中文網站http://www.ruby-lang.org/zh_cn/documentation/作為代替/首選：
1. 下載安裝Ruby
先打開Ruby中文官網http://www.ruby-lang.org/zh_cn/downloads/，點擊紅框位置：
進入https://rubyinstaller.org/網站：
再點擊 Download 進入下載界面，右邊有詳細的解釋。如果不知道安裝哪個版本的話，建議使用 Ruby+Devkit 2.7.x (x64) 安裝包，它提供了最多數量的兼容gem，且和Ruby一起安裝了 MSYS2 Devkit ，可以編譯具有C擴展名的gem。僅當必須使用自定義32位本機DLL或者COM對象時，才建議使用32位x86版本。
可能你不是很了解MSYS2，但是作為一個程序員，你肯定知道MinGW，而MSYS2就集成了MinGW，同時還具有其他的一些特性，例如包管理器Pacman（用過ArchLinux的應該都知道Pacman）等等，這篇文章做了更詳細的區分和總結：Cygwin、MSYS、MinGW、MinGW64、MSYS2 區別。總而言之，MSYS2可以在Windows下搭建一個比較完美的類Linux環境（雖然對我而言用處不是很大），包括Bash、Vim、gcc、make等工具，都可以通過包管理器來添加和卸載。
我在這里選擇的是最新版 Ruby+Devkit 3.0.1-1 (x64) 。由于官網下載太慢，很久都下載不下來，可以點擊此處下載我分享的安裝包資源。下載完成之后，點擊運行，先接受許可：
自定義安裝目錄，然后勾選全部兩項，點擊 Install ：
然后選擇要安裝的組件，默認全部勾選，點擊 Next 即可：
最后就開始了安裝：
前面默認選擇了MSYS2，這里也勾選這個，然后點擊 Finish ：
出現如下界面，即使之前我在配置C++語言環境時安裝了MinGW-w64，還是保險起見，此處輸入3：
之后開始用GnuPG生成密鑰，然后開始用 pacman 安裝一系列亂七八糟的東西：
最后出現下圖時，按回車退出：
打開安裝文件夾可以看到整套MSYS2開發環境和MinGW64工具鏈。MSYS2小巧玲瓏，主要以基本的Linux工具為主，還有更優秀的包管理器 pacman ，不喜歡龐大的 Cygwin 的用戶可以試試MSYS2。
進入 usr/bin 目錄，可以看到（隨著Ruby下載安裝的）MSYS2提供的包管理器 pacman ，要使用它需要將當前目錄添加進環境變量：
現在，打開你的命令行，輸入 ruby -v 查看Ruby的版本號，如果成功就安裝成功了：
順便試一下Pacman：
2. 下載安裝插件
打開VS Code，Ctrl+Shift+X 進入擴展界面，輸入Ruby安裝對應插件：
安裝Ruby插件后，隨手新建 hello.rb ：
然后在VS Code的終端控制臺中運行該程序：
注意，如果報錯說——無法將“ruby”項識別為 cmdlet、函數、腳本文件或可運行程序，可能是權限不夠（為什么啊？），找到VS Ccode的 Code.exe ，右鍵選擇屬性，在兼容性中勾選【以管理員權限運行此程序】，然后重啟VS Code即可。
3. 安裝Ruby依賴
本節參考Ruby插件對應的文檔：https://github.com/rubyide/vscode-ruby/blob/main/docs/debugger.md。我們先要在控制臺中輸入下面幾個命令，安裝Ruby依賴：
gem install bundle gem install bundler gem install debase-ruby_core_source gem install debase gem install ruby-debug-ide一口氣安裝如下：
如果失敗，可能需要修改gem的源：
再執行下面的兩條命令，先刪除原有sources 源，再添加新源，然后重新運行上述安裝命令：
gem sources --remove https://rubygems.org/ gem sources -a https://mirrors.ustc.edu.cn/rubygems/執行 rdebug-ide 查看 ruby-debug-ide 的使用參數：
> rdebug-ide Using ruby-debug-base 0.2.5.beta2 Usage: rdebug-ide is supposed to be called from RDT, NetBeans, RubyMine, orthe IntelliJ IDEA Ruby plugin. The command line interface toruby-debug is rdebug.Options:-h, --host HOST Host name used for remote debugging-p, --port PORT Port used for remote debugging--dispatcher-port PORT Port used for multi-process debugging dispatcher--evaluation-timeout TIMEOUT evaluation timeout in seconds (default: 10)--evaluation-control trace to_s evaluation-m, --memory-limit LIMIT evaluation memory limit in mb (default: 10)-t, --time-limit LIMIT evaluation time limit in milliseconds (default: 100)--stop stop when the script is loaded-x, --trace turn on line tracing--skip_wait_for_start skip wait for 'start' command-l, --load-mode load mode (experimental)-d, --debug Debug self - prints information for debugging ruby-debug itself--xml-debug Debug self - sends information <message>s for debugging ruby-debug itself-I, --include PATH Add PATH to $LOAD_PATH--attach-mode Tells that rdebug-ide is working in attach mode--key-value Key/Value presentation of hash items--ignore-port Generate another port--keep-frame-binding Keep frame bindings--disable-int-handler Disables interrupt signal handler--rubymine-protocol-extensionsEnable all RubyMine-specific incompatible protocol extensions--catchpoint-deleted-event Enable chatchpointDeleted event--value-as-nested-element Allow to pass variable's value as nested element instead of attribute--socket-path PATH Listen for debugger on the given UNIX domain socket pathCommon options:-v, --version Show versionMust specify a script to run如果 gem install 死活安裝不上 debase 或者 ruby-debug-ide ，可以按照如下方法，從源碼安裝：
或者也有可能你把Ruby安裝到了一個帶有空格的路徑下，此時最好刪除原有安裝目錄、刪除Ruby的環境變量、重新下載RubyInstaller、重新安裝Ruby。要做到這一點，關鍵是拋棄把所有編程軟件安裝在一個目錄下的強迫癥……FxxK Ruby！！！
4. 書寫Ruby單文件下配置文件
如果想要添加全局配置，可以直接在不打開文件夾時運行->添加配置，然后會跳轉到全局的配置文件 settings.json 中（關于用戶配置和工作區配置，見此處文章）——我的 LaTeX\LaTeXLATE?X 配置代碼，目前就在全局配置文件中（也許有一天我還會建立一個 Code_LaTeX 文件夾，然后把相關 TeX\TeXTE?X 文件都放進去，只是不一定轉為工作區配置）：
不然就像我一樣，建立一個 CodeWorld/Code_Ruby 文件夾，然后打開該文件夾。類似于C/C++單文件語言學習環境的建立，這里先在其中創建一個名為 Seven_Weeks_Seven_Languages 的文件夾，用于《七周七語言》一書的學習。
然后使用運行->添加配置，（在打開文件夾且存在源文件時）自動創建 .vscode 文件夾和其中的 launch.json 文件。或者，可以點擊下面的創建 launch.json 文件：
VS Code會嘗試自動檢測你的調試環境，不過如果失敗了，就需要手動選擇，這里我們選擇 Ruby ：
接著需要選擇生成的那一份 configuration 的 name ，這里選中 Debug Local File ：
然后就生成了一份 launch.json 配置文件，用于Ruby的調試。現在回到文件瀏覽器，可以發現VS Code創建了一個 .vscode 文件夾，并且添加了 launch.json 文件到工作區。
其中 launch.json 文件的內容如下：
這只是 configurations 數組中的一個配置，我們可以添加任意多個配置，只要它們的 name 都獨一無二。經過反復修改后，我在 CodeWorld/Code_Ruby 下的 .vscode/launch.json 文件內容如下，configurations 中的注釋是我自己添加的：
{ // 欲了解更多信息，請訪問: https://go.microsoft.com/fwlink/?linkid=830387"version": "0.2.0","configurations": [ {//name是字符串形式的配置名稱,顯示在啟動配置下拉菜單中,在配置數組中必須獨一無二"name": "Debug Local File",//type是配置類型,必須是Ruby,告訴VS Code運行什么調試器"type": "Ruby",//request是請求配置類型,可以是launch(允許直接從VS Code中啟動提供的程序),//或者是attach,允許你附加到遠程調試會話(remote debug session)."request": "launch", //cwd調試程序時的工作目錄,需要是源碼文件所在的文件夾位置(program字符串指出的位置)"cwd": "${fileDirname}",//program是將要進行調試的程序的完整路徑,不應該依賴于相對路徑.//如果文件在你的工作區,program通常是這樣一個字符串"${workspaceRoot}/path/to/script.rb"//- ${workspaceRoot} 開啟在VS Code中的文件夾的路徑//- ${file} 當前打開的文件(的完整路徑)//- ${fileBasename} 當前打開的文件的basename(即文件名.擴展名)//- ${fileDirname} 當前打開的文件的dirname//- ${fileExtname} 當前打開的文件的擴展名"program": "${fileDirname}/${fileBasename}",//stopOnEntry設為true時調試程序將暫停在程序入口處,相當于在main上打斷點"stopOnEntry": false,//showDebuggerOutput展示一些額外的輸出信息到調試終端,尤其是關于rdebug-ide的運行"showDebuggerOutput": true,//args數組是程序調試時提供給程序的命令行參數,里面每個字符串都被作為一個單獨參數進行傳送"args": [],//env提供要在啟動程序之前設置的環境變量// "env": {// "BASE": "${fileDirname}",// "EXT": "${fileExtname}",// "RAILS_ENV": "test"// },//如果不是'ruby',就是Ruby可執行文件的路徑,用于運行程序(在沒有調試器時) //"pathToRuby": "ruby",//如果'rdebug-ide'不在PATH環境變量中,需要提供'rdebug-ide'的絕對路徑值,比如"c:\ruby\rdebug-ide.bat" "pathToRDebugIDE": "rdebug-ide",//"pathToBundler": "bundle"},{"name": "Minitest - current line","type": "Ruby","request": "launch", "cwd": "${fileDirname}","program": "${fileDirname}/bin/rails","args": ["test","${file}:${lineNumber}"]},{ //僅對當前打開的測試文件運行Test::Unit"name": "Test::Unit - open test file","type": "Ruby","request": "launch","cwd": "${fileDirname}", "program": "${file}","includes": ["test", "lib"] //使用includes在$LOAD_PATH中包含其他路徑。},{ //在當前打開的文件中,對單個選定的測試運行Test::Unit "name": "Test::Unit - single selected test","type": "Ruby","request": "launch","cwd": "${fileDirname}", "program": "${file}","includes": ["test", "lib"],"args": ["-n","${selectedText}"]},{ //這將在源文件目錄下運行rails服務器,假設binstubs已經通過bundler install --binstubs安裝"name": "Rails server","type": "Ruby","request": "launch","cwd": "${fileDirname}","program": "${fileDirname}/bin/rails","args": ["server"]},{ //使用傳遞過來的額外參數,運行所有的spec"name": "RSpec - all","type": "Ruby","request": "launch","cwd": "${fileDirname}","program": "${fileDirname}/bin/rspec","args": ["-I", "${fileDirname}","--require", "spec_helper","--require", "rails_helper","--format", "documentation",]},{ //運行RSpec,不過只在當前打開的spec文件上"name": "RSpec - active spec file only","type": "Ruby","request": "launch","cwd": "${fileDirname}","program": "${fileDirname}/bin/rspec","args": ["-I","${fileDirname}","${file}"]}, { //運行所有cuke"name": "Cucumber","type": "Ruby","request": "launch","cwd": "${fileDirname}","program": "${fileDirname}/bin/cucumber"},// { //用于遠程調試的配置,暫時用不到// "name": "Listen for rdebug-ide",// "type": "Ruby",// "request": "attach",// "remoteHost": "127.0.0.1",// "remotePort": "1234",// "remoteWorkspaceRoot": "${workspaceRoot}"// },] }5. 嘗試調試Ruby代碼
一份十分簡單的Ruby代碼：
rec = {"name"=>"first", "label"=>"second"} puts "#{rec}" puts "#{rec.size()}" puts "Hello Ruby World!"在運行和調試圖標下，選擇 Debug Local File ：
點擊這個綠色的小三角，開始調試程序：
然后前進一步：
前進到程序結束：
現在我們就可以運行和調試Ruby程序了！
總結
以上是生活随笔為你收集整理的【VS Code】Windows10下VS Code配置Ruby语言环境的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： CHD6.3.1部署文档
- 下一篇： Tegra X2 系统上安装 openp