Marmot (mrm)
Command line tool to help you keep dotfiles (.gitignore
, .eslintrc
, etc.) of all your open source project in sync.
Motivation
Most of the available tools are template based. It works moderately well for new project generation but doesn’t work well for updating. Marmot’s approach is closer to codemods than templates.
Installation
npm install -g mrm
Usage
mrm
— Print list of taskmrm <task>
— Run taks
Configuration
Create ~/.mrm/config.json
or ~/dotfiles/mrm/config.json
:
{
"name": "Tobias Müller",
"email": "tobias2000@gmail.com",
"url": "http://tobias2000.io",
"github": "tobias2000",
"aliases": {
"node": ["license", "readme", "contributing", "package", "editorconfig", "eslint", "gitignore"]
}
}
Custom tasks
Create eather ~/.mrm/<taskname>/index.js
or ~/dotfiles/mrm/<taskname>/index.js
. If <taskname>
is the same as one of the internal tasks, then your task will override internal one.
Changelog
The changelog can be found on the Releases page.
Contributing
Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.
Authors and license
Artem Sapegin and contributors.
MIT License, see the included License.md file.