SublimeLinter module for RedPen

Copyright (c) 2015-2016 Takahiro Yoshimura altakey@gmail.com
Copyright (c) 2016 Ken Sakurai sakurai.kem@gmail.com

SublimeLinter module for RedPen ( http://redpen.cc/ ).

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before installing this plugin, you must ensure that redpen is installed on your system. To install redpen, download and run tar.gz from the download page. On Mac OS X, the best option is to install Homebrew and then enter the following in a terminal:

brew install redpen

Note: This plugin requires redpen 1.7.0 or later.

Linter configuration

In order for redpen to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once redpen is installed and configured, you can proceed to install the SublimeLinter-redpen plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

1. Within Sublime Text, bring up the Command Palette and type Add Repository. Among the commands you should see Package Control: Add Repository. If that command is not highlighted, use the keyboard or mouse to select it. Since Form will be displayed, enter the following URL.

https://github.com/taky/SublimeLinter-redpen

1. Bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that entry is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

2. When the plugin list appears, type redpen. Among the entries you should see SublimeLinter-redpen. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

You can configure conf options by going to: Tools > SublimeLinter > Open User Settings. You may provide a custom config file by setting the linter’s "conf" setting to "conf" : "/path/to/file". On Windows, be sure to double the backslashes in the path, for example "conf" : "C:\\Users\\Aparajita\\redpen.conf".

Contributing

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latest master.
3. Commit and push the topic branch.
4. Make a pull request.
5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

• Indent is 4 spaces.
• Code should pass flake8 and pydocstyle linters.
• Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!