A SublimeLinter3 interface to MATLAB mlint
- Total 2K
- Win 967
- Mac 704
- Linux 506
|Oct 7||Oct 6||Oct 5||Oct 4||Oct 3||Oct 2||Oct 1||Sep 30||Sep 29||Sep 28||Sep 27||Sep 26||Sep 25||Sep 24||Sep 23||Sep 22||Sep 21||Sep 20||Sep 19||Sep 18||Sep 17||Sep 16||Sep 15||Sep 14||Sep 13||Sep 12||Sep 11||Sep 10||Sep 9||Sep 8||Sep 7||Sep 6||Sep 5||Sep 4||Sep 3||Sep 2||Sep 1||Aug 31||Aug 30||Aug 29||Aug 28||Aug 27||Aug 26||Aug 25||Aug 24|
This linter plugin for SublimeLinter provides an interface to mlint, the MATLAB linter provided by the MathWorks. It will be used with files that have the “matlab” syntax. This plugin uses
mlint rather than the MathWorks recommendation of
mlint can be run as a standalone executable, while
checkcode requires starting up an entire MATLAB environment.
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
mlint is installed on your system. This should already be taken care if you've installed MATLAB. On OSX using MATLAB version R2013a, it is located in
/Applications/MATLAB_R2013a.app/bin/maci64/. On Ubuntu, it may be in
/usr/local/MATLAB/R2013a/bin/glnx86/ or similar.
In order for
mlint 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
mlint, you can proceed to install the SublimeLinter-contrib-mlint 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
mlint. Among the entries you should see
SublimeLinter-contrib-mlint. If that entry is not highlighted, use the keyboard or mouse to select it.
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 modications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbrevations unless they are very well known.
Thank you for helping out!