Java Sorter (Eclipse Style)
English | 中文
VS Code Extension: Sorts class members of Java files without formatting them. The sorting rules are consistent with Eclipse's "Sort Members" feature.
Sorting Rules
By default, the global physical ordering of class members is (strictly matching Eclipse defaults):
- Nested Types (classes/interfaces/enums) ➡️ Sorted at the very top.
- Static Fields / Instance Fields (macro-grouped together, keeping relative original order inside).
- Static Initializers / Instance Initializers (macro-grouped together, keeping relative original order inside).
- Static Methods / Constructors / Instance Methods (grouped and sorted).
| Member Type |
Sorted by Default |
Sorting Method |
| Fields (fields) |
❌ No |
Macro-grouped together, keeping relative original order inside (sorted inside if sortAllMembers is true) |
| Constants (enum constants) |
❌ No |
Macro-grouped together, keeping relative original order inside (sorted inside if sortAllMembers is true) |
| Initializers (initializers) |
❌ No |
Macro-grouped together, keeping relative original order inside (static blocks sorted before instance blocks if sortAllMembers is true) |
| Constructors (constructors) |
✅ Yes |
Ascending parameter count ➡️ Alphabetical |
| Static Methods (staticMethods) |
✅ Yes |
Alphabetical by default (sorted by visibility if visibilityOrder is configured) |
| Instance Methods (methods) |
✅ Yes |
Alphabetical by default (sorted by visibility if visibilityOrder is configured) |
| Nested Types (types) |
✅ Yes |
Static first ➡️ Class ➡️ Interface ➡️ Enum ➡️ Alphabetical |
- Annotations and Javadoc comments preceding a member will move with it.
- Nested class members remain untouched and move as a whole with the outer class.
- Getter/setter methods receive no special treatment.
- You can customize all sorting toggles and detailed rules in VS Code Settings to fit your personal or team style.
Installation & Build
1. Build & Package Commands
Run the following commands in the project root directory:
Package VSIX (without global vsce installation):
npm install
npm run package
(This will compile TypeScript and generate the vscode-java-sorter-${version}.vsix package in the root directory)
Clean Build Output:
npm run clean
(Removes the out/ output directory and all .vsix packages)
Compile Locally:
npm run compile
2. Manual Installation
After packaging the .vsix file, you can install it directly via the VS Code interface:
- Open the VS Code Command Palette (
Ctrl+Shift+P).
- Search and select
Extensions: Install from VSIX....
- Choose the generated
vscode-java-sorter-${version}.vsix file to complete the installation.
- Reload the VS Code Window (
Developer: Reload Window) to apply changes.
Usage
- Open a Java file.
- Open the Command Palette (
Ctrl+Shift+P), search for "Java Sorter: Sort Members".
- Execute the command to sort class members.
Keyboard Shortcut Configuration
No default shortcut is pre-configured. You can bind one yourself:
- Open
File -> Preferences -> Keyboard Shortcuts.
- Search for
vscode-java-sorter.sort-members.
- Click the edit button and press your preferred key combination (e.g.,
Ctrl+Shift+S).
Extension Settings
Open VS Code Settings (Ctrl+,) and search for javaSorter to customize:
| Setting |
Type |
Default |
Description |
javaSorter.memberOrder |
string[] |
["types", "staticFields", "staticInitializers", "staticMethods", "fields", "initializers", "constructors", "methods"] |
Specifies the physical sorting order of different member categories (highest priority at index 0). |
javaSorter.visibilityOrder |
string[] |
[] |
Specifies the sorting order of member visibilities within each group (e.g., ["public", "protected", "package", "private"]). Leave empty to skip visibility sorting and use pure alphabetical order. |
javaSorter.sortAllMembers |
boolean |
false |
Whether to sort all class members. If false (default), fields, enum constants, and initializers remain in their original positions. |
Technical Details
- High-Fidelity Layout Preservation: Perfectly preserves preceding comments (Javadoc, multi-line/single-line comments), leading indents, and original line spacings. It guarantees that the code formatting will not be cluttered or stuck together after sorting.
- Eclipse Compatibility: Aligns with the default sorting and priority logic of Eclipse JDT "Sort Members" feature.
- System Integration: Rewrites files based on the standard VS Code
WorkspaceEdit API, integrating seamlessly with VS Code's native Undo/Redo mechanisms.
License
This project is open-source under the MIT license.
For third-party dependency licenses, please refer to THIRD-PARTY-NOTICES.
| |
