Getting started with Mrm
Installation
Usage
Print a list available of tasks and aliases:
Run a task or an alias
Run multiple tasks:
Override config options (or run without a config file):
Custom config and tasks folder:
Run a task from a preset (mrm-preset-unicorn npm package, read more about presets):
Usage via npx
You don’t need to install Mrm:
Tasks, aliases, and presets
Task does a single useful thing. For example, adds ESLint to a project. See all official tasks.
To run a task, type:
Alias runs multiple tasks at the same time, one after another. You can add aliases via the config file.
Preset is a shared configuration published as an npm package, read more about presets).
Configuration
There are three ways for setting tasks configurations: interactive mode, command line parameters, and config files.
See tasks docs for available config options on official tasks.
Interactive mode
Use the -i argument to enable interactive/prompt mode:
This will prompt for all ESLint Mrm task options prior to running the task. It will also use command line parameters and config files as defaults for each option.
When to use: use this configuration mode for one-time running Mrm (typically with npx) when you don't know available options upfront and don't want to create a config file.
Command line parameters
You can pass any option as a command line parameters as follows:
This will ultimately set the name config for this single task execution.
When to use: when you know upfront all the configuration names and expected values; when you are running mrm on CI.
Config files
Create ~/.mrm/config.json or ~/dotfiles/mrm/config.json:
When to use: when you often use the same configuration (usually when you scaffold new projects frequently); when you want to define sets of default task aliases.