Skip to content

fix(formatter/sort-imports)!: Change default order to natural with natord crate #15828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graphite-app merged 1 commit into from
Nov 18, 2025
Merged

fix(formatter/sort-imports)!: Change default order to natural with natord crate #15828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/oxc_formatter/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ oxc_syntax = { workspace = true }

cow-utils = { workspace = true }
json-strip-comments = { workspace = true }
natord = "1.0.9"
phf = { workspace = true, features = ["macros"] }
rustc-hash = { workspace = true }
schemars = { workspace = true }
Expand Down
3 changes: 2 additions & 1 deletion crates/oxc_formatter/src/ir_transform/sort_imports/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,8 @@ fn sort_imports(imports: &mut [SortableImport], options: &options::SortImports)
}

// Within the same group, sort by source respecting the order option
let source_ord = imports[a].normalized_source.cmp(&imports[b].normalized_source);
let source_ord =
natord::compare(&imports[a].normalized_source, &imports[b].normalized_source);
if options.order.is_desc() { source_ord.reverse() } else { source_ord }
});

Expand Down
14 changes: 7 additions & 7 deletions crates/oxc_formatter/tests/ir_transform/sort_imports.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import * as c from "c";
import d from "d";
"#,
);
// Alphabetical ASC order by default
// Natural ASC order by default
assert_format(
r#"
import { log } from "./log";
Expand All @@ -49,9 +49,9 @@ import { log2 } from "./log2";
r#"{ "experimentalSortImports": {} }"#,
r#"
import { log } from "./log";
import { log10 } from "./log10";
import { log1p } from "./log1p";
import { log2 } from "./log2";
import { log10 } from "./log10";
"#,
);
// Dynamic imports should not affect sorting
Expand Down Expand Up @@ -612,7 +612,7 @@ import B from "b";

#[test]
fn should_sort_by_order() {
// Z-A
// Z-A (natural order reversed)
assert_format(
r#"
import { log } from "./log";
Expand All @@ -622,13 +622,13 @@ import { log2 } from "./log2";
"#,
r#"{ "experimentalSortImports": { "order": "desc" } }"#,
r#"
import { log10 } from "./log10";
import { log2 } from "./log2";
import { log1p } from "./log1p";
import { log10 } from "./log10";
import { log } from "./log";
"#,
);
// A-Z - default
// A-Z - default (natural order)
assert_format(
r#"
import { log } from "./log";
Expand All @@ -639,9 +639,9 @@ import { log2 } from "./log2";
r#"{ "experimentalSortImports": { "order": "asc" } }"#,
r#"
import { log } from "./log";
import { log10 } from "./log10";
import { log1p } from "./log1p";
import { log2 } from "./log2";
import { log10 } from "./log10";
"#,
);
assert_format(
Expand All @@ -654,9 +654,9 @@ import { log2 } from "./log2";
r#"{ "experimentalSortImports": {} }"#,
r#"
import { log } from "./log";
import { log10 } from "./log10";
import { log1p } from "./log1p";
import { log2 } from "./log2";
import { log10 } from "./log10";
"#,
);
}
Expand Down
Loading