Read config from _config.yml when present

[benbalter]

I taught my Rakefile to read the html_proofer property of my _config.yml file.

• Config
• Rakefile

Would be awesome to support that automatically, if a _config.yml file is present.

[doktorbro]

What do you think about that?

# _proofer.yml
verbose: true
typhoeus:
  ssl_verifyhost: 2

# Rakefile
HTML::Proofer.new("./_site", :config => '_proofer.yml').run

The default for the config could be _proofer.yml.

[gjtorikian]

I do very much like the idea of making this generic as @penibelst suggests. What if it reads from :config if provided, or a :config_key in a :config if that's provided? For example, in addition to the above, it could also be:

HTML::Proofer.new("./_site", :config => '_config.yml', :config_key => 'proofer' ).run

# _config.yaml
baseurl: ''
proofer:
 - verbose: true
 - typhoeus:
   ssl_verifyhost: 2

Not sure if that's overly complicated. I'm not often a fan of introducing a new top-level file in projects (_proofer.yml) for people that do not like them.

[doktorbro]

Not sure if that's overly complicated.

I think it is. We should not motivate people to pollute foreign configuration files.

[gjtorikian]

Fair enough, fair enough. I think a _proofer.yml is fine.

[nschonni]

_proofer.yml might be too generic, the filename should include "html" like .htmlproofer.yml

[doktorbro]

@nschonni I agree. And I like the dot at start.

We could make the config feature only available for the binary.

htmlproof --config .myproofer.yml

The default config should have the same name as the binary .htmlproof.yml.

[episource]

In case this refers to jekyll: I created a minimalistic jekyll plugin wrapping html-proofer. The plugin can be configured using jekyll's _config.yml.

[FelicianoTech]

The default config should have the same name as the binary .htmlproof.yml.

This sounds great. This would be a really valuable feature.

[gjtorikian]

Won't support myself, but PRs accepted