@sylphlab/prettier-config

Overview

Shared Prettier configuration for SylphLab projects. This package provides a consistent code formatting style across all SylphLab projects.

Features

• Consistent Code Formatting: Enforces a uniform code style across projects
• Modern Defaults: Uses modern Prettier settings and conventions
• Import Organization: Includes plugins for organizing imports and package.json files
• Ready-to-use: Simple to install and integrate into any project

Installation

1npm install --save-dev prettier @sylphlab/prettier-config
2# OR
3yarn add --dev prettier @sylphlab/prettier-config
4# OR
5pnpm add --save-dev prettier @sylphlab/prettier-config

Usage

Option 1: Reference in package.json (Recommended)

Add the following to your package.json:

1{
2  "prettier": "@sylphlab/prettier-config"
3}

Option 2: Prettier Configuration File

Create a .prettierrc.js file:

1import sylphPrettierConfig from '@sylphlab/prettier-config';
2
3export default {
4  ...sylphPrettierConfig,
5  // Your project-specific overrides
6};

Option 3: Extending the Configuration (CommonJS)

If you need to use a CommonJS-compatible configuration:

1// .prettierrc.cjs
2const sylphPrettierConfig = require('@sylphlab/prettier-config');
3
4module.exports = {
5  ...sylphPrettierConfig,
6  // Your project-specific overrides
7};

Configuration Options

This configuration includes:

• 100 character print width
• 2 space indentation
• Single quotes
• Trailing commas
• LF line endings
• Organized imports
• Formatted package.json files

License

MIT © SylphLab