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

Presort manifests (preferably by module name) #119

Open
rschristian opened this issue Jul 27, 2024 · 4 comments
Open

Presort manifests (preferably by module name) #119

rschristian opened this issue Jul 27, 2024 · 4 comments

Comments

@rschristian
Copy link
Contributor

It'd be nice if the manifests were presorted (preferably by module name) so that consumers could do a binary search over the list(s). It's also a bit nicer to manually search (w/out ctrl+f) if it's alphabetical.

Of course, this isn't not without it's own maintenance burdens so I get this is not a guarantee anyone wants to make.

@43081j
Copy link
Contributor

43081j commented Jul 27, 2024

makes sense but i think we should do it at build or commit time

e.g. we could have a CI step to check they're sorted, and an npm script to sort them

@rschristian
Copy link
Contributor Author

Yup, that's what I was thinking. I'd personally lean towards commit time, to give that extra readability to the source manifests too, but happy either way if you're willing!

I can take a look at adding something tomorrow.

@43081j
Copy link
Contributor

43081j commented Jul 28, 2024

a CI check would be nice still to fail builds which didn't sort

so i think maybe:

  • add a script to sort the manifests and write back to the files
  • add a CI step to run this in "check" mode, i.e. lint that they are sorted (and fail CI if they're not)

we can then use the same script for linting other things. for example, it'd be nice to check new entries actually exist in npm at ci-time

@rschristian
Copy link
Contributor Author

Sorry, a CI script would be included in that, yeah. I was distinguishing pre-publish from source, not the method of enforcing the sorting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants