0.0.1-alpha.1 • Published 6 months ago
prettier-plugin-align v0.0.1-alpha.1
prettier-plugin-align
A Prettier plugin for aligning enums, switch statements, and other structured code elements for better readability.
✨ Features
- Aligns
enum
definitions for better readability - Formats
switch
statements to aligncase
statements properly - Ensures consistent formatting without breaking Prettier’s rules
📦 Installation
Using npm:
npm install --save-dev prettier-plugin-align
Using Yarn:
yarn add -D prettier-plugin-align
Using pnpm:
pnpm add -D prettier-plugin-align
🚀 Usage
With Prettier CLI
prettier --plugin=prettier-plugin-align --write "**/*.ts"
In .prettierrc.json
Add the plugin to your Prettier config:
{
"plugins": ["prettier-plugin-align"]
}
🎯 Example Formatting
Before:
enum Status {
Pending,
InProgress = "IN_PROGRESS",
Done = "DONE"
}
switch (status) {
case Status.Pending: return "Pending"
case Status.InProgress: return "In Progress"
case Status.Done: return "Done"
}
After:
enum Status {
Pending = "PENDING",
InProgress = "IN_PROGRESS",
Done = "DONE"
}
switch (status) {
case Status.Pending: return "Pending"
case Status.InProgress: return "In Progress"
case Status.Done: return "Done"
}
🛠 Configuration
This plugin respects your existing Prettier settings.
You can configure Prettier using .prettierrc.json
, .prettierrc.js
, or via CLI flags.
🧪 Running Tests
To run the test suite:
npm test
📜 License
This project is licensed under the MIT License.
0.0.1-alpha.1
6 months ago