This is tested in ROS Kinetic.
This plugin is very much in development! Please file issues and make pull requests!
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
Before using this plugin, you must ensure that
roslint is installed on your system. To install
roslint, do the following:
You should have ROS installed.
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.
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.
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:
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.
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.
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|
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- 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!