https://github.com/sv592/sort-authors-github-
Returns a text file containing the top commit authors for a repo during any period of time and their individual total commits.
https://github.com/sv592/sort-authors-github-
git github javascript nodejs
Last synced: 3 months ago
JSON representation
Returns a text file containing the top commit authors for a repo during any period of time and their individual total commits.
- Host: GitHub
- URL: https://github.com/sv592/sort-authors-github-
- Owner: SV592
- License: mit
- Created: 2022-07-09T15:29:55.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-27T13:50:25.000Z (over 3 years ago)
- Last Synced: 2025-03-27T01:48:31.841Z (over 1 year ago)
- Topics: git, github, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 289 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sort Authors Github
DESCRIPTION
--------------------------------------------------------------------------------------
Returns a text file containing the top commit authors for a repo during a particular period and their individual total commits
REQUIREMENTS
--------------------------------------------------------------------------------------
This script requires the following to function:
.[NODEJS] V14.15.1
.[GIT] V2.29.2
.[ShellJS] V0.8.5
INSTALLATION
-------------------------------------------------------------------------------------
Install NODE globally as normal. Visit
https://nodejs.org/en/
Install GIT globally as normal. Visit
https://git-scm.com/
Install Node Modules. Run
`npm i` within the sort authors folder
CONFIGURATION
-------------------------------------------------------------------------------------
Upon starting the script, it will promot the user to enter the required valued in the following formats.
The repo path has to be up the root directory.
1. Full repository path (locally) = FORMAT - "C:\Users\shaqu\Desktop\Sort Authors"
2. Starting date for period of data retrieval = FORMAT - Dec 9 2021
3. Ending date for the period of data retrieval = FORMAT - July 9 2022
4. Desired number of Authors to return = FORMAT - 12
RUN
-------------------------------------------------------------------------------------
Within terminal. Run
`node sortAuthors.js`
OUTPUT
-------------------------------------------------------------------------------------
The CLI terminal will start up welcoming the user, then proceeding to get the required info. When all necessary information is entered a completion message will be logged and a text file titled "authors" will be created within the root directory of the working folder. This contains the top authors for the given period. With the total number of commits listed on the left as well as their names and email addresses.
EXAMPLE:
89 Rodolfo Alonso Hernandez
52 Slawek Kaplonski
33 yatinkarel
13 Jakub Libosvar
12 LIU Yulong
12 elajkat
9 Oleg Bondarev
8 zhouhenglc
5 Arnau Verdaguer
5 Frode Nordahl
Troubleshooting
------------------------------------------------------------------------------------
When running the script multiple times be sure to clear the authors.txt file or delete it entirely because the information will be appended to the existing data and this can be confusing.
The number of authors will have to be adjusted according to the number of authors within the repository for the given period. If the number is adjusted more than the total amount of commit authors avaliable, the script will return undefined for the additional entries.