prettier-config-zillow

1.3.0 verified Sat Apr 25 auth: no javascript

Zillow's base Prettier config following their code conventions. Version 1.3.0 requires Node >= 8.9.0. This package provides a shareable Prettier configuration for consistent formatting across Zillow projects. It is intended to be extended in your own .prettierrc file. The config is stable and follows Zillow's JavaScript style guide. Regular updates align with changes in Prettier itself.

Common errors

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

cause Missing or incorrectly installed package, or Prettier cannot resolve the config package.

fix

Run npm install --save-dev prettier prettier-config-zillow and ensure node_modules is not corrupted.

error Invalid config: [Error] Cannot read config file: /path/to/.prettierrc.json Invalid JSON ↓

cause The .prettierrc.json file is not valid JSON.

fix

Make sure the file contains exactly a string: "prettier-config-zillow". No commas or extra syntax.

error Error: Couldn't resolve config 'prettier-config-zillow' from the current working directory. ↓

cause Prettier is not running in the root of the project where the config is installed, or the package is not in node_modules.

fix

Run Prettier from the project root or specify a correct config path with --config.

Warnings

gotcha This package likely doesn't update automatically with new Prettier versions. ↓

fix Check for updates to prettier-config-zillow when upgrading Prettier, as rule options or defaults may change.

gotcha If you extend this config in a .prettierrc file, ensure the file is valid JSON (e.g., no trailing commas). ↓

fix Use .prettierrc.js or .prettierrc.yaml to avoid JSON strictness.

deprecated Node 8.9.0 support may eventually be dropped. ↓

fix Upgrade to Node >=10 or later for future compatibility.

Install

npm install prettier-config-zillow

yarn add prettier-config-zillow

pnpm add prettier-config-zillow

Imports

prettier-config-zillow
```
module.exports = require('prettier-config-zillow');
// or in .prettierrc.json:
"prettier-config-zillow"
```
This package is a shareable config. Use it by referencing the package name in your Prettier config file under 'prettier' key or by requiring it in a JavaScript config file.

override

wrong

// Using spread without require (false assumption you can import JSON)
// Or mixing with other config objects incorrectly.

correct

// .prettierrc.js
module.exports = {
  ...require('prettier-config-zillow'),
  semi: false
};

To override specific options, spread the config into a new object and override properties. Do not modify the package directly.

Quickstart

Shows how to install and use prettier-config-zillow as a shareable Prettier config, including optional overrides.

// 1. Install
npm install --save-dev prettier prettier-config-zillow

// 2. Create .prettierrc.json in project root:
"prettier-config-zillow"

// 3. Alternatively, use .prettierrc.js for overrides:
module.exports = {
  ...require('prettier-config-zillow'),
  singleQuote: true
};