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

RFC: Add a tool and sigils to support automatically maintaining sort order for sorted sections. #476

Closed
wants to merge 4 commits into from

Conversation

nuclearsandwich
Copy link
Collaborator

I actually started adding these because I was separately trying to write a script that would insert values in the correct places and decided that it would be easier to write one script to add things wherever and then another to sort the entire section.

These sigils are based on the ones used by https://github.com/google/keep-sorted but I've included a script that supports our use case here so that additional dependency is not required, although I do use the same sigils so in theory the other tool could be used just the same.

I only added the sort sigils on sections that I thought needed them and have not added them to any release teams.

As I was writing this RFC description, I realized that with a bit more skullduggery, it would actually be possible to use my same tool to perform the sorting using existing patterns and negating the need for explicit sigils. Stand by.

This script will look for sort sigils in files and ASCII sort the lines
between them.

It's an inline alternative to https://github.com/google/keep-sorted that
is less sophisticated but also small.
It's intended that all lists of usernames or repositories in this
project are lexicographically sorted. The added sigils allow tools to be
used to facilate maintaining that sort order.

I have not yet added these to each individual release team, but I am
tempted.
@nuclearsandwich
Copy link
Collaborator Author

nuclearsandwich commented Mar 23, 2024

This is replaced by a sigiless implementation in #477 .

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

Successfully merging this pull request may close these issues.

1 participant