SublimeLinter-contrib-julialintserver
================================

[![Build Status](https://travis-ci.org/invenia/SublimeLinter-contrib-julialintserver.svg?branch=master)](https://travis-ci.org/invenia/SublimeLinter-contrib-julialintserver)

This linter plugin for [SublimeLinter][docs] provides an interface to [`Lint.jl`](https://github.com/tonyhffong/Lint.jl) `lintserver`. It will be used with files that have the “julia” syntax.

This plugin will launch and maintain a juila daemon subprocess running `Lint.jl` `lintserver` to avoid recompiling `Lint.jl` on every invocation.
When you exit sublime text the subprocess will kill itself.
The first time you lint the lintserver will have to compile and start up which usually takes about 30 seconds.


## Installation
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][installation].

[Python3](https://www.python.org/download) must be installed to run and maintain the daemon subprocess. Make sure `python3` is included in your PATH.


### Linter installation
In order for this plugin to be functional you must have a `Lint.jl` installed. To set it up do the following:

1. Install [`Julia`](http://julialang.org/). Make sure `julia` is included in your PATH.

1. Add [`Lint`](https://github.com/tonyhffong/Lint.jl) to `Julia`
    ```Julia
    Pkg.add("Lint")
    ```

**Note:** The first lint will take ~30 seconds because julia has to compile the `Lint.jl` `lintserver`.

**Note:** This plugin requires `Lint.jl` version `0.2.1` or later.


### Plugin installation
Please use [Package Control][pc] 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:

1. Within Sublime Text, bring up the [Command Palette][cmd] 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.

1. When the plugin list appears, type `julialintserver`. Among the entries you should see `SublimeLinter-contrib-julialintserver`. If that entry is not highlighted, use the keyboard or mouse to select it.

## Settings
For general information on how SublimeLinter works with settings, please see [Settings][settings]. For information on generic linter settings, please see [Linter Settings][linter-settings].

|Setting|Description|Default|
|:------|:----------|:------------:|
|show_info_warnings|Show INFO Warnings.|false
|server_port|Server Port.|2222

## Contributing
If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
1. Hack on a separate topic branch created from the latest `master`.
1. Commit and push the topic branch.
1. Make a pull request.
1. Be patient.  ;-)

Please note that modifications 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 abbreviations unless they are very well known.

Thank you for helping out!

[docs]: http://sublimelinter.readthedocs.org
[installation]: http://sublimelinter.readthedocs.org/en/latest/installation.html
[locating-executables]: http://sublimelinter.readthedocs.org/en/latest/usage.html#how-linter-executables-are-located
[pc]: https://sublime.wbond.net/installation
[cmd]: http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html
[settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html
[linter-settings]: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html
[inline-settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-settings