Skip to content
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.

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

Feature: drop javascript-natural-sort dep #28

Merged
merged 3 commits into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@
"@babel/parser": "^7.17.7",
"@babel/traverse": "^7.17.3",
"@babel/types": "^7.17.0",
"javascript-natural-sort": "0.7.1",
"lodash.clone": "^4.5.0",
"lodash.isequal": "^4.5.0"
},
Expand Down
26 changes: 26 additions & 0 deletions src/natural-sort/__tests__/natural-sort.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { expect, test } from 'vitest';

import { naturalSort } from '..';

test('should sort normal things alphabetically', () => {
expect(
['a', 'h', 'b', 'i', 'c', 'd', 'j', 'e', 'k', 'f', 'g'].sort((a, b) =>
naturalSort(a, b),
),
).toEqual(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k']);
});

test('should ignore capitalization differences', () => {
// We have no option to cause case-sensitive sorting, so this is the "default" case!
expect(
['./ExampleView', './ExamplesList'].sort((a, b) => naturalSort(a, b)),
).toEqual(['./ExamplesList', './ExampleView']);
});

test('should sort things numerically', () => {
expect(
['a2', 'a3', 'a10', 'a1', 'a11', 'a9'].sort((a, b) =>
naturalSort(a, b),
),
).toEqual(['a1', 'a2', 'a3', 'a9', 'a10', 'a11']);
});
13 changes: 11 additions & 2 deletions src/natural-sort/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
import naturalSort from 'javascript-natural-sort';
export function naturalSort(a: string, b: string): number {
const left = typeof a === 'string' ? a : String(a);

export { naturalSort };
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#syntax
const sortOptions: Intl.CollatorOptions = {
sensitivity: 'base',
numeric: true,
caseFirst: 'lower',
};

return left.localeCompare(b, 'en', sortOptions);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking out loud. Are we certain we always want to sort by english locale? I think so, because otherwise users working together on a shared project in different locales could cause formatting churn.

Copy link
Collaborator Author

@fbartho fbartho Jun 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the time when I wrote this, I thought that we could hardcode ‘en’ because I was only considering detecting locale relevant here for currency, dates, and numeric separators. Of those, I only cared about the numeric separators: 1,000.00 vs 1.000,00 — and I arbitrarily assumed that those (separators) were irrelevant for js module names, and irrelevant for file names. (Implying we only really care about sorting short integers at the beginning or end of file names)

Further research shows that the locale actually affects how accented characters sort related to lower/uppercase letters.

I think it’d be fair to argue one of the following

  • that our opinionated library could assume that those are unsupported, because file names / to limit complexity
  • that our opinionated library only looks at your node’s default locale (risks “doesn’t work the same on my machine”)
  • must have an additional locale parameter in config. :(

}
9 changes: 0 additions & 9 deletions src/natural-sort/natural-sort.d.ts

This file was deleted.

3 changes: 0 additions & 3 deletions src/utils/get-sorted-nodes-by-import-order.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import {
newLineNode,
THIRD_PARTY_MODULES_SPECIAL_WORD,
} from '../constants';
import { naturalSort } from '../natural-sort';
import { GetSortedNodes, ImportGroups, ImportOrLine } from '../types';
import { getImportNodesMatchedGroup } from './get-import-nodes-matched-group';
import { getSortedImportSpecifiers } from './get-sorted-import-specifiers';
Expand All @@ -19,8 +18,6 @@ import { getSortedNodesGroup } from './get-sorted-nodes-group';
* @param options Options to influence the behavior of the sorting algorithm.
*/
export const getSortedNodesByImportOrder: GetSortedNodes = (nodes, options) => {
naturalSort.insensitive = true;

let { importOrder } = options;
const { importOrderSortSpecifiers } = options;

Expand Down
2 changes: 0 additions & 2 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -721,8 +721,6 @@ has-flag@^3.0.0:
resolved "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz"
integrity sha1-tdRU3CGZriJWmfNGfloH87lVuv0=

javascript-natural-sort@0.7.1:
version "0.7.1"
resolved "https://registry.npmjs.org/javascript-natural-sort/-/javascript-natural-sort-0.7.1.tgz"
integrity sha1-+eIwPUUH9tdDVac2ZNFED7Wg71k=

Expand Down