https://github.com/r7kamura/vscode-ruby-light

Lightweight VSCode extension for Ruby.
https://github.com/r7kamura/vscode-ruby-light

ruby vscode

Last synced: 3 days ago
JSON representation

Lightweight VSCode extension for Ruby.

• Host: GitHub
• URL: https://github.com/r7kamura/vscode-ruby-light
• Owner: r7kamura
• License: mit
• Created: 2022-08-04T23:01:35.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-29T02:40:11.000Z (6 months ago)
• Last Synced: 2024-05-01T23:22:08.828Z (2 months ago)
• Topics: ruby, vscode
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=r7kamura.vscode-ruby-light
• Size: 3.81 MB
• Stars: 25
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• awesome-stars - r7kamura/vscode-ruby-light - Lightweight VSCode extension for Ruby. (TypeScript)

README

        
# vscode-ruby-light

[![build](https://github.com/r7kamura/vscode-ruby-light/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/r7kamura/vscode-ruby-light/actions/workflows/build.yml)

Lightweight VSCode extension for Ruby.

This extension is intended to provide a slightly better editing experience than VSCode's standard features, such as better syntax highlighting and better cursor manipulation, without requiring users to install Ruby.

## Install

Install via Visual Studio Marketplace:

- [Ruby Light - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=r7kamura.vscode-ruby-light)

### Optional configuration

If you want to use Diagnostics and Formatting features, `rubocop` must be available in your VSCode workspace. If `Gemfile` exists in the workspace or any ancestor directory, `bundle exec rubocop` is used instead. For the other features, there is no need to install anything additional.

If you want to partially disable any of the features provided by this extension, you can do so in the Settings menu.

## Features

### Diagnostics

Displays RuboCop offenses and provides Quick Fix command for autocorrection.

![demo](images/diagnostics.gif)

### Formatting

Run "Format Document" command or enable "Format On Save" in the settings to autocorrect RuboCop offenses.

![demo](images/document-formatting.gif)

### Highlight

Hover control keywords to highlight the corresponding keywords.

![demo](images/document-highlight.gif)

### Selection

Run "Expand Selection" command to select appropriate ranges.

![demo](images/selection-ranges.gif)

### Symbol

Show Outline section in the explorer panel to see symbols in the current file, or run "Go to Symbol" command to search for symbols.

This extension supports the folowiing types of symbols:

- class

- module

- constant

- instance method

- singleton method (a.k.a. class method)

- attribute (attr_accessor, attr_reader, and attr_writer)

![demo](images/document-symbol.gif)

### Others

- Add Ruby file extension patterns

- Add Ruby file name patterns

- Add indentation rules

## Configuration

### `rubyLight.diagnostics.enabled`

Enable diagnostics.

- default: `true`

### `rubyLight.documentFormatting.enabled`

Enable document formatting and document range formatting.

- default: `true`

### `rubyLight.documentHighlight.enabled`

Enable document highlight.

- default: `true`

### `rubyLight.selectionRanges.enabled`

Enable selection ranges.

- default: `true`

### `rubyLight.documentSymbol.enabled`

Enable document symbol.

- default: `true`