Skip to content

Commit

Permalink
pre-spring cleaning
Browse files Browse the repository at this point in the history
  • Loading branch information
braver committed Dec 29, 2017
1 parent b63d88d commit e443e98
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 64 deletions.
14 changes: 0 additions & 14 deletions .sublimelinterrc

This file was deleted.

54 changes: 8 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ SublimeLinter-xmllint

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

This linter plugin for [SublimeLinter][docs] provides an interface to [xmllint](http://xmlsoft.org/xmllint.html). It will be used with files that have the “XML” syntax.
This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [xmllint](http://xmlsoft.org/xmllint.html). It will be used with files that have the “XML” syntax.

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

Please use [Package Control](https://packagecontrol.io) to install the linter plugin.

### Linter installation
Before using this plugin, you must ensure that `xmllint` is installed on your system. On recent versions of Mac OS X, `xmllint` comes pre-installed. To install `xmllint` on other platforms, do the following:

1. On Linux:
Expand All @@ -19,50 +20,11 @@ Before using this plugin, you must ensure that `xmllint` is installed on your sy
On Windows, follow the instructions [here](http://flowingmotion.jojordan.org/2011/10/08/3-steps-to-download-xmllint/). There is another version on code.google.com, but that version is incompatible with this plugin.
Once `xmllint` is installed, you must ensure it is in your system PATH so that SublimeLinter can find it. This may not be as straightforward as you think, so please read about [how linter executables are located][locating-executables] in the documentation.
### Linter configuration
In order for `xmllint` 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”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.
Once `xmllint` is installed and configured, you can proceed to install the SublimeLinter-xmllint plugin if it is not yet installed.
### 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 `xmllint`. Among the entries you should see `SublimeLinter-xmllint`. If that entry is not highlighted, use the keyboard or mouse to select it.
In order for `xmllint` 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
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].
`xmllint` has many possible command line arguments which may be passed via [Linter Settings][linter-settings].
## 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 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.
- SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html
- Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html
Thank you for helping out!
`xmllint` has many possible command line arguments ("args") which may be passed via the Linter settings.
[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
5 changes: 1 addition & 4 deletions messages/install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ SublimeLinter-xmllint
-------------------------------
This linter plugin for SublimeLinter provides an interface to xmllint.

** IMPORTANT! **

Before this plugin will activate, you *must*
follow the installation instructions here:
Please read the installation instructions at:

https://github.com/SublimeLinter/SublimeLinter-xmllint

0 comments on commit e443e98

Please sign in to comment.