leonelgalan/linter-markdownlint

Atom Linter for markdown using markdownlint/mdl

linter-markdownlint

This linter plugin for Linter provides an interface to markdownlint. It will be used with files that have the "Markdown" syntax.

Installation

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

mdl installation

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

1. Install ruby.

2. Install markdownlint by typing the following in a terminal:

gem install mdl

Now you can proceed to install the linter-markdownlint plugin.

Plugin installation

apm install linter-markdownlint

Settings

You can configure linter-markdownlint by editing ~/.atom/config.cson (choose Config... in Atom menu):

'linter-markdownlint':
  executablePath: 'mdl'
  severity: 'error'

Run which mdl to find the path, if you using rbenv run rbenv which mdl

linter-markdownlint's Issues

Impossible to find mdl in a gemset

When mdl is installed in a gemset, linter-markdownlint cannot find it and this error pops up:

Failed to run undefined
spawn mdl ENOENT

Setting the executable dir to something like the following outputs the exact same error:

GEM_PATH=~/.rvm/gems/ruby-2.3.1@cht_docs/ ~/.rvm/gems/ruby-2.3.1@cht_docs/bin/mdl

(Same when expanding ~ to the actual user dir)

Option for warnings instead of errors

Most other similar linters give warnings instead of errors. Just wondered whether you could add a corresponding option for this one?

Compatibility with linter 2.3.0

I couldn't get this to work with linter 2.3.0. The following works for me though:

apm install [email protected]
apm install [email protected]
apm install [email protected]
apm install [email protected]
apm install [email protected]
gem install mdl --version 0.5.0

I noticed busy-signal also isn't up to date with this. I didn't try with just downgrading linter and not busy-signal.

Save global style config

Thanks for the plugin! I was just reading #4 and it seems that there is good support for project-root level mdl style configs. However, it would be great if this plugin could have a global style file saved within Atom that is applied for all markdown files.

This would resolve issues when opening atom on a single markdown file (instead of the root project folder it is contained within) and also just editing random markdown files that are not necessarily part of a bigger project.

Thanks!

Phil

Install `linter` automatically.

By using atom-package-deps you are able to install linter automatically on activation. This will allow new Atom users to install only your package and nothing else, removing one step from the installation process.

Please see AtomLinter/linter-ruby#38 for example.

Using a custom style

In our project, we have our own style file defining which rules must be and must not be enforced. We run the linter as such:

mdl --style my-style.mdl.rb .

Correct me if I'm wrong, but I don't think there is an equivalent using this linter plugin (or it's missing from the README).

Since there is no convention set for configuration file naming on mdl file (and this is how other linter plugins for Atom detect the configuration), I suggest arbitrarily picking a name convention and documenting it in the README.
For example:

If style.mdl.rb exists at the root of your repository, it will be used as a custom style to run mdl. Otherwise, ...

Does this sound reasonable?