mrm-task-prettier

5.1.22 verified Sat Apr 25 auth: no javascript

Mrm task that adds Prettier to a project. Version 5.1.22 is the latest stable release as of September 2023, with releases tied to the main mrm monorepo. It automatically creates .prettierrc config, adds npm scripts for formatting, and installs Prettier and related dependencies. Options include indent, prettierOptions, prettierOverrides, and prettierPattern. It infers settings from EditorConfig if available. Compared to manual Prettier setup, this task integrates with the Mrm ecosystem for streamlined project scaffolding across multiple tools.

Common errors

error Cannot find module 'mrm-task-prettier' ↓

cause Package not installed globally or locally.

fix

Run npm install -g mrm-task-prettier or npx mrm prettier.

error Error: Cannot find module 'mrm-core' ↓

cause Missing mrm-core peer dependency.

fix

Install mrm-core: npm install mrm-core --save-dev

Warnings

breaking Breaking changes in mrm-core may affect this task; maintain lockfile for mrm versions >=4. ↓

fix Use npx mrm@4 prettier to lock mrm version.

deprecated Node <10.13 is no longer supported for mrm-task-prettier 5.x. ↓

fix Upgrade Node to >=10.13.

gotcha Prettier options may be overridden by existing .editorconfig; ensure consistent indentation settings. ↓

fix Set indent option explicitly or use mrm task options prettierOptions.

Install

npm install mrm-task-prettier

yarn add mrm-task-prettier

pnpm add mrm-task-prettier

Imports

task

wrong

const mrmTaskPrettier = require('mrm-task-prettier').task;

correct

import { task } from 'mrm-task-prettier';

ESM-only; node >= 10.13

default

wrong

const mrmTaskPrettier = require('mrm-task-prettier');

correct

import mrmTaskPrettier from 'mrm-task-prettier';

Default export for usage with mrm

Quickstart

Run npx mrm prettier to set up Prettier, then execute npm run format to format code.

npx mrm prettier
# After running, format code:
npm run format