prettier-config-atomic

4.0.0 verified Sat Apr 25 auth: no javascript

A shareable Prettier configuration for the atom-community ecosystem. Current stable version is 4.0.0, released as ESM TypeScript and requiring Prettier v3.0+. Supports formatting for TypeScript, JavaScript, JSON, YAML, Markdown, and MDX. Active development with periodic dependency updates. Differentiators: provides a complete opinionated preset for atom-community projects, including plugin support for JSDoc.

Common errors

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

cause Package not installed or not in devDependencies.

fix

npm install --save-dev prettier-config-atomic

error TypeError: config is not a function ↓

cause Using require() for an ESM-only package (v4+).

fix

Use import or change to CJS-compatible version (v3.x) or use dynamic import.

error Error: Invalid configuration file: prettier.config.js ↓

cause Exporting an object directly instead of using require/import.

fix

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

error Could not find a config file for Prettier ↓

cause The prettier key in package.json is missing or misspelled.

fix

Add "prettier": "prettier-config-atomic" to package.json.

Warnings

breaking v4.0.0 converted the package to ESM TypeScript, making it import-only. require() will fail. ↓

fix Use import config from 'prettier-config-atomic' or set type: 'module' in package.json.

breaking v4.0.0 requires Prettier v3.0+. Older Prettier versions are incompatible. ↓

fix Upgrade prettier to v3.0.0 or later.

gotcha If using pnpm, the bundled prettier is not hoisted automatically unless public-hoist-pattern is configured. ↓

fix Add public-hoist-pattern[]=* to .npmrc or install prettier explicitly.

deprecated v3.x used CJS and supported Prettier v2. It is now deprecated in favour of v4. ↓

fix Upgrade to v4.0.0 and migrate imports.

gotcha The config includes prettier-plugin-jsdoc as a dependency; ensure it is installed for JSDoc formatting. ↓

fix The plugin is bundled, but if using pnpm without hoisting, install it explicitly.

Install

npm install prettier-config-atomic

yarn add prettier-config-atomic

pnpm add prettier-config-atomic

Imports

default

wrong

const config = require('prettier-config-atomic')

correct

import config from 'prettier-config-atomic'

ESM-only since v4.0.0. Use .mjs or type: module.

default

wrong

import config from 'prettier-config-atomic'; module.exports = config

correct

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

CJS require still works in legacy setups, but ESM import is the recommended approach for Node >= 14.

default
```
// .prettierrc
"prettier-config-atomic"
```
Simplest usage: reference the package name directly in prettierrc.

Quickstart

Install and configure prettier-config-atomic with scripts and ignore file.

// Install
npm install --save-dev prettier-config-atomic prettier

// Add to package.json
"prettier": "prettier-config-atomic",
"scripts": {
  "format": "prettier --write .",
  "test.format": "prettier . --check"
}

// Optional: .prettierignore
node_modules
pnpm-lock.yaml
package-lock.json
CHANGELOG.md
dist