Skip to content

feat: sort export/import paths #350

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

Open
GeorgeTaveras1231 wants to merge 17 commits into
base: main
Choose a base branch
from
+79 −2
Open

feat: sort export/import paths #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
14c4898
feat: improve sorting of imports/exports
GeorgeTaveras1231 Feb 27, 2025
f230fc1
Update index.js
GeorgeTaveras1231 Feb 27, 2025
2a24a3f
fix: avoid adding key that does not exist
GeorgeTaveras1231 Feb 27, 2025
7e8e002
fix: use older syntax for older node versions
GeorgeTaveras1231 Feb 28, 2025
1e25a6e
fix: ordering of conditions
GeorgeTaveras1231 Feb 28, 2025
3d5adf7
chore: add test-watch script
GeorgeTaveras1231 Feb 28, 2025
5b8c882
feat: support node-addons
GeorgeTaveras1231 Feb 28, 2025
a054fa3
fix: wrong comment
GeorgeTaveras1231 Feb 28, 2025
bb91e81
fix: `macro` condition is more specific than `bun`
GeorgeTaveras1231 Feb 28, 2025
c543aad
fix: relativeOrderSort should leave unspecified items in place
GeorgeTaveras1231 Mar 1, 2025
ce0093e
feat: capture more standard conditions
GeorgeTaveras1231 Mar 1, 2025
f184919
chore: improve edge condition sorting
GeorgeTaveras1231 Mar 1, 2025
f9f4320
chore: improve comments
GeorgeTaveras1231 Mar 1, 2025
de9940a
feat: svelte and reorder
GeorgeTaveras1231 Mar 1, 2025
d07bd01
fix: ensure custom conditions are not touched
GeorgeTaveras1231 Mar 1, 2025
26c91c7
fix: node >=12 <=18
GeorgeTaveras1231 Mar 1, 2025
2f87b62
chore: remove condition sort
GeorgeTaveras1231 Mar 4, 2025
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
43 changes: 41 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,45 @@ const sortScripts = onObject((scripts, packageJson) => {
return sortObjectKeys(scripts, order)
})

const sortPathLikeObjectWithWildcards = onObject((object) => {
// Replace all '*' with the highest possible unicode character
// To force all wildcards to be at the end, but relative to
// the path they are in
const wildcard = '\u{10FFFF}'
const sortableWildcardPaths = new Map()
const sortablePath = (path) => {
if (sortableWildcardPaths.has(path)) return sortableWildcardPaths.get(path)
const wildcardWeightedPath = path.replace(/\*/g, wildcard)
sortableWildcardPaths.set(path, wildcardWeightedPath)
return wildcardWeightedPath
}
return sortObjectKeys(object, (a, b) => {
return sortablePath(a).localeCompare(sortablePath(b))
})
})

const sortExportsOrImports = onObject((exportOrImports) => {
const exportsWithSortedChildren = Object.fromEntries(
Object.entries(exportOrImports).map(([key, value]) => {
return [key, sortExportsOrImports(value)]
}),
)

const keys = Object.keys(exportsWithSortedChildren)
let isPathLikeObject = true
for (const key of keys) {
const keyIsPathLike = key.startsWith('.') || key.startsWith('#')
isPathLikeObject = isPathLikeObject && keyIsPathLike
}

if (isPathLikeObject) {
return sortPathLikeObjectWithWildcards(exportsWithSortedChildren)
}

// Object is likely condition object
return exportOrImports
})

// fields marked `vscode` are for `Visual Studio Code extension manifest` only
// https://code.visualstudio.com/api/references/extension-manifest
// Supported fields:
Expand Down Expand Up @@ -306,8 +345,8 @@ const fields = [
/* vscode */ { key: 'publisher' },
{ key: 'sideEffects' },
{ key: 'type' },
{ key: 'imports' },
{ key: 'exports' },
{ key: 'imports', over: sortExportsOrImports },
{ key: 'exports', over: sortExportsOrImports },
{ key: 'main' },
{ key: 'svelte' },
{ key: 'umd:main' },
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
"semantic-release": "semantic-release",
"test": "ava && dtslint --localTs node_modules/typescript/lib",
"test-coverage": "nyc ava",
"test-watch": "ava --watch",
"update-snapshots": "ava --update-snapshots"
},
"commitlint": {
Expand Down
37 changes: 37 additions & 0 deletions tests/fields.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,3 +326,40 @@ test('pnpm', macro.sortObject, {
},
},
})

test('imports', macro.sortObject, {
path: 'imports',
value: {
'#c': './index.js',
'#c/sub': './index.js',
'#c/*': './wild/*.js',
'#a': './sub/index.js',
'#b/sub/*': './wild/*.js',
'#b/*': './wild/*.js',
'#b/sub': './wild/sub-module.js',
},
expect: {
'#a': './sub/index.js',
'#b/sub': './wild/sub-module.js',
'#b/sub/*': './wild/*.js',
'#b/*': './wild/*.js',
'#c': './index.js',
'#c/sub': './index.js',
'#c/*': './wild/*.js',
},
})
test('exports level 1', macro.sortObject, {
path: 'exports',
value: {
'./sub': './sub/index.js',
'./a-wildcard/*': './wild/*.js',
'./a-wildcard/sub': './wild/sub-module.js',
'.': './index.js',
},
expect: {
'.': './index.js',
'./a-wildcard/sub': './wild/sub-module.js',
'./a-wildcard/*': './wild/*.js',
'./sub': './sub/index.js',
},
})