Skip to content
This repository has been archived by the owner on Jan 18, 2023. It is now read-only.

A Sublime linter for the rorybot style guide checker

License

Notifications You must be signed in to change notification settings

Shopify/sublimelinter-rorybot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sublimelinter-rorybot

This linter plugin for SublimeLinter provides an interface to rorybot. 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.

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 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

About

A Sublime linter for the rorybot style guide checker

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages