commit caa6840c5953598e29bfba962a1d7e2f00fdf78a Author: Reuh Date: Thu Aug 8 15:23:12 2019 +0200 Initial commit diff --git a/HOWTO.md b/HOWTO.md new file mode 100755 index 0000000..305af2c --- /dev/null +++ b/HOWTO.md @@ -0,0 +1,32 @@ +Creating a Linter Plugin +======================== + +- Fork this repo to bootstrap your new linter. +- Clone it into Packages. +- Change a linter.py. +- Update the README and replace `__linter__` placeholders. +- Update messages/install.txt and replace `__linter__` placeholders. +- Open a PR in our [package_control repo](https://github.com/SublimeLinter/package_control_channel) to make it available to others. + +Additional documentation can be found at [sublimelinter.com](http://sublimelinter.com). + + +Updating class attributes +-------------------------- +Template linter plugins are created with almost all of the Linter class attributes filled in with the default values. To make your new linter plugin functional, at the very least you need to do the following: + +- Change the default `'selector'` to include the scopes you want the linter to lint. + +- Change the `cmd` attribute to include the executable and arguments you want to include on *every* run. Usually this should be a tuple like `('linter', '-fooarg', '-etc', '-')`. You can also make `cmd` a method (or callable in python speak) which returns such a tuple. + +- Change the `regex` attribute to correctly capture the error output from the linter. + +- Change the `multiline` attribute to `True` if the regex parses multiline error messages. + +Other, optional, attributes include: + +- If the linter executable does not accept input via `stdin`, set the `tempfile_suffix` attribute to the filename suffix of the temp files that will be created. + +- If the linter outputs errors only on `stderr` or `stdout`, set `error_stream` to `util.STREAM_STDERR` or `util.STREAM_STDOUT` respectively. + +You should remove attributes that you do not change, as their values will be provided by the superclass. More information can be found in the [docs](https://github.com/SublimeLinter/SublimeLinter/blob/master/docs/linter_attributes.rst). diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..89de354 --- /dev/null +++ b/LICENSE @@ -0,0 +1,17 @@ +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100755 index 0000000..1faffcf --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +SublimeLinter-contrib-candran +================================ + +[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-candran.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-candran) + +This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [canc -parse](https://github.com/Reuh/candran). It will be used with files that have the “Candran” syntax. + +## Installation +SublimeLinter must be installed in order to use this plugin. + +Please use [Package Control](https://packagecontrol.io) to install the linter plugin. + +Before installing this plugin, you must ensure that `canc` (which is included with [Candran](https://github.com/Reuh/candran)) is installed on your system. + +In order for `canc` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. The docs cover [troubleshooting PATH configuration](http://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable). + +## Settings +- SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html +- Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html diff --git a/linter.py b/linter.py new file mode 100755 index 0000000..eb24bcf --- /dev/null +++ b/linter.py @@ -0,0 +1,10 @@ +from SublimeLinter.lint import Linter, util + + +class Candran(Linter): + cmd = ('canc', '-parse', '-') + regex = r'^.+?:.+?:(?P\d+):(?P\d+): (?P.+)$' + error_stream = util.STREAM_STDERR + defaults = { + 'selector': 'source.candran' + } diff --git a/messages.json b/messages.json new file mode 100755 index 0000000..ef56f9e --- /dev/null +++ b/messages.json @@ -0,0 +1,3 @@ +{ + "install": "messages/install.txt" +} diff --git a/messages/install.txt b/messages/install.txt new file mode 100755 index 0000000..ad65236 --- /dev/null +++ b/messages/install.txt @@ -0,0 +1,6 @@ +SublimeLinter-contrib-candran +------------------------------- +This linter plugin for SublimeLinter provides an interface to canc -parse. + +For more information, please see: +https://github.com/Reuh/SublimeLinter-contrib-candran