Feat: Configuration via cosmiconfig #34
Conversation
src/index.js
Outdated
| return Object.assign( | ||
| {}, | ||
| getConfigFromFile(directories, filename), | ||
| configFromCosmiconfig || {}, |
There was a problem hiding this comment.
Shouldn't we call getConfigFromCosmiconfig here the same way we do the other two options?
There was a problem hiding this comment.
I wanted call in same way, but config required early in mrm.js for custom dir, preset name.
One call for read config — potentially better performance.
Use only cosmiconfig for read config files — sound good, i try to refactor code.
There was a problem hiding this comment.
For the preset name, I guess you can swap the blocks const options... and const preset....
apoleshchuk
force-pushed
the
feature/cosmiconfig
branch
from
6540fbb
to
e50845d
Compare
bin/mrm.js
Outdated
| searchPlaces: ['config.json'] | ||
| }); | ||
| directories.push(presetDir); | ||
| options = Object.assign({}, presetConfig, options); |
There was a problem hiding this comment.
It's not clearly code, but useful for shareable configs via presets, like aliases or company based configs.
There was a problem hiding this comment.
I'm not sure what this code is doing, could you please add comment?
There was a problem hiding this comment.
Shareable configs via preset useful for teams, sample <preset>/config.json:
{
"emailValidator": "([\\w\\.]+)@corp\\.mail\\.ru",
"any-shareable-config": "some-value",
"aliases": {
"component": ["license", "readme", "editorconfig", "gitignore", "husky"]
}
}as default config for task, that can rewrite by developer config, if needed.
There was a problem hiding this comment.
Could you add some docs for this use case?
|
This seems to have stalled a bit. It seems very useful though. Have these changes already been imported elsewhere, or are we waiting for the requested changes? |
|
@ismay I need to have a look again — I remember I had some doubts how it should work, but don't remember exactly ;-£ What's your use case? Do you have any comments on the implementation? |
Not yet. I need to test mrm out a bit more before I can make any useful comments. But as far as configuration goes I think cosmiconfig is the gold standard, so in my opinion it'd be nice to use it. |
|
I haven't tried MRM in practice yet, but what I am currently trying to achieve is to be able to run a single command without specifying any details and based on a config file within a project it would execute tasks in a custom preset. In the preset repo, I want to have a base config which would have an alias to basically run all available tasks. Additionally, I want to provide a task or something that will utilize some sort of prompt module to configure the project initially. I think it makes sense to go out with the next major version that uses cosmiconfig only. |
Useful for directory based configuration.
Closes #25