prettier-config-carbon

0.12.0 verified Sat Apr 25 auth: no javascript

Prettier configuration preset for the Carbon Design System by IBM, currently at version 0.12.0 (stable). Release cadence is irregular as part of the carbon monorepo. It provides a shared Prettier rule set that enforces consistent code formatting across Carbon projects. Peer dependency on Prettier 3.x. Differentiator: official preset from the Carbon Design System team, ensuring alignment with IBM Carbon coding standards.

Common errors

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

cause Package not installed or not in node_modules.

fix

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

error Error: Cannot find module 'prettier' ↓

cause Prettier peer dependency not installed.

fix

Run npm install --save-dev prettier

error Unexpected token 'export' ↓

cause Using ES import syntax with CommonJS require.

fix

Use const prettierConfig = require('prettier-config-carbon'); instead of import.

Warnings

gotcha CommonJS-only: package does not provide an ESM export. ↓

fix Use require() or import with assertion if using ESM.

deprecated Version 0.x: package is still in pre-major development and may introduce breaking changes without major version bump. ↓

fix Pin to exact version and test after updates.

gotcha The package does not export a function; it exports a static object. If you try to call it as a function, it will fail silently. ↓

fix Do not invoke; use as object assignment.

Install

npm install prettier-config-carbon

yarn add prettier-config-carbon

pnpm add prettier-config-carbon

Imports

default

wrong

import prettierConfig from 'prettier-config-carbon';

correct

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

Package ships as CommonJS only, not ESM. Use require().

default (ESM)

wrong

import prettierConfig from 'prettier-config-carbon';

correct

import prettierConfig from 'prettier-config-carbon' assert { type: 'json' };

If using ESM, you can import the JSON export with assertion. No named exports.

prettier.config.js

wrong

module.exports = { ...require('prettier-config-carbon') };

correct

module.exports = require('prettier-config-carbon');

Spread is unnecessary; just assign the resolved value.

Quickstart

How to install and use prettier-config-carbon as a shared configuration in your project.

// install: npm install --save-dev prettier prettier-config-carbon
// prettier.config.js:
'use strict';
const prettierConfig = require('prettier-config-carbon');
module.exports = prettierConfig;
// To extend or override:
module.exports = {
  ...prettierConfig,
  semi: false
};