-
Notifications
You must be signed in to change notification settings - Fork 20.5k
Build: migrate grunt authors to a custom script #5395
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| "use strict"; | ||
|
|
||
| const fs = require( "node:fs" ); | ||
| const util = require( "node:util" ); | ||
| const exec = util.promisify( require( "node:child_process" ).exec ); | ||
| const rnewline = /\r?\n/; | ||
| const rdate = /^\[(\d+)\] /; | ||
|
|
||
| const ignore = [ | ||
| /dependabot\[bot\]/ | ||
| ]; | ||
|
|
||
| function compareAuthors( a, b ) { | ||
| const aName = a.replace( rdate, "" ).replace( / <.*>/, "" ); | ||
| const bName = b.replace( rdate, "" ).replace( / <.*>/, "" ); | ||
| return aName === bName; | ||
| } | ||
|
|
||
| function uniq( arr ) { | ||
| const unique = []; | ||
| for ( const item of arr ) { | ||
| if ( ignore.some( re => re.test( item ) ) ) { | ||
| continue; | ||
| } | ||
| if ( item && !unique.find( ( e ) => compareAuthors( e, item ) ) ) { | ||
| unique.push( item ); | ||
| } | ||
| } | ||
| return unique; | ||
| } | ||
|
|
||
| function cleanupSizzle() { | ||
| console.log( "Cleaning up..." ); | ||
| return exec( "npx rimraf .sizzle" ); | ||
| } | ||
|
|
||
| function cloneSizzle() { | ||
| console.log( "Cloning Sizzle..." ); | ||
| return exec( "git clone https://github.com/jquery/sizzle .sizzle" ); | ||
| } | ||
|
|
||
| async function getLastAuthor() { | ||
| const authorsTxt = await fs.promises.readFile( "AUTHORS.txt", "utf8" ); | ||
mgol marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return authorsTxt.trim().split( rnewline ).pop(); | ||
| } | ||
|
|
||
| async function logAuthors( preCommand ) { | ||
| let command = "git log --pretty=format:\"[%at] %aN <%aE>\""; | ||
| if ( preCommand ) { | ||
| command = `${ preCommand } && ${ command }`; | ||
| } | ||
| const { stdout } = await exec( command ); | ||
| return uniq( stdout.trim().split( rnewline ).reverse() ); | ||
| } | ||
|
|
||
| async function getSizzleAuthors() { | ||
| await cloneSizzle(); | ||
| const authors = await logAuthors( "cd .sizzle" ); | ||
| await cleanupSizzle(); | ||
| return authors; | ||
| } | ||
|
|
||
| function sortAuthors( a, b ) { | ||
| const [ , aDate ] = rdate.exec( a ); | ||
| const [ , bDate ] = rdate.exec( b ); | ||
| return Number( aDate ) - Number( bDate ); | ||
| } | ||
|
|
||
| function formatAuthor( author ) { | ||
| return author.replace( rdate, "" ); | ||
| } | ||
|
|
||
| async function getAuthors() { | ||
| console.log( "Getting authors..." ); | ||
| const authors = await logAuthors(); | ||
| const sizzleAuthors = await getSizzleAuthors(); | ||
| return uniq( authors.concat( sizzleAuthors ) ).sort( sortAuthors ).map( formatAuthor ); | ||
| } | ||
|
|
||
| async function checkAuthors() { | ||
| const authors = await getAuthors(); | ||
| const lastAuthor = await getLastAuthor(); | ||
|
|
||
| if ( authors[ authors.length - 1 ] !== lastAuthor ) { | ||
| console.log( "AUTHORS.txt: ", lastAuthor ); | ||
| console.log( "Last 20 in git: ", authors.slice( -20 ) ); | ||
| throw new Error( "Last author in AUTHORS.txt does not match last git author" ); | ||
| } | ||
| console.log( "AUTHORS.txt is up to date" ); | ||
| } | ||
|
|
||
| async function updateAuthors() { | ||
| const authors = await getAuthors(); | ||
|
|
||
| const authorsTxt = "Authors ordered by first contribution.\n\n" + authors.join( "\n" ) + "\n"; | ||
| await fs.promises.writeFile( "AUTHORS.txt", authorsTxt ); | ||
|
|
||
| console.log( "AUTHORS.txt updated" ); | ||
| } | ||
|
|
||
| module.exports = { | ||
| checkAuthors, | ||
| getAuthors, | ||
| updateAuthors | ||
| }; | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this pattern of using an async function and calling
done()in a way that looks synchronous. 🙂