@jsenv/github-pull-request-impact 1.6.9 → 1.7.0

package/README.md

@@ -10,4 +10,4 @@ This repository publishes `@jsenv/github-pull-request-impact` on NPM. This packa
 
 - [@jsenv/performance-impact](../jsenv-performance-impact)
 - [@jsenv/file-size-impact](../jsenv-file-size-impact)
-- [@jsenv/lighthouse-score-impact](../jsenv-performance-impact)
+- [@jsenv/lighthouse-impact](../jsenv-lighthouse-impact)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/github-pull-request-impact",
-  "version": "1.6.9",
+  "version": "1.7.0",
   "description": "Report pull request impact on something",
   "license": "MIT",
   "author": {
@@ -23,35 +23,20 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./main.js"
+      "import": "./src/main.js"
     },
     "./*": "./*"
   },
-  "main": "./main.js",
+  "main": "./src/main.js",
   "files": [
-    "/src/",
-    "/main.js"
+    "/src/"
   ],
   "scripts": {
-    "eslint": "npx eslint . --ext=.js,.mjs",
-    "importmap": "node ./script/importmap/importmap.mjs",
-    "test": "node ./script/test/test.mjs",
-    "test-with-coverage": "npm run test -- --coverage",
-    "prettier": "prettier --write ."
+    "test": "node ./scripts/test.mjs"
   },
   "dependencies": {
-    "@jsenv/filesystem": "2.7.1",
-    "@jsenv/logger": "4.0.1",
-    "node-fetch": "2.6.7"
-  },
-  "devDependencies": {
-    "@jsenv/assert": "2.4.1",
-    "@jsenv/core": "25.3.0",
-    "@jsenv/eslint-config": "16.0.9",
-    "@jsenv/importmap-eslint-resolver": "5.2.5",
-    "@jsenv/importmap-node-module": "5.1.3",
-    "eslint": "8.7.0",
-    "eslint-plugin-import": "2.25.4",
-    "prettier": "2.5.1"
+    "@jsenv/fetch": "1.1.2",
+    "@jsenv/filesystem": "4.1.0",
+    "@jsenv/log": "2.1.0"
   }
 }

package/src/commentGitHubPullRequestImpact.js

@@ -4,11 +4,9 @@
  * @jsenv/file-size-impact, @jsenv/performance-impact and @jsenv/lighthouse-score-impact
  */
 
-import {
-  assertAndNormalizeDirectoryUrl,
-  urlToFileSystemPath,
-} from "@jsenv/filesystem"
-import { createLogger } from "@jsenv/logger"
+import { fileURLToPath } from "node:url"
+import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
+import { createLogger } from "@jsenv/log"
 
 import * as githubRESTAPI from "./internal/github_rest_api.js"
 import { exec } from "./internal/exec.js"
@@ -19,7 +17,7 @@ export const commentGitHubPullRequestImpact = async ({
   logLevel,
   commandLogs = false,
   infoLogs = true,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
 
   githubToken,
   repositoryOwner,
@@ -33,7 +31,7 @@ export const commentGitHubPullRequestImpact = async ({
   createCommentForVersionMismatch = jsenvCreateCommentForVersionMismatch,
   createCommentForComparison = jsenvCreateCommentForComparison,
   generatedByLink = {
-    url: "https://github.com/jsenv/github-pull-request-impact",
+    url: "https://github.com/jsenv/workflow/tree/main/packages/jsenv-github-pull-request-impact",
     text: "@jsenv/github-pull-request-impact",
   },
   runLink,
@@ -41,7 +39,7 @@ export const commentGitHubPullRequestImpact = async ({
 
   catchError = false,
 }) => {
-  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
   if (typeof collectInfo !== "function") {
     throw new TypeError(
       `collectInfo must be a function but received ${collectInfo}`,
@@ -83,7 +81,7 @@ export const commentGitHubPullRequestImpact = async ({
       logger,
       commandLogs,
       infoLogs,
-      projectDirectoryUrl,
+      rootDirectoryUrl,
 
       githubToken,
       repositoryOwner,
@@ -111,7 +109,7 @@ const commentPrImpact = async ({
   logger,
   infoLogs,
   commandLogs,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
 
   githubToken,
   repositoryOwner,
@@ -130,10 +128,10 @@ const commentPrImpact = async ({
 
   catchError,
 }) => {
-  const execCommandInProjectDirectory = (command) => {
+  const execCommandInRootDirectory = (command) => {
     logger.info(`> ${command}`)
     return exec(command, {
-      cwd: urlToFileSystemPath(projectDirectoryUrl),
+      cwd: fileURLToPath(rootDirectoryUrl),
       onLog: (string) => {
         if (commandLogs) {
           logger.info(string)
@@ -254,15 +252,15 @@ const commentPrImpact = async ({
   let beforeMergeInfo
   try {
     // cannot use depth=1 arg otherwise git merge might have merge conflicts
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git fetch --no-tags --prune origin ${pullRequestBase}`,
     )
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git reset --hard origin/${pullRequestBase}`,
     )
     beforeMergeInfo = await collectInfo({
       beforeMerge: true,
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
     if (infoLogs) {
       logger.debug(debugBeforeMergeInfo(beforeMergeInfo))
@@ -285,13 +283,13 @@ const commentPrImpact = async ({
   try {
     // buildCommand might generate files that could conflict when doing the merge
     // reset to avoid potential merge conflicts
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git reset --hard origin/${pullRequestBase}`,
     )
     // Avoid "The following untracked working tree files would be overwritten by merge" error
-    await execCommandInProjectDirectory(`git clean -d -f .`)
+    await execCommandInRootDirectory(`git clean -d -f .`)
     // cannot use depth=1 arg otherwise git merge might have merge conflicts
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git fetch --no-tags --prune origin ${headRef}`,
     )
     // ensure there is user.email + user.name required to perform git merge command
@@ -299,20 +297,25 @@ const commentPrImpact = async ({
 
     const restoreGitUserEmail = await ensureGitConfig("user.email", {
       valueIfMissing: "you@example.com",
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
     const restoreGitUserName = await ensureGitConfig("user.name", {
       valueIfMissing: "Your Name",
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
-    await execCommandInProjectDirectory(
-      `git merge FETCH_HEAD --allow-unrelated-histories`,
-    )
+    // could we use https://stackoverflow.com/a/6283843 ?
+    try {
+      await execCommandInRootDirectory(
+        `git merge FETCH_HEAD --allow-unrelated-histories --no-ff --no-commit`,
+      )
+    } catch (e) {
+      throw new Error(`git merge command failed (is there a merge conflict?)`)
+    }
     await restoreGitUserEmail()
     await restoreGitUserName()
     afterMergeInfo = await collectInfo({
       afterMerge: true,
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
     if (infoLogs) {
       logger.debug(debugAfterMergeInfo(afterMergeInfo))
@@ -359,17 +362,15 @@ const commentPrImpact = async ({
 
 const ensureGitConfig = async (
   name,
-  { execCommandInProjectDirectory, valueIfMissing },
+  { execCommandInRootDirectory, valueIfMissing },
 ) => {
   try {
-    await execCommandInProjectDirectory(`git config ${name}`)
+    await execCommandInRootDirectory(`git config ${name}`)
     return () => {}
   } catch (e) {
-    await execCommandInProjectDirectory(
-      `git config ${name} "${valueIfMissing}"`,
-    )
+    await execCommandInRootDirectory(`git config ${name} "${valueIfMissing}"`)
     return async () => {
-      await execCommandInProjectDirectory(`git config --unset ${name}`)
+      await execCommandInRootDirectory(`git config --unset ${name}`)
     }
   }
 }

package/src/internal/createGitHubPullRequestCommentText.js

@@ -36,7 +36,14 @@ export const createGitHubPullRequestCommentText = ({
   })
 }
 
-const truncateComment = ({ commentLength, maxLength, header, warnings, body, footer }) => {
+const truncateComment = ({
+  commentLength,
+  maxLength,
+  header,
+  warnings,
+  body,
+  footer,
+}) => {
   const warningsWithTruncateWarning = [
     ...warnings,
     `**Warning:** The comment body was truncated to fit GitHub limit on comment length.
@@ -69,7 +76,9 @@ For the record the full comment length was ${commentLength} bytes.`,
 
 const composeCommentText = ({ header, warnings, body, footer }) => {
   const warningsAsText = composeWarningsText(warnings)
-  const parts = [header, warningsAsText, body, footer].filter((string) => string.length > 0)
+  const parts = [header, warningsAsText, body, footer].filter(
+    (string) => string.length > 0,
+  )
 
   return parts.join(`
 

package/src/internal/exec.js

@@ -11,11 +11,11 @@ export const exec = (
         cwd,
         stdio: "silent",
       },
-      (error) => {
+      (error, out) => {
         if (error) {
           reject(error)
         } else {
-          resolve()
+          resolve(out)
         }
       },
     )

package/src/internal/github_rest_api.js

@@ -1,4 +1,4 @@
-import nodeFetch from "node-fetch"
+import { fetchUrl } from "@jsenv/fetch"
 
 export const GET = async ({ url, githubToken, headers }) => {
   return sendHttpRequest({
@@ -72,7 +72,7 @@ const sendHttpRequest = async ({
 }) => {
   let response
   try {
-    response = await nodeFetch(url, {
+    response = await fetchUrl(url, {
       method,
       headers: {
         ...(typeof body === "undefined"

package/src/internal/renderGeneratedByText.js

@@ -1,4 +1,8 @@
-export const renderGeneratedByText = ({ generatedByLink, runLink, commitLink }) => {
+export const renderGeneratedByText = ({
+  generatedByLink,
+  runLink,
+  commitLink,
+}) => {
   if (runLink && typeof runLink !== "object") {
     console.warn(
       `runLink ignored because it should be an object with {url, text}, received ${runLink}`,
@@ -9,7 +13,9 @@ export const renderGeneratedByText = ({ generatedByLink, runLink, commitLink })
   const parts = [
     `Generated by <a href="${generatedByLink.url}">${generatedByLink.text}</a>`,
     ...(runLink ? [`during <a href="${runLink.url}">${runLink.text}</a>`] : []),
-    ...(commitLink ? [`on <a href="${commitLink.url}">${commitLink.text}</a>`] : []),
+    ...(commitLink
+      ? [`on <a href="${commitLink.url}">${commitLink.text}</a>`]
+      : []),
   ]
 
   return `<sub>

package/src/main.js

@@ -0,0 +1,6 @@
+export { readGitHubWorkflowEnv } from "./readGitHubWorkflowEnv.js"
+export { commentGitHubPullRequestImpact } from "./commentGitHubPullRequestImpact.js"
+
+// not planned to be documented but can be useful
+// to get a github comment from a { warnings, body } object
+export { createGitHubPullRequestCommentText } from "./internal/createGitHubPullRequestCommentText.js"

package/src/readGitHubWorkflowEnv.js

@@ -28,7 +28,7 @@ export const readGitHubWorkflowEnv = () => {
       }
     : undefined
   return {
-    projectDirectoryUrl: process.env.GITHUB_WORKSPACE,
+    rootDirectoryUrl: process.env.GITHUB_WORKSPACE,
     githubToken,
     repositoryOwner,
     repositoryName,

package/main.js

@@ -1,6 +0,0 @@
-export { readGitHubWorkflowEnv } from "./src/readGitHubWorkflowEnv.js"
-export { commentGitHubPullRequestImpact } from "./src/commentGitHubPullRequestImpact.js"
-
-// not planned to be documented but can be useful
-// to get a github comment from a { warnings, body } object
-export { createGitHubPullRequestCommentText } from "./src/internal/createGitHubPullRequestCommentText.js"