# sublimelinter-rorybot

**Repository Path**: mirrors_Shopify/sublimelinter-rorybot

## Basic Information

- **Project Name**: sublimelinter-rorybot
- **Description**: A Sublime linter for the rorybot style guide checker
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-02-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sublimelinter-rorybot

This linter plugin for [**SublimeLinter**](http://www.sublimelinter.com/en/latest/) provides an interface to [**rorybot**](https://github.com/shopify/rory). It will run automatically on files that have the "plain text, "markdown", "ruby," "html," or "html (rails)"  syntax (although we need to do more testing on what it skips in ruby and html (rails) files).

## Installing SublimeLinter

SublimeLinter 3 must be installed in order to use this plugin. Install SublimeLinter 3 through [Package Control](http://www.sublimelinter.com/en/latest/installation.html).

## Installing rorybot

Before using this plugin, you must ensure that **rorybot** is installed on your system. To install **rorybot**, visit the readme file in the [**rorybot**](https://github.com/Shopify/rorybot) repo and follow the instructions there.

## Installing sublimelinter-rory

1. Navigate to your Sublime packages directory.
    * You can find the location of the packages directory by opening Sublime and navigating to Sublime Text > Preferences > Browse Packages.
2. Clone this repository into your Sublime packages directory using Git.
3. Relaunch Sublime. 

### Set up console output

SublimeLinter sends the linter output to the status bar at the bottom of the screen. This is great if you only have one or two errors per line. But if you have multiple errors the text can run off the screen. The most useful way we've found to display the linter output in Sublime is to also send the stdout to Sublime's console.

1. Right-click on the text in a document.
2. Select SublimeLinter > Debug Mode.
3. Press `ctrl` + `` ` `` to open the console.

![sublime-linter rorybot with console open](screenshot.png)