This is the official VS Code extension for Standard Ruby, maintained by your friends at Test Double
You can install Standard Ruby from the Visual Studio Marketplace.
The extension only offers a few of its own configuration options, but because it conforms to the VS Code Formatting API, several general editor settings can impact the extension's behavior as well.
Configuring the VS Code editor to use Standard Ruby
There are two general editor settings that you'll want to verify are set in order to use Standard Ruby as your formatter.
To automatically format your Ruby with Standard Ruby, check Format on Save in the Formatting settings under Text Editor:
Next, if you have installed multiple extensions that provide formatting for Ruby
files (it's okay if you're not sure—it can be hard to tell), you can specify
Standard as your formatter of choice by setting
Configuring Standard Ruby extension options
To edit Standard Ruby's own options, first expand Extensions and select Standard Ruby from the sidebar of the Settings editor.
The Mode setting determines how (and whether) Standard Ruby runs in a given
workspace. Generally, it will try to execute
The auto-fix option does what it says on the tin. if you don't want Standard to automatically edit your documents on save, you can disable it here:
You might want to disable this if you're using Standard to highlight problems
but don't want it to edit your files automatically. You could also accomplish
this by disabling
As described above, the extension contains logic to determine which version of
This will override whatever search strategy is set in
Changing settings only for a specific project
You may want to apply certain settings to a specific project, which you can do by configuring them in the Workspace scope as opposed to the global User scope.
Clicking "Workspace" before changing a setting will save it to
Manually triggering a format with automatic fixes
In addition to the built-in VS Code Formatting API, you can trigger the extension to format and auto-fix the current file listing by running the command "Standard Ruby: Format with Automatic Fixes":
This is handy if you don't want to enable format-on-save, already have another formatter associated with Ruby files, want to format your code before saving, or just want to bind a shortcut to Standard's formatting action.
To map a keybind to the command, search for it by name in the Keyboard Shortcuts editor:
Decoding the Status Bar item
The extension also includes a status bar item to convey the status of the current file listing at a glance.
When the file conforms to Standard without issue:
When the file contains a low-severity formatting issue:
When the file contains a normal linter error:
When the file fails to parse at all:
Clicking the status bar item will open the problems tab:
There's some room for improvement yet, but it isn't yet clear whether these limitations will be a big deal in practice:
This extension's codebase was initially based on Kevin Newton's vscode-syntax-tree extension, which has a similar architecture (VS Code language client communicating with a long-running Ruby process via STDIO). Thank you, Kevin! 💚
Code of Conduct
This project follows Test Double's code of conduct for all community interactions, including (but not limited to) one-on-one communications, public posts/comments, code reviews, pull requests, and GitHub issues. If violations occur, Test Double will take any action they deem appropriate for the infraction, up to and including blocking a user from the organization's repositories.