@jabworks/prettier-config weekly downloads statistics

@jabworks/prettier-config

Opinionated Prettier configuration with essential plugins for modern JavaScript, TypeScript, and JSON formatting.

Features

• Modern formatting rules optimized for readability and consistency • Plugin integration for enhanced formatting capabilities: • 🎨 Tailwind CSS - Automatic class sorting and optimization • 📦 Package.json - Consistent package.json formatting • 🔤 JSON sorting - Alphabetical key sorting for better diffs • TypeScript support with proper import/export handling • Configurable overrides for different file types

Installation

Peer Dependencies

This package requires the following peer dependencies to be installed:

Usage

Method 1: Prettier Configuration File (Recommended)

Create a prettier.config.mjs file in your project root:

Or using CommonJS:

Method 2: Package.json

Add to your package.json:

Note: This method doesn't support extending or customizing the configuration.

Method 3: Custom Configuration

Extend the base configuration with your own rules:

Configuration Details

This configuration includes the following settings:

Formatting Rules

Plugins

• prettier-plugin-tailwindcss: Automatically sorts Tailwind CSS classes • prettier-plugin-sort-json: Sorts JSON object keys alphabetically (except package.json) • prettier-plugin-packagejson: Formats package.json with standard key order

File-Specific Overrides

• JSON files (excluding package.json): Uses prettier-plugin-sort-json for key sorting • Package.json files: Uses prettier-plugin-packagejson for standard formatting

Examples

Before/After Formatting

JavaScript/TypeScript:

JSON:

Tailwind CSS:

IDE Integration

VS Code

1. Install the Prettier extension 2. Add to your VS Code settings:

Scripts

Add these scripts to your package.json:

Compatibility

• Prettier: >=3.8.1

License

MIT

Contributing

This package is part of the @jabworks style guide monorepo. Please refer to the main repository for contribution guidelines.