Visual Studio Code Ruby 扩展使用教程

Visual Studio Code Ruby 扩展使用教程

vscode-rubyProvides Ruby language and debugging support for Visual Studio Code项目地址:https://gitcode.com/gh_mirrors/vs/vscode-ruby

1. 项目的目录结构及介绍

rubyide/vscode-ruby
├── docs
│   └── ... (文档文件)
├── images
│   └── ... (图片文件)
├── packages
│   ├── vscode-ruby
│   │   └── ... (Ruby 扩展包)
│   ├── vscode-ruby-client
│   │   └── ... (扩展逻辑包)
│   ├── vscode-ruby-common
│   │   └── ... (共享工具包)
│   ├── vscode-ruby-debugger
│   │   └── ... (调试器实现包)
│   └── language-server-ruby
│       └── ... (语言服务器实现包)
├── .gitignore
├── .node-version
├── .prettierrc
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE.txt
├── README.md
├── lerna.json
├── package.json
└── yarn.lock

目录结构介绍

• docs: 包含项目的文档文件。
• images: 包含项目的图片文件。
• packages: 包含多个子包，分别提供不同的功能：
  • vscode-ruby: 提供 Ruby 语法高亮、语言配置和代码片段。
  • vscode-ruby-client: 包含语言服务器客户端的扩展逻辑。
  • vscode-ruby-common: 包含多个包共享的工具和环境检测。
  • vscode-ruby-debugger: 实现调试器功能。
  • language-server-ruby: 实现语言服务器功能。
• .gitignore: Git 忽略文件配置。
• .node-version: Node.js 版本配置。
• .prettierrc: Prettier 代码格式化配置。
• .vscodeignore: VS Code 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE.txt: 项目许可证。
• README.md: 项目介绍和使用说明。
• lerna.json: Lerna 多包管理配置。
• package.json: 项目依赖和脚本配置。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 packages 目录下的各个子包中。以下是一些关键的启动文件：

• packages/vscode-ruby/extension.js: 这是 Ruby 扩展的主入口文件，负责初始化和启动扩展。
• packages/vscode-ruby-client/client.js: 这是语言服务器客户端的入口文件，负责与语言服务器进行通信。
• packages/vscode-ruby-debugger/debugAdapter.js: 这是调试器的入口文件，负责启动和配置调试会话。

3. 项目的配置文件介绍

项目的配置文件主要位于项目根目录和各个子包中。以下是一些关键的配置文件：

• package.json: 这是项目的主配置文件，包含项目的依赖、脚本和其他元数据。
• .vscodeignore: 这是 VS Code 的忽略文件配置，指定在打包扩展时忽略的文件和目录。
• .prettierrc: 这是 Prettier 代码格式化工具的配置文件，定义代码格式化的规则。
• lerna.json: 这是 Lerna 多包管理工具的配置文件，用于管理多个子包的版本和发布。

通过这些配置文件，可以对项目进行详细的设置和管理，确保项目的稳定运行和高效开发。

vscode-rubyProvides Ruby language and debugging support for Visual Studio Code项目地址:https://gitcode.com/gh_mirrors/vs/vscode-ruby