Skip to content

Update HOWTO #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
braver merged 1 commit into from
Mar 2, 2018
Merged

Update HOWTO #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions HOWTO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
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.
- 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).

Expand All @@ -17,22 +17,16 @@ Template linter plugins are created with almost all of the Linter class attribut

- 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. Or if you are going to implement a `cmd <cmd-method>` method, set the attribute to `None` and set the `executable` attribute to the name of the linter executable.
- 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:

- Determine the minimum/maximum versions of the linter executable that will work with your plugin and change the `version_args`, `version_re` and `version_requirement` attributes accordingly.

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

- If you wish to support embedded syntaxes, set the `selectors` attribute accordingly.

- If the linter subclasses from `PythonLinter`, remove the `module` attribute if you do not plan to use the linter’s python API. If you do, you will need to implement the `check` method.

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