goe-common-prettier

1.0.0 verified Sat Apr 25 auth: no javascript

Shared Prettier configuration for all go-e Labs front-end projects. Version 1.0.0, published as an npm package. Designed to enforce consistent code formatting across multiple projects within the organization, reducing bikeshedding on style. Intended for internal use only; no customization or extensibility is provided.

Common errors

error Error: Could not find config file for prettier. ↓

cause Missing or incorrect prettier config path.

fix

Ensure 'prettier' field in package.json is exactly 'goe-common-prettier'.

error [prettier] Ignoring unknown option / property ↓

cause Conflicting prettier config exists (e.g., .prettierrc.js).

fix

Remove any other prettier configuration files.

Warnings

gotcha The package name is 'goe-common-prettier' but the README misspells 'devDependencies' as 'devDependecies'. ↓

fix Ignore the typo; install as devDependency normally.

Install

npm install goe-common-prettier

yarn add goe-common-prettier

pnpm add goe-common-prettier

Imports

goe-common-prettier as config

wrong

Using require('goe-common-prettier') in a .prettierrc.js file

correct

Add "prettier": "goe-common-prettier" to package.json

This package is a shareable config string, not a module to import.

Quickstart

Installing the shared Prettier config and setting it in package.json to apply consistent formatting.

// 1. Install
npm install --save-dev goe-common-prettier

// 2. In package.json, add:
{
  "prettier": "goe-common-prettier"
}

// 3. Remove any existing .prettierrc.js, .prettierrc, or prettier config in package.json

// 4. Format all files:
// npx prettier --write .