Web Scrobbler Prettier Config

0.1.0 verified Sat Apr 25 auth: no javascript

A shared Prettier configuration used across Web Scrobbler projects. Version 0.1.0 is the initial release. Extends Prettier's standard config with project-specific rules. Designed for projects within the Web Scrobbler ecosystem. Requires Prettier >=2 as a peer dependency. Supports ESM and CJS via .prettierrc.* or package.json.

Common errors

error Failed to resolve config: prettier-config-web-scrobbler ↓

cause Prettier peer dependency not installed.

fix

Run: npm install --save-dev prettier

error Cannot find module 'prettier-config-web-scrobbler' ↓

cause Package not installed or missing from devDependencies.

fix

Run: npm install --save-dev prettier-config-web-scrobbler

error Config must be a JSON object when specified in package.json ↓

cause Invalid format in package.json 'prettier' field.

fix

Set 'prettier' to a string: "prettier-config-web-scrobbler"

Warnings

gotcha The exported config is not a JavaScript object but a string reference; cannot import directly. ↓

fix Use the 'extends' mechanism in .prettierrc or via package.json instead of trying to import it as a module.

breaking Requires Prettier >=2; incompatible with Prettier 1.x. ↓

fix Update Prettier to version 2 or later.

gotcha No TypeScript types exported; config is a plain string. ↓

fix Not an issue - no types needed for string-based config.

deprecated This package is intended for Web Scrobbler projects only; external usage not recommended. ↓

fix Consider using your own custom config or a more generic shared config.

Install

npm install prettier-config-web-scrobbler

yarn add prettier-config-web-scrobbler

pnpm add prettier-config-web-scrobbler

Imports

prettier-config-web-scrobbler
wrong
```
{
  "prettier": "prettier-config-web-scrobbler"
}
```
correct
```
{
  "prettier": "prettier-config-web-scrobbler"
}
```
Configuration is loaded via package.json "prettier" field or .prettierrc extends.

prettier-config-web-scrobbler

wrong

{
  "extends": ["prettier-config-web-scrobbler"]
}

correct

{
  "extends": "prettier-config-web-scrobbler"
}

In .prettierrc, use a string for extends, not an array.

prettier-config-web-scrobbler
wrong
```
{
  "prettier": {
    "extends": "prettier-config-web-scrobbler"
  }
}
```
correct
```
{
  "prettier": "prettier-config-web-scrobbler"
}
```
In package.json, set the 'prettier' field directly to the string 'prettier-config-web-scrobbler'.

Quickstart

Install and configure the shared Prettier config in a project.

// In package.json:
{
  "name": "my-project",
  "version": "1.0.0",
  "devDependencies": {
    "prettier": "^2.0.0",
    "prettier-config-web-scrobbler": "^0.1.0"
  },
  "prettier": "prettier-config-web-scrobbler"
}

// Then run:
// npx prettier --check .