diff --git a/.sublimelinterrc b/.sublimelinterrc deleted file mode 100644 index 22b2d02..0000000 --- a/.sublimelinterrc +++ /dev/null @@ -1,14 +0,0 @@ -{ - "@python": 3, - "linters": { - "flake8": { - "max-line-length": 120 - }, - "pep257": { - "ignore": ["D202", "D211"] - }, - "pep8": { - "max-line-length": 120 - } - } -} diff --git a/.travis.yml b/.travis.yml index 72fc694..000f751 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,13 +1,7 @@ language: python python: - - "3.5" -# command to install dependencies + - "3.6" install: - - pip install flake8==2.5.4 - - pip install pep257==0.7.0 - - pip install pep8==1.7.0 -# command to run tests + - pip install flake8 script: - flake8 . --max-line-length=120 - - pep257 . --ignore=D202,D211 - - pep8 . --max-line-length=120 diff --git a/README.md b/README.md index 80f9d52..b75f9a5 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -# SublimeLinter-contrib-mdl +# SublimeLinter-mdl -[![Build Status](https://travis-ci.org/roadhump/SublimeLinter-contrib-mdl.svg?branch=master)](https://travis-ci.org/roadhump/SublimeLinter-contrib-mdl) +[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-mdl.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-mdl) -This linter plugin for [SublimeLinter][docs] provides an interface to [Markdown lint tool (mdl)](https://github.com/mivok/markdownlint). It will be used with files that have the “Markdown” syntax. +This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [Markdown lint tool (mdl)](https://github.com/mivok/markdownlint). It will be used with files that have the “Markdown” 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]. +## Installation +SublimeLinter 3 must be installed in order to use this plugin. -### Linter installation +Please install via [Package Control](https://sublime.wbond.net/installation). Before using this plugin, you must ensure that `mdl` is installed on your system. To install `mdl`, do the following: @@ -22,58 +22,14 @@ Before using this plugin, you must ensure that `mdl` is installed on your system 1. If you are using `rbenv` or `rvm`, ensure that they are loaded in your shell’s correct startup file. See [here](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#shell-startup-files) for more information. -**Note:** This plugin requires `mdl` 0.2.1 or later. - -### Linter configuration - -In order for `mdl` 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 you have installed and configured `mdl`, you can proceed to install the SublimeLinter-contrib-mdl 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 `mdl`. Among the entries you should see `SublimeLinter-contrib-mdl`. 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]. - -In addition to the standard SublimeLinter settings, SublimeLinter-contrib-mdl provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be [used inline][inline-settings]. - -|Setting|Description|Inline Setting|Inline Override| -|:------|:----------|:------------:|:-------------:| -|bundle-exec|runs mdl as "bundle exec mdl" instead of "mdl"| |✓| - -## 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. +- 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! +Additional SublimeLinter-mdl 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 +|Setting|Description| +|:------|:----------| +|bundle-exec|runs mdl as "bundle exec mdl" instead of "mdl"| diff --git a/linter.py b/linter.py index 10db907..d9e2c46 100644 --- a/linter.py +++ b/linter.py @@ -1,32 +1,14 @@ -# -# linter.py -# Linter for SublimeLinter3, a code checking framework for Sublime Text 3 -# -# Written by Aliaksei Shytkin -# Copyright (c) 2015 Aliaksei Shytkin -# -# License: MIT -# - -"""This module exports the mdl plugin class.""" - from SublimeLinter.lint import RubyLinter class Mdl(RubyLinter): - - """Provides an interface to mdl.""" - - syntax = ('markdown', 'markdown gfm', 'multimarkdown') executable = 'mdl' - version_args = '--version' - version_re = r'(?P\d+\.\d+\.\d+)' - version_requirement = '>= 0.2.1' regex = r'^.+?:(?P\d+): (?P(?P[^`]*))' - config_file = ('--config', '.mdlrc', '~') line_col_base = (1, 1) tempfile_suffix = 'md' - inline_overrides = ('bundle-exec') + defaults = { + 'selector': 'text.html.markdown' + } def cmd(self): """Support bundle-exec.""" diff --git a/messages/install.txt b/messages/install.txt index ea49149..07aabe1 100644 --- a/messages/install.txt +++ b/messages/install.txt @@ -1,10 +1,7 @@ -SublimeLinter-contrib-mdl +SublimeLinter-mdl ------------------------------- This linter plugin for SublimeLinter provides an interface to mdl. -** IMPORTANT! ** +Please read the installation instructions at: -Before this plugin will activate, you *must* -follow the installation instructions here: - -https://github.com/roadhump/SublimeLinter-contrib-mdl +https://github.com/roadhump/SublimeLinter-mdl