@netlify/git-utils 2.0.0 → 4.0.0

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@netlify/git-utils",
-  "version": "2.0.0",
+  "version": "4.0.0",
   "description": "Utility for dealing with modified, created, deleted files since a git commit",
-  "main": "src/main.js",
+  "type": "module",
+  "exports": "./src/main.js",
+  "main": "./src/main.js",
   "files": [
     "src/**/*.js"
   ],
@@ -43,16 +45,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "execa": "^3.4.0",
+    "execa": "^5.1.1",
     "map-obj": "^4.0.0",
     "micromatch": "^4.0.2",
     "moize": "^6.0.0",
     "path-exists": "^4.0.0"
   },
   "devDependencies": {
-    "ava": "^2.4.0"
+    "ava": "^3.15.0"
   },
   "engines": {
-    "node": ">=10.18.0"
+    "node": "^12.20.0 || ^14.14.0 || >=16.0.0"
   }
 }

package/src/commits.js

@@ -1,21 +1,33 @@
-'use strict'
-
-const { git } = require('./exec')
+import { git } from './exec.js'
 
 // Return information on each commit since the `base` commit, such as SHA,
 // parent commits, author, committer and commit message
-const getCommits = function (base, head, cwd) {
-  const stdout = git(['log', `--pretty=format:${JSON.stringify(FORMAT_JSON)}`, `${base}...${head}`], cwd)
-  const commits = JSON.parse(`[${stdout.split('\n').join(',')}]`)
+export const getCommits = function (base, head, cwd) {
+  const stdout = git(['log', `--pretty=${GIT_PRETTY_FORMAT}`, `${base}...${head}`], cwd)
+  const commits = stdout.split('\n').map(getCommit)
   return commits
 }
 
-const FORMAT_JSON = {
-  sha: '%H',
-  parents: '%p',
-  author: { name: '%an', email: '%ae', date: '%ai' },
-  committer: { name: '%cn', email: '%ce', date: '%ci' },
-  message: '%f',
+// Parse the commit output from a string to a JavaScript object
+const getCommit = function (line) {
+  const [sha, parents, authorName, authorEmail, authorDate, committerName, committerEmail, committerDate, message] =
+    line.split(GIT_PRETTY_SEPARATOR)
+  return {
+    sha,
+    parents,
+    author: { name: authorName, email: authorEmail, date: authorDate },
+    committer: { name: committerName, email: committerEmail, date: committerDate },
+    message,
+  }
 }
 
-module.exports = { getCommits }
+// `git log --pretty` does not have any way of separating tokens, except for
+// commits being separated by newlines. Since some tokens (like the commit
+// message or the committer name) might contain a wide range of characters, we
+// need a specific separator.
+// We choose RS (Record separator) which is a rarely used control character
+// intended for this very purpose: separating records. It is used by some
+// formats such as JSON text sequences (RFC 7464).
+const GIT_PRETTY_SEPARATOR = '\u001E'
+// List of commit fields we want to retrieve
+const GIT_PRETTY_FORMAT = ['%H', '%p', '%an', '%ae', '%ai', '%cn', '%ce', '%ci', '%f'].join(GIT_PRETTY_SEPARATOR)

package/src/diff.js

@@ -1,10 +1,8 @@
-'use strict'
-
-const { git } = require('./exec')
+import { git } from './exec.js'
 
 // Return the list of modified|created|deleted files according to git, between
 // the `base` commit and the `HEAD`
-const getDiffFiles = function (base, head, cwd) {
+export const getDiffFiles = function (base, head, cwd) {
   const stdout = git(['diff', '--name-status', '--no-renames', `${base}...${head}`], cwd)
   const files = stdout.split('\n').map(getDiffFile).filter(Boolean)
 
@@ -36,5 +34,3 @@ const getFilesByType = function (files, type) {
 const getFilepath = function ({ filepath }) {
   return filepath
 }
-
-module.exports = { getDiffFiles }

package/src/exec.js

@@ -1,20 +1,25 @@
-'use strict'
+import process from 'process'
 
-const process = require('process')
-
-const execa = require('execa')
-const moize = require('moize')
-const pathExists = require('path-exists')
+import execa from 'execa'
+import moize from 'moize'
+import pathExists from 'path-exists'
 
 // Fires the `git` binary. Memoized.
 const mGit = function (args, cwd) {
   const cwdA = safeGetCwd(cwd)
-  const { stdout } = execa.sync('git', args, { cwd: cwdA })
-  return stdout
+  try {
+    const { stdout } = execa.sync('git', args, { cwd: cwdA })
+    return stdout
+  } catch (error) {
+    // The child process `error.message` includes stderr and stdout output which most of the times contains duplicate
+    // information. We rely on `error.shortMessage` instead.
+    error.message = error.shortMessage
+    throw error
+  }
 }
 
 // eslint-disable-next-line no-magic-numbers
-const git = moize(mGit, { isDeepEqual: true, maxSize: 1e3 })
+export const git = moize(mGit, { isDeepEqual: true, maxSize: 1e3 })
 
 const safeGetCwd = function (cwd) {
   const cwdA = getCwdValue(cwd)
@@ -37,5 +42,3 @@ const getCwdValue = function (cwd) {
     throw new Error('Current directory does not exist')
   }
 }
-
-module.exports = { git }

package/src/main.js

@@ -1,13 +1,11 @@
-'use strict'
-
-const { getCommits } = require('./commits')
-const { getDiffFiles } = require('./diff')
-const { fileMatch } = require('./match')
-const { getBase, getHead } = require('./refs')
-const { getLinesOfCode } = require('./stats')
+import { getCommits } from './commits.js'
+import { getDiffFiles } from './diff.js'
+import { fileMatch } from './match.js'
+import { getBase, getHead } from './refs.js'
+import { getLinesOfCode } from './stats.js'
 
 // Main entry point to the git utilities
-const getGitUtils = function ({ base, head, cwd } = {}) {
+export const getGitUtils = function ({ base, head, cwd } = {}) {
   const headA = getHead(cwd, head)
   const baseA = getBase(base, headA, cwd)
   const { modifiedFiles, createdFiles, deletedFiles } = getDiffFiles(baseA, headA, cwd)
@@ -16,5 +14,3 @@ const getGitUtils = function ({ base, head, cwd } = {}) {
   const fileMatchA = fileMatch.bind(null, { modifiedFiles, createdFiles, deletedFiles })
   return { modifiedFiles, createdFiles, deletedFiles, commits, linesOfCode, fileMatch: fileMatchA }
 }
-
-module.exports = getGitUtils

package/src/match.js

@@ -1,11 +1,9 @@
-'use strict'
-
-const mapObj = require('map-obj')
-const micromatch = require('micromatch')
+import mapObj from 'map-obj'
+import micromatch from 'micromatch'
 
 // Return functions that return modified|created|deleted files filtered by a
 // globbing pattern
-const fileMatch = function ({ modifiedFiles, createdFiles, deletedFiles }, ...patterns) {
+export const fileMatch = function ({ modifiedFiles, createdFiles, deletedFiles }, ...patterns) {
   const matchFiles = {
     modified: modifiedFiles,
     created: createdFiles,
@@ -14,5 +12,3 @@ const fileMatch = function ({ modifiedFiles, createdFiles, deletedFiles }, ...pa
   }
   return mapObj(matchFiles, (key, paths) => [key, micromatch(paths, patterns)])
 }
-
-module.exports = { fileMatch }

package/src/refs.js

@@ -1,11 +1,9 @@
-'use strict'
+import { env } from 'process'
 
-const { env } = require('process')
-
-const { git } = require('./exec')
+import { git } from './exec.js'
 
 // Retrieve the `head` commit
-const getHead = function (cwd, head = 'HEAD') {
+export const getHead = function (cwd, head = 'HEAD') {
   const result = checkRef(head, cwd)
   if (result.error !== undefined) {
     throwError('head', result)
@@ -14,7 +12,7 @@ const getHead = function (cwd, head = 'HEAD') {
 }
 
 // Retrieve the `base` commit
-const getBase = function (base, head, cwd) {
+export const getBase = function (base, head, cwd) {
   const refs = getBaseRefs(base, head)
   const { ref } = findRef(refs, cwd)
   return ref
@@ -63,5 +61,3 @@ const throwError = function (name, { ref, error: { message, stderr } }) {
   const messageA = `Invalid ${name} commit ${ref}\n${messages}`
   throw new Error(messageA)
 }
-
-module.exports = { getBase, getHead }

package/src/stats.js

@@ -1,10 +1,8 @@
-'use strict'
-
-const { git } = require('./exec')
+import { git } from './exec.js'
 
 // Returns the number of lines of code added, removed or modified since the
 // `base` commit
-const getLinesOfCode = function (base, head, cwd) {
+export const getLinesOfCode = function (base, head, cwd) {
   const stdout = git(['diff', '--shortstat', `${base}...${head}`], cwd)
   const insertions = parseStdout(stdout, INSERTION_REGEXP)
   const deletions = parseStdout(stdout, DELETION_REGEXP)
@@ -23,5 +21,3 @@ const parseStdout = function (stdout, regexp) {
 
 const INSERTION_REGEXP = /(\d+) insertion/
 const DELETION_REGEXP = /(\d+) deletion/
-
-module.exports = { getLinesOfCode }