SublimeLinter plugin for roslint
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
messages
.gitignore
.sublimelinterrc
.travis.yml
LICENSE
README.md
linter.py
messages.json

README.md

SublimeLinter-roslint

This linter plugin for SublimeLinter provides an interface to roslint. It will be used with files that have the “C++” syntax.

This is tested in ROS Kinetic.

This plugin is very much in development! Please file issues and make pull requests!

Installation

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

Clone the repository inside /home/<USERNAME>/.config/sublime-text-3/Packages/

Linter installation

Before using this plugin, you must ensure that roslint is installed on your system. To install roslint, do the following:

  1. You should have ROS installed.

  2. If you don't already have roslint installed in /opt/ros/kinetic/lib/roslint/, install it.

    sudo apt-get install ros-kinetic-roslint

Linter usage (this is an issue)

Currently, roslint will only work if you launch sublime text from the command line. subl file.cpp

Linter configuration

In order for roslint 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 you have installed and configured roslint, you can proceed to install the SublimeLinter-roslint 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 install. Among the commands you should see Package Control: Install Package. If that command 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 roslint. Among the entries you should see SublimeLinter-roslint. 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.

In addition to the standard SublimeLinter settings, SublimeLinter-roslint provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.

Setting Description Inline Setting Inline Override
foo Something.
bar Something else.

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 modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 linting.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!