/SublimeLinter-contrib-golang-cilint

DEPRECATED: Use https://github.com/cixtor/SublimeLinter-golangcilint

Primary LanguagePythonMIT LicenseMIT

DEPRECATED: Use https://github.com/cixtor/SublimeLinter-golangcilint

SublimeLinter-contrib-golangci-lint

This linter plugin for SublimeLinter provides an interface to golangci-lint. It will be used with files that have the “Go” syntax.

Installation

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

Linter installation

Before using this plugin, you must ensure that golangci-lint is installed on your system. To install golangci-lint, do the following:

  1. Install Go.

  2. Install golangci-lint by typing the following in a terminal:

    go get github.com/golangci/golangci-lint/cmd/golangci-lint

Linter configuration

In order for golangci-lint 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 golangci-lint, you can proceed to install the SublimeLinter-contrib-golangci-lint plugin if it is not yet installed.

Plugin installation

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:

  1. 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.

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

Usage

If you are launching Sublime from a window manager, it's possible your GOPATH will not be set correctly. There are two ways around that:

  1. Launch Sublime from a shell with GOPATH already set correctly.
  2. Set the gopath setting in the linter configuration for SublimeLinter-contrib-golangci-lint.

Settings

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

Go vendoring will not work with SublimeLinter when lint_mode=background. Use save, load/save or manual.

Contributing

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

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. 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!