This linter plugin for SublimeLinter provides an interface to javac. It will be used with files that have the “Java” syntax.
Please note that because javac requires a complete directory context in order to work, this linter plugin currently will only lint a file when it has been saved. As soon as you modify the file, all linter marks will be cleared.
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 javac is installed on your system. javac is part of the java developer SDK, which can be downloaded here.
NOTE: This plugin currently supports only JDK 1.7+.
In order for javac 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 javac is installed and configured, you can proceed to install the SublimeLinter-javac 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 seePackage 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
javac. Among the entries you should seeSublimeLinter-javac. If that entry is not highlighted, use the keyboard or mouse to select it.
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-javac provides its own setting, which may also be used as an inline setting.
| Setting | Description |
|---|---|
| lint | A comma-delimited list of rules to apply. |
Valid rule names are: all, cast, classfile, deprecation, dep-ann, divzero, empty, fallthrough, finally, options, overrides, path, processing, rawtypes, serial, static, try, unchecked, varargs, -cast, -classfile, -deprecation, -dep-ann, -divzero, -empty, -fallthrough, -finally, -options, -overrides, -path, -processing, -rawtypes, -serial, -static, -try, -unchecked, -varargs, none.
For example, to ignore deprecation warnings for all files in a project, you would add this to the linter settings:
"javac": {
"lint": "all,-deprecation"
}
To change the settings in the same way for a single file, you would put this comment on the first or second line of the file:
// [SublimeLinter javac-lint:all,-deprecation]
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
master. - 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!