MX Shared Prettier Config

1.0.0 verified Sat Apr 25 auth: no javascript maintenance

A shared Prettier configuration package published by MX Technologies. Version 1.0.0, last updated in 2019. It provides a baseline set of formatting rules for projects within the MX ecosystem. The package is minimal, expecting Prettier 1.19.1 as a peer dependency. Its main differentiator is being a simple reusable config for consistency across MX projects, but it has not been updated since its initial release, and no longer works with modern Prettier versions (>1.19.1).

Common errors

error Cannot find module 'prettier-config-mx' ↓

cause Package not installed or missing in node_modules

fix

Run npm install prettier-config-mx --save-dev

error Invalid configuration file: "prettier" field must be a string or object ↓

cause Incorrect usage in package.json

fix

Set "prettier": "prettier-config-mx" (as a string)

Warnings

gotcha Package requires Prettier 1.19.1; incompatible with Prettier v2+ ↓

fix Downgrade Prettier to 1.19.1 or avoid using this config with newer versions.

deprecated No updates since 2019; consider using official @prettier/config package ↓

fix Replace with '@prettier/plugin-*' or maintain a fork.

gotcha CommonJS only; no ESM export available ↓

fix Use require() instead of import.

Install

npm install prettier-config-mx

yarn add prettier-config-mx

pnpm add prettier-config-mx

Imports

prettier-config-mx

wrong

import prettierConfig from 'prettier-config-mx';

correct

const prettierConfig = require('prettier-config-mx');

CommonJS only; no ESM export. Named export does not exist.

prettierrc.js (extend)

wrong

module.exports = {
  extends: ['prettier-config-mx']
};

correct

module.exports = {
  ...require('prettier-config-mx'),
  semi: false
};

Do not use 'extends'; spread the config object instead.

package.json "prettier" field

wrong

"prettier": { "extends": "prettier-config-mx" }

correct

"prettier": "prettier-config-mx"

Use a string, not an object with extends.

Quickstart

Installs Prettier and the shared config, then applies it via the package.json prettier field.

{
  "name": "my-project",
  "version": "1.0.0",
  "devDependencies": {
    "prettier": "1.19.1",
    "prettier-config-mx": "1.0.0"
  },
  "prettier": "prettier-config-mx"
}