A SublimeLinter3 interface to MATLAB mlint
- Total 2K
- Win 818
- Mac 624
- Linux 447
|Jan 23||Jan 22||Jan 21||Jan 20||Jan 19||Jan 18||Jan 17||Jan 16||Jan 15||Jan 14||Jan 13||Jan 12||Jan 11||Jan 10||Jan 9||Jan 8||Jan 7||Jan 6||Jan 5||Jan 4||Jan 3||Jan 2||Jan 1||Dec 31||Dec 30||Dec 29||Dec 28||Dec 27||Dec 26||Dec 25||Dec 24||Dec 23||Dec 22||Dec 21||Dec 20||Dec 19||Dec 18||Dec 17||Dec 16||Dec 15||Dec 14||Dec 13||Dec 12||Dec 11||Dec 10|
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!