prettier-config-norton

1.2.2 verified Sat Apr 25 auth: no javascript

Prettier shareable config for W.W. Norton & Company. Version 1.2.2 is the latest stable release. The package is part of a monorepo of style configs for Norton code style. It aligns with Airbnb style guides but overrides defaults: print width 100, tabs over spaces, single quotes, always arrow parens, trailing commas all. Requires Prettier ^2.0.0 as a peer dependency. Alternative to @company/prettier-config or prettier-config-standard, opinionated for Norton projects. Low release cadence, last updated March 2022.

Common errors

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

cause The package is not installed or not in node_modules.

fix

Run npx install-peerdeps --dev prettier-config-norton or install manually: npm install --save-dev prettier-config-norton prettier.

error Invalid configuration: "prettier-config-norton" is not a valid configuration ↓

cause Using old Prettier version (<2.0.0) that does not support string config references.

fix

Upgrade Prettier to ^2.0.0.

Warnings

gotcha Prettier does not support 'extends' like ESLint. You must spread the config object to override rules. ↓

fix Use module.exports = { ...require('prettier-config-norton'), semi: false } in .prettierrc.js.

gotcha The package requires Prettier ^2.0.0 as a peer dependency. Prettier v3 is not compatible. ↓

fix Use Prettier v2.x with this config, or look for an updated version supporting v3.

gotcha Using require('prettier-config-norton') as the config value (instead of string) may cause issues depending on how Prettier resolves it. ↓

fix Set config as string 'prettier-config-norton' in package.json or .prettierrc.

Install

npm install prettier-config-norton

yarn add prettier-config-norton

pnpm add prettier-config-norton

Imports

prettier-config-norton
wrong
```
module.exports = require('prettier-config-norton');
```
correct
```
module.exports = 'prettier-config-norton';
```
Prettier shareable configs can be specified as a string in package.json or .prettierrc. For extending, use spread: ...require('prettier-config-norton').
prettier-config-norton (ESM)
wrong
```
const config = require('prettier-config-norton'); module.exports = config;
```
correct
```
import config from 'prettier-config-norton'; export default config;
```
Prettier config files in ESM still commonly use CommonJS exports, but with ESM config you can import and re-export.

prettier-config-norton (extending)

wrong

module.exports = { extends: 'prettier-config-norton', semi: false };

correct

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

Prettier does not support 'extends'; you must spread the config object.

Quickstart

Installs prettier-config-norton and its peer dependency Prettier, sets the config in package.json, then checks formatting.

npx install-peerdeps --dev prettier-config-norton
echo '{"prettier": "prettier-config-norton"}' >> package.json
npx prettier --check .