Skip to content
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.

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

Rake tasks #131

Open
GarthDB opened this issue Apr 21, 2016 · 4 comments
Open

Rake tasks #131

GarthDB opened this issue Apr 21, 2016 · 4 comments
Labels
enhancement New feature or request

Comments

@GarthDB
Copy link
Contributor

GarthDB commented Apr 21, 2016

I'm going to be adding this to our Rake tasks, but I'm just doing the simplest solution: sh "bundle exec mdl"

It would be nice to have better Rake integration. It probably can already be done, but some improved documentation would be nice.

@jyaworski
Copy link

I'd really like to have this as well; we're looking to auto-lint our markdown files with travis. Rake is the easiest way to add that.

@mivok mivok added the enhancement New feature or request label Aug 23, 2016
@mivok
Copy link
Collaborator

mivok commented Aug 23, 2016

markdownlint was always intended to be a command line-only tool and not really used as a library or called directly from rake. That said, if it's just a matter of updating documentation that seems simple enough.

I suspect that if this is done, it will also be possible to speed up the cli tests which currently run markdownlint via the shell in the same way as your workaround.

@morremeyer
Copy link

We use the following rake task:

desc 'Linting for all markdown files'
task 'markdown_lint' do
  require 'mdl'

  ARGV = [ 'site', 'documentation', 'README.md', ]
  MarkdownLint::run
end

However, this is a really nasty workaround in my opinion, so I’d love to be able to get rid of it.

@mjgiarlo
Copy link

mjgiarlo commented Apr 5, 2019

We use the following rake task:

desc 'Linting for all markdown files'
task 'markdown_lint' do
  require 'mdl'

  ARGV = [ 'site', 'documentation', 'README.md', ]
  MarkdownLint::run
end

However, this is a really nasty workaround in my opinion, so I’d love to be able to get rid of it.

Would MarkdownLint.run([ 'site', 'documentation', 'README.md' ]) be an improvement? That's more or less what I've been doing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants