editor.action.sortLinesAscending has confusing sort order for symbols
See original GitHub issueWhen sorting lines using editor.action.sortLinesAscending
(“Sort Lines Ascending” via the Command Palette) the lines are sorted in a very strange order when the comparison involves a symbol character.
I would expect that .
(period) would be sorted before _
(underscore) because in ASCII, period is 46 and underscore is 95.
However, vscode uses localeCompare
as its sorting method (see sortLinesCommand.ts:76), which results in underscore being sorted before period. See the repro steps below for an example.
I saw a previous issue regarding this (#15516) but it was closed because the ASCII ordering was in fact correct. In the case I’ve outlined below, the ordering is not correct.
I’m not sure what the correct solution would be but I think that for ASCII symbols, ASCII ordering should be obeyed. I do realise that “Sort Lines Ascending” is an ambiguous term - ascending according to what criteria? - so perhaps the command could be renamed to something more specific, or you could provide different default sorting options.
- VSCode Version: 1.22.1 Commit 950b8b0d37a
- OS Version: Windows 10 Enterprise Version 1709 OS Build 16299.371
Steps to Reproduce:
- Copy the following into a new file:
a_b.txt
a_b_c.txt
-
Highlight the file contents.
-
Open the Command Palette and select “Sort Lines Ascending”.
Expected:
The file is sorted in the following order:
a_b.txt
a_b_c.txt
Actual:
The file is sorted in the following order:
a_b_c.txt
a_b.txt
Does this issue occur when all extensions are disabled?: Yes
Issue Analytics
- State:
- Created 5 years ago
- Reactions:30
- Comments:9 (2 by maintainers)
Top GitHub Comments
Thanks for your response - interesting that the editor uses the same sort as the UI!
I use the sort function most often to sort lines in code, which usually contain only ASCII characters. The issue I (personally) have with the current vscode sort function is that when I pipe the file content into other utilities, those utilities expect lines to be in ASCII order.
Regarding the sorting of files in vscode’s explorer, Windows explorer sorts the files as I would expect:
Sorting in ASCII order is beneficial as shorter filenames are placed before longer ones.
Since this is supposed to be a general sort & is also applied to UI elements, it’s difficult to come up with a one-size-fits-all solution. Personally, I would introduce two settings:
sorting.method
(or similar) which allows the options:ascii
, for sorting code / lists of files.localeCompare
, for sorting general text which may contain unicode characters, etc.sorting.caseSensitivity
(or similar) which allows the options:caseInsensitive
, values converted to lowercase before comparisoncaseSensitive
, values compared without modificationPerhaps these settings could be separate from the sorting in the explorer, e.g.
editor.sorting.method
vs.explorer.sorting.method
.I’m currently sorting a very long YAML file in order for it to pass yamllint configured to enforce lexical sorting of keys. This issue is of interest to me because currently Code’s idea of a lexical sort and
yamllint
’s idea differ in the area of underscores:After Code
editor.action.sortLinesAscending
:yamllint output: