feat(alpha-sort): Add a parameter contributorsSortAlphabetically #249
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This parameter allows the user to sort the list of contributors in alphabetical order of their name.
Berkmann18
reviewed
Feb 22, 2020
jakebolam
approved these changes
Feb 22, 2020
|
🎉 This PR is included in version 6.14.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This parameter allows the user to sort the list of contributors in
alphabetical order of their name.
What: This adds a new CLI flag
--contributorsSortAlphabetically/config optioncontributorsSortAlphabeticallythat allows you to display the list of contributors in alphabetical order (based on name).Why: This is a feature request that's come up a couple of times, e.g. all-contributors/all-contributors#225
How: The order of contributors is preserved in the JSON file. When the list is rendered, check a contributorsSortAlphabetically option (defaulted to false, to preserve existing behaviour) to decide whether to sort the list of contributors before turning into HTML.
Standard TDD: write a test for the new config option, check it fails, edit the code, check the test passes.
For the CLI, I ran it in the root of this repo to see that it would sort in alphabetical order or order-of-being added, depending on what value I passed.
This needs to be added to the docs in https://github.com/all-contributors/all-contributors/blob/master/docs/cli/configuration.md, but I didn't want to do that until I had approval for the feature and the name of the option.
Checklist: