Forked from SublimeLinter-contrib-glua
This linter plugin for SublimeLinter provides an interface to sqfc -p. It will be used with files that have the “SQF” syntax.
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 sqfc is installed on your system. The sqfc executable can be found on its repository releases page. You must also ensure that sqfc is in your system PATH. If you're unfamiliar with this process, here's a tutorial for various versions of Windows.
In order for sqfc 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.
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
sqf. Among the entries you should seeSublimeLinter-contrib-sqf. 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-contrib-glua provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.
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.
- Vertical whitespace helps readability, don’t be afraid to use it.
Thank you for helping out!