Allow loading config file from plugin directory #878
Conversation
`plugin_directories` property can be used in `.scss-linter.yml` to load additional linters from a directory. However it does not allow loading custom `.scss-linter.yml` for such directory. This commit allows loading a custom `.scss-linter.yml` from any directory specified in `plugin_directories` and merge it with your existing configuration.
barraq
force-pushed
the
feature/allow-loading-config-file-from-plugin-dir
branch
from
80f6fff to
787c381
Compare
| # | ||
| # @return [String] | ||
| def plugin_config_file | ||
| File.join(@dir, Config::FILE_NAME) |
There was a problem hiding this comment.
To reduce indirection, this line could probably be inlined directly in the plugin_config method (since you don't use it elsewhere).
There was a problem hiding this comment.
I tried to keep as close a PluginGem structure (https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/plugins/linter_gem.rb#L44) but yes it can be inlined; unless we want to test it (which we don't). I can remove it ;)
| # Returns the {SCSSLint::Config} for this directory. | ||
| # | ||
| # This is intended to be merged with the configuration that loaded this | ||
| # plugin. |
There was a problem hiding this comment.
This comment confuses me a little since we use merge_with_default: false below. What is indented to merge, and where does that happen? I don't have a lot of context on how scss-lint configuration works, so excuse me if I'm missing something obvious.
There was a problem hiding this comment.
Plugins are loaded in Config.rb (see https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/config.rb#L235 and https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/plugins.rb). Basically each plugin is loaded and brings its own configuration. Then all those configs are merged into one config and eventually (unless specified otherwise in the main .scss-lint.yml or cli option) merge with the default.yml config. Therefore, each plugin should avoid merging its config from default as it is done at the end of the process.
I borrowed the comment from https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/plugins/linter_gem.rb#L25 for consistency.
There was a problem hiding this comment.
Thanks for the explanation, that makes sense.
|
Hi @trotzig thanks for taking time to review this PR 👍 |
|
Thanks @barraq! I'm waiting to hear back from a person with more context on the setup. I'll get back soon. |
|
Thanks for the contribution @barraq! I'm going to include this in a 0.52.0 release which will be published as soon as I have permissions to push to rubygems.org. |
|
Awesome :D thanks |
|
Okay, it's been released now. |
Description
plugin_directoriesproperty can be used in.scss-lint.ymlto load additional linters from a directory. However it does not allow loading custom.scss-lint.ymlfor such directory.This PR allows loading a custom
.scss-lint.ymlfrom any directory specified inplugin_directoriesand merge it with your existing configuration. This is pretty handy to allow extending your existing configuration from other configuration coming from other non-gem package, e.g. npm, bower, etc.What was done
linter_dir.rbto add loading custom.scss-lint.ymlfunctionality (based onlinter_gem)Note
While
scss-linterallows loading.scss-lint.ymlfile from othergemsit sometimes happen that you need to extend your project config from another.scss-lint.ymlthat is not coming from agembut from another directory or another non-gem package, like npm, bower, etc.Might be related to #516