P.S. Readme is a WIP
Maram (മരം) is a fork of the excellent library mrm with an aim of more active development and adding features. See mrm project status
Command line tool to help you keep configuration (package.json, .gitignore, .eslintrc, etc.) of your open source projects in sync.
- Always be feature and api compatible with mrm or keep one api that is compatible with it
- Stay lean. The project should only have absolutely necessary dependencies
- Doesn’t overwrite your data unless you want to
- Minimal changes: keeps the original file formatting or read the style from EditorConfig
- Minimal configuration: tries to infer configuration from the project itself or from the environment
- Customizable tasks for popular tools like ESLint, Prettier, lint-staged, etc. included
- Custom tasks and tools to work with JSON, YAML, INI, Markdown and new line separated text files
- Sharing tasks via npm and grouping them into presets
Most of the available tools are template based. Template approach works moderately well for new project generation but doesn’t work well for updating. Mrm’s approach is closer to codemods than templates.
Read more in my article, Automating open source project configuration with Mrm, or watch my talk on Mrm.
- Getting started
- Making your own tasks
- Sharing tasks via npm
- Making your own presets
- FAQ
- Utilities to write codemods
These tasks are included by default:
- ci
- codecov
- contributing
- dependabot
- editorconfig
- eslint
- gitignore
- jest
- license
- lint-staged
- package
- prettier
- readme
- semantic-release
- styleguidist
- stylelint
- travis
- typescript
The changelog can be found on the Releases page.
This software has been developed with lots of coffee, buy me one more cup to keep it going.
Bug fixes are welcome, but not new features. Please take a moment to review the contributing guidelines.
Artem Sapegin, Allen Francis and contributors.
MIT License, see the included License.md file.