Nested Public Modules

    mrm-preset-rmr

    2.4.1 • Public • Published

    RMR auto config

    Commitizen friendly Conventional Commits code style: prettier

    Readme

    Create and update config files in any project.

    Installation

    npm install -g mrm mrm-preset-rmr
    # or 
    yarn global add mrm mrm-preset-rmr

    Usage

    1. Commit all changes
    2. Show all available tasksmrm --preset rmr
    3. Run all RMR tasks — run mrm --preset rmr all inside project directory
    4. Run specific taskmrm --preset rmr rmr-commits
    5. Review changed files and fix if has inconsistency or wrong order

    Configuration

    {
      "readmeFile": "README.md"
    }

    Available tasks

    1. rmr-commits - add commit script, install commitlint, commitizen, husky, with conventional-commit, create .commitlintrc.json, .huskyrc, add badges to README.md. Uses readmeFile from options.
    2. rmr-editorconfig - add .editorconfig with rules for * and *.md
    3. rmr-gitignore - add .gitignore from template for node,linux,macos,windows,visualstudiocode
    4. rmr-linting - install eslint with [@atomix/eslint-config], add lint npm-script.
      • If react is found, install configs for react.
      • If typescript is found, install @typescript-eslint
      • Modifies .eslintrc.json. Modifies .lintstagedrc.
    5. rmr-prettier - add format script, install prettier, lint-staged, husky, create .prettierrc, .huskyrc, .lintstagedrc, add badge to README.md. Uses readmeFile from options.

    How to create your own package

    Guide: https://github.com/sapegin/mrm-core, https://github.com/sapegin/mrm#custom-presets

    Install

    npm i mrm-preset-rmr

    DownloadsWeekly Downloads

    3

    Version

    2.4.1

    License

    ISC

    Unpacked Size

    10.4 kB

    Total Files

    14

    Last publish

    Collaborators

    • sergeysova