Registry / devops / prettier-config-carbon

prettier-config-carbon

library0.12.0jsnpmunverified

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.

devops testing

npm install prettier-config-carbon

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PRETTIER-CONFIG-CA

prettier-config-carbon

devopsjavascriptv0.12.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

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

✗ import prettierConfig from 'prettier-config-carbon';

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

default (ESM)

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

✗ import prettierConfig from 'prettier-config-carbon';

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

prettier.config.js

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

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

Spread is unnecessary; just assign the resolved value.

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 };

Debug

Known issues

gotchaCommonJS-only: package does not provide an ESM export.

fix

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

affects: >=0.1.0

deprecatedVersion 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.

affects: >=0.1.0

gotchaThe 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.

affects: >=0.1.0

Errors

Common errors & fixes

Cannot find module 'prettier-config-carbon'

Package not installed or not in node_modules.

fix

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

Error: Cannot find module 'prettier'

Prettier peer dependency not installed.

fix

Run npm install --save-dev prettier

Unexpected token 'export'

Using ES import syntax with CommonJS require.

fix

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

Upgrade

Version history

0.12.0latest on npm

Audit

Dependencies

prettierrequiredpeer dependency, required as runtime formatter

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/carbon-design-system/carbon ↗

packagehttps://www.npmjs.com/package/prettier-config-carbon ↗

homepagehttps://carbondesignsystem.com ↗