]> source.dussan.org Git - jquery.git/commitdiff
Build: migrate grunt authors to a custom script
authorTimmy Willison <timmywil@users.noreply.github.com>
Tue, 23 Jan 2024 03:12:33 +0000 (22:12 -0500)
committerGitHub <noreply@github.com>
Tue, 23 Jan 2024 03:12:33 +0000 (22:12 -0500)
- the new script pulls all authors from the Sizzle repo
- added temporary grunt task for releases

Close gh-5396

AUTHORS.txt
Gruntfile.js
build/release/authors.js [new file with mode: 0644]
package-lock.json
package.json

index 648a3f0f473d2b3eb88f4ebadb53703003859618..1006a165f4a90444d4407c5e0dbc18b679536229 100644 (file)
@@ -1,3 +1,5 @@
+Authors ordered by first contribution.
+
 John Resig <jeresig@gmail.com>
 Gilles van den Hoven <gilles0181@gmail.com>
 Michael Geary <mike@geary.com>
@@ -29,7 +31,6 @@ Michael Bensoussan <mickey@seesmic.com>
 Louis-Rémi Babé <lrbabe@gmail.com>
 Robert Katić <robert.katic@gmail.com>
 Damian Janowski <damian.janowski@gmail.com>
-Anton Kovalyov <anton@kovalyov.net>
 Dušan B. Jovanovic <dbjdbj@gmail.com>
 Earle Castledine <mrspeaker@gmail.com>
 Rich Dougherty <rich@rd.gen.nz>
@@ -67,11 +68,11 @@ temp01 <temp01irc@gmail.com>
 Colin Snover <github.com@zetafleet.com>
 Jared Grippe <jared@deadlyicon.com>
 Ryan W Tenney <ryan@10e.us>
-Alex Sexton <AlexSexton@gmail.com>
 Pinhook <contact@pinhooklabs.com>
 Ron Otten <r.j.g.otten@gmail.com>
 Jephte Clain <Jephte.Clain@univ-reunion.fr>
 Anton Matzneller <obhvsbypqghgc@gmail.com>
+Alex Sexton <AlexSexton@gmail.com>
 Dan Heberden <danheberden@gmail.com>
 Henri Wiechers <hwiechers@gmail.com>
 Russell Holbrook <russell.holbrook@patch.com>
@@ -85,9 +86,10 @@ Sylvester Keil <sylvester@keil.or.at>
 Brandon Sterne <bsterne@mozilla.com>
 Mathias Bynens <mathias@qiwi.be>
 Lee Carpenter <elcarpie@gmail.com>
-Timmy Willison <4timmywil@gmail.com>
+Timmy Willison <timmywil@users.noreply.github.com>
 Corey Frang <gnarf37@gmail.com>
 Digitalxero <digitalxero>
+Anton Kovalyov <anton@kovalyov.net>
 David Murdoch <david@davidmurdoch.com>
 Josh Varner <josh.varner@gmail.com>
 Charles McNulty <cmcnulty@kznf.com>
@@ -149,7 +151,6 @@ Chris Faulkner <thefaulkner@gmail.com>
 Marcel Greter <marcel.greter@ocbnet.ch>
 Elijah Manor <elijah.manor@gmail.com>
 Daniel Chatfield <chatfielddaniel@gmail.com>
-Daniel Gálvez <dgalvez@editablething.com>
 Nikita Govorov <nikita.govorov@gmail.com>
 Wesley Walser <waw325@gmail.com>
 Mike Pennisi <mike@mikepennisi.com>
@@ -160,9 +161,7 @@ Dave Riddle <david@joyvuu.com>
 Callum Macrae <callum@lynxphp.com>
 Jonathan Sampson <jjdsampson@gmail.com>
 Benjamin Truyman <bentruyman@gmail.com>
-Jay Merrifield <fracmak@gmail.com>
 James Huston <james@jameshuston.net>
-Sai Lung Wong <sai.wong@huffingtonpost.com>
 Erick Ruiz de Chávez <erickrdch@gmail.com>
 David Bonner <dbonner@cogolabs.com>
 Allen J Schmidt Jr <cobrasoft@gmail.com>
@@ -172,8 +171,11 @@ Ismail Khair <ismail.khair@gmail.com>
 Carl Danley <carldanley@gmail.com>
 Mike Petrovich <michael.c.petrovich@gmail.com>
 Greg Lavallee <greglavallee@wapolabs.com>
+Daniel Gálvez <dgalvez@editablething.com>
+Sai Lung Wong <sai.wong@huffingtonpost.com>
 Tom H Fuertes <TomFuertes@gmail.com>
 Roland Eckl <eckl.roland@googlemail.com>
+Jay Merrifield <fracmak@gmail.com>
 Yiming He <yiminghe@gmail.com>
 David Fox <dfoxinator@gmail.com>
 Bennett Sorbo <bsorbo@gmail.com>
@@ -190,9 +192,9 @@ Diego Tres <diegotres@gmail.com>
 Jean Boussier <jean.boussier@gmail.com>
 Andrew Plummer <plummer.andrew@gmail.com>
 Mark Raddatz <mraddatz@gmail.com>
-Pascal Borreli <pascal@borreli.com>
 Isaac Z. Schlueter <i@izs.me>
 Karl Sieburg <ksieburg@yahoo.com>
+Pascal Borreli <pascal@borreli.com>
 Nguyen Phuc Lam <ruado1987@gmail.com>
 Dmitry Gusev <dmitry.gusev@gmail.com>
 Steven Benner <admin@stevenbenner.com>
@@ -200,7 +202,6 @@ Li Xudong <istonelee@gmail.com>
 Michał Gołębiowski-Owczarek <m.goleb@gmail.com>
 Renato Oliveira dos Santos <ros3@cin.ufpe.br>
 Frederic Junod <frederic.junod@camptocamp.com>
-Tom H Fuertes <tomfuertes@gmail.com>
 Mitch Foley <mitch@thefoley.net>
 ros3cin <ros3@cin.ufpe.br>
 Kyle Robinson Young <kyle@dontkry.com>
@@ -248,7 +249,6 @@ Dan Hart <danhart@notonthehighstreet.com>
 Nazar Mokrynskyi <nazar@mokrynskyi.com>
 Benjamin Tan <demoneaux@gmail.com>
 Amit Merchant <bullredeyes@gmail.com>
-Jason Bedard <jason+github@jbedard.ca>
 Veaceslav Grimalschi <grimalschi@yandex.ru>
 Richard McDaniel <rm0026@uah.edu>
 Arthur Verschaeve <contact@arthurverschaeve.be>
@@ -271,12 +271,12 @@ Jon Hester <jon.d.hester@gmail.com>
 Colin Frick <colin@bash.li>
 Winston Howes <winstonhowes@gmail.com>
 Alexander O'Mara <me@alexomara.com>
-Chris Rebert <github@rebertia.com>
 Bastian Buchholz <buchholz.bastian@googlemail.com>
 Mu Haibao <mhbseal@163.com>
 Calvin Metcalf <calvin.metcalf@gmail.com>
 Arthur Stolyar <nekr.fabula@gmail.com>
 Gabriel Schulhof <gabriel.schulhof@intel.com>
+Chris Rebert <github@rebertia.com>
 Gilad Peleg <giladp007@gmail.com>
 Julian Alexander Murillo <julian.alexander.murillo@gmail.com>
 Kevin Kirsche <Kev.Kirsche+GitHub@gmail.com>
@@ -295,15 +295,14 @@ Christian Grete <webmaster@christiangrete.com>
 Tom von Clef <thomas.vonclef@gmail.com>
 Liza Ramo <liza.h.ramo@gmail.com>
 Joelle Fleurantin <joasqueeniebee@gmail.com>
-Steve Mao <maochenyan@gmail.com>
 Jon Dufresne <jon.dufresne@gmail.com>
 Jae Sung Park <alberto.park@gmail.com>
 Josh Soref <apache@soref.com>
-Saptak Sengupta <saptak013@gmail.com>
 Henry Wong <henryw4k@gmail.com>
 Jun Sun <klsforever@gmail.com>
 Martijn W. van der Lee <martijn@vanderlee.com>
 Devin Wilson <dwilson6.github@gmail.com>
+Steve Mao <maochenyan@gmail.com>
 Damian Senn <jquery@topaxi.codes>
 Zack Hall <zackhall@outlook.com>
 Vitaliy Terziev <vitaliyterziev@gmail.com>
@@ -334,6 +333,7 @@ Jordan Beland <jordan.beland@gmail.com>
 Henry Zhu <hi@henryzoo.com>
 Nilton Cesar <niltoncms@gmail.com>
 basil.belokon <basil.belokon@gmail.com>
+Saptak Sengupta <saptak013@gmail.com>
 Andrey Meshkov <ay.meshkov@gmail.com>
 tmybr11 <tomas.perone@gmail.com>
 Luis Emilio Velasco Sanchez <emibloque@gmail.com>
@@ -342,18 +342,18 @@ Bert Zhang <enbo@users.noreply.github.com>
 Sébastien Règne <regseb@users.noreply.github.com>
 wartmanm <3869625+wartmanm@users.noreply.github.com>
 Siddharth Dungarwal <sd5869@gmail.com>
-abnud1 <ahmad13932013@hotmail.com>
 Andrei Fangli <andrei_fangli@outlook.com>
 Marja Hölttä <marja.holtta@gmail.com>
+abnud1 <ahmad13932013@hotmail.com>
 buddh4 <mail@jharrer.de>
 Hoang <dangkyokhoang@gmail.com>
+Sean Robinson <sean.robinson@scottsdalecc.edu>
 Wonseop Kim <wonseop.kim@samsung.com>
 Pat O'Callaghan <patocallaghan@gmail.com>
 JuanMa Ruiz <ruizjuanma@gmail.com>
 Ahmed.S.ElAfifi <ahmed.s.elafifi@gmail.com>
 Christian Oliff <christianoliff@pm.me>
 Christian Wenz <christian@wenz.org>
-Sean Robinson <sean.robinson@scottsdalecc.edu>
 Jonathan <vanillajonathan@users.noreply.github.com>
 Pierre Grimaud <grimaud.pierre@gmail.com>
 Beatriz Rezener <beatrizrezener@users.noreply.github.com>
@@ -366,6 +366,6 @@ Simon Legner <Simon.Legner@gmail.com>
 Vladimir Sitnikov <sitnikov.vladimir@gmail.com>
 Anders Kaseorg <andersk@mit.edu>
 Alex <aleksandrosansan@gmail.com>
-Timo Tijhof <krinkle@fastmail.com>
 Gabriela Gutierrez <gabigutierrez@google.com>
 Dimitri Papadopoulos Orfanos <3234522+DimitriPapadopoulos@users.noreply.github.com>
+Stephen Sigwart <ssigwart@gmail.com>
index 15fd9369526f3f330a475a348c96d4fdf86ceb43..6dfe6c9ceaeea03d58df64ee7af5e86351d77c94 100644 (file)
@@ -209,6 +209,14 @@ module.exports = function( grunt ) {
                grunt.log.writeln( "Node.js 17 or newer detected, skipping jsdom tests..." );
        } );
 
+       grunt.registerTask( "authors", async function() {
+               const done = this.async();
+               const { getAuthors } = require( "./build/release/authors.js" );
+               const authors = await getAuthors();
+               console.log( authors.join( "\n" ) );
+               done();
+       } );
+
        grunt.registerTask( "test:jsdom", [
 
                // Support: Node.js 17+
diff --git a/build/release/authors.js b/build/release/authors.js
new file mode 100644 (file)
index 0000000..dc9707c
--- /dev/null
@@ -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" );
+       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 parseInt( aDate ) - parseInt( 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
+};
index 59d2556126e764df7604200029d8eab8ef00dd62..b2b3b24485eee531b07407fa7f9be780724a81d4 100644 (file)
@@ -25,7 +25,6 @@
         "globals": "13.20.0",
         "grunt": "1.5.3",
         "grunt-cli": "1.4.3",
-        "grunt-git-authors": "3.2.0",
         "grunt-karma": "4.0.2",
         "husky": "8.0.3",
         "jsdom": "19.0.0",
         "nopt": "bin/nopt.js"
       }
     },
-    "node_modules/grunt-git-authors": {
-      "version": "3.2.0",
-      "resolved": "https://registry.npmjs.org/grunt-git-authors/-/grunt-git-authors-3.2.0.tgz",
-      "integrity": "sha1-D/WrbTxu/+CrIV1jNDRcD2v+FnI=",
-      "dev": true,
-      "dependencies": {
-        "spawnback": "~1.0.0"
-      }
-    },
     "node_modules/grunt-karma": {
       "version": "4.0.2",
       "resolved": "https://registry.npmjs.org/grunt-karma/-/grunt-karma-4.0.2.tgz",
index 62f7c10ca38a1fc26bdfdcb101a0589d22712e74..e96fff70cd9cfdcced93a0ff341343133bd684d1 100644 (file)
@@ -5,6 +5,8 @@
   "version": "3.7.2-pre",
   "main": "dist/jquery.js",
   "scripts": {
+    "authors:check": "node -e \"require('./build/release/authors.js').checkAuthors()\"",
+    "authors:update": "node -e \"require('./build/release/authors.js').updateAuthors()\"",
     "babel:tests": "babel test/data/core/jquery-iterability-transpiled-es6.js --out-file test/data/core/jquery-iterability-transpiled.js",
     "build": "node ./build/command.js",
     "build:all": "node -e \"require('./build/tasks/build.js').buildDefaultFiles()\"",
@@ -65,7 +67,6 @@
     "globals": "13.20.0",
     "grunt": "1.5.3",
     "grunt-cli": "1.4.3",
-    "grunt-git-authors": "3.2.0",
     "grunt-karma": "4.0.2",
     "husky": "8.0.3",
     "jsdom": "19.0.0",