trivago/prettier-plugin-sort-imports
Prettier Plugin Sort Imports
This project is a Prettier plugin designed to alphabetize, group, and format module import statements in JavaScript and TypeScript files. It functions as an automated import organizer that ensures consistent declaration order and spacing across a project.
The plugin uses custom regular expression patterns to sequence dependency imports into logical groups, allowing for the separation of internal and external modules. It supports the preservation of side-effect imports and provides the ability to sort individual named members within a single declaration by string length or alphabetization.
Users can configure sorting behavior through case-sensitivity toggles and use comment markers to exclude specific files or statements from being reorganized. The tool also manages visual separation by inserting new lines between defined import groups.
Features
- Prettier Plugins - Functions as an extension for the Prettier formatter to introduce custom import sorting and formatting rules.
- Import Grouping - Categorizes import statements into logical blocks by matching declaration strings against custom regular expressions.
- Automated Import Sorting - Uses a consistent rule set to arrange third party and internal modules automatically.
- Import Organizers - Automatically sorts and manages JavaScript import statements to maintain a clean project structure.
- Import Sorters - Provides an automated formatter that sequences dependency imports into groups using regular expressions.
- Custom Sorting Patterns - Organizes import declarations based on custom regular expression patterns for third-party and builtin modules.
- TypeScript Import Management - Organizes TypeScript imports into logical groups using regular expressions to improve readability.
- Regex-Based Grouping - Sequences import statements into specific groups based on user-defined regular expressions.
- AST-Based Code Manipulation - Implements import rearrangement by modifying the abstract syntax tree before the final code generation phase.
- Formatting Opt-Out Mechanisms - Allows bypassing the import sorting process for specific files or statements using dedicated comment markers.
- Import Exclusion Markers - Prevents the reorganization of imports in specific files or lines using dedicated comment markers.
- Position Preservation - Maintains the original position of side-effect imports while sorting other declarations around them.
- Declaration Sorting - Enforces alphabetical or length-based ordering of individual named imports within a single declaration block.
- Specifier Sorting - Sorts individual named members within a single import declaration by string length or alphabetization.
- JavaScript and TypeScript Formatting - Ensures consistent import declaration order and spacing across TypeScript project files.
