@netlify/git-utils 1.0.11 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/git-utils",
-  "version": "1.0.11",
+  "version": "3.0.0",
   "description": "Utility for dealing with modified, created, deleted files since a git commit",
   "main": "src/main.js",
   "files": [
@@ -43,16 +43,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": ">=8.3.0"
+    "node": "^12.20.0 || ^14.14.0 || >=16.0.0"
   }
 }

package/src/commits.js

@@ -5,17 +5,33 @@ const { git } = require('./exec')
 // 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(',')}]`)
+  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,
+  }
 }
 
+// `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)
+
 module.exports = { getCommits }

package/src/exec.js

@@ -9,8 +9,15 @@ const pathExists = require('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

package/CHANGELOG.md

@@ -1,36 +0,0 @@
-# Changelog
-
-### [1.0.11](https://www.github.com/netlify/build/compare/git-utils-v1.0.10...git-utils-v1.0.11) (2021-05-03)
-
-
-### Bug Fixes
-
-* **deps:** update dependency map-obj to v4 ([#2721](https://www.github.com/netlify/build/issues/2721)) ([17559dc](https://www.github.com/netlify/build/commit/17559dcc75dd9f9a73f2a604c9f8ef3140a91b42))
-
-### [1.0.10](https://www.github.com/netlify/build/compare/git-utils-v1.0.9...git-utils-v1.0.10) (2021-04-26)
-
-
-### Bug Fixes
-
-* **deps:** update dependency map-obj to v3.1.0 ([#2656](https://www.github.com/netlify/build/issues/2656)) ([89e497a](https://www.github.com/netlify/build/commit/89e497a37a892f203a601a510e0e24ae037ad146))
-
-### [1.0.9](https://www.github.com/netlify/build/compare/git-utils-v1.0.8...git-utils-v1.0.9) (2021-04-23)
-
-
-### Bug Fixes
-
-* fix `utils.git` for repositories with `main` branch ([#2638](https://www.github.com/netlify/build/issues/2638)) ([5f80961](https://www.github.com/netlify/build/commit/5f80961e25387deee9b37bba07379adc1fed44c3))
-
-### [1.0.8](https://www.github.com/netlify/build/compare/v1.0.7...v1.0.8) (2021-02-18)
-
-
-### Bug Fixes
-
-* fix `files` in `package.json` with `npm@7` ([#2278](https://www.github.com/netlify/build/issues/2278)) ([e9df064](https://www.github.com/netlify/build/commit/e9df0645f3083a0bb141c8b5b6e474ed4e27dbe9))
-
-### [1.0.7](https://www.github.com/netlify/build/compare/git-utils-v1.0.6...v1.0.7) (2021-02-01)
-
-
-### Bug Fixes
-
-* **deps:** update dependency moize to v6 ([#2231](https://www.github.com/netlify/build/issues/2231)) ([e34454c](https://www.github.com/netlify/build/commit/e34454c633bbc541c4074bdaa15361c84f0c8f04))