@jsenv/lighthouse-impact 2.1.10 → 3.0.0

package/README.md

@@ -69,7 +69,7 @@ _index.html_
 </html>
 ```
 
-At this stage, you could generate a lighthouse report on your machine. For an example, see [package.json#L37](./package.json#L37) and [script/lighthouse/lighthouse.mjs#L19](./script/lighthouse/lighthouse.mjs#L19).
+At this stage, you could generate a lighthouse report on your machine.
 
 Now it's time to configure a workflow to compare lighthouse reports before and after merging a pull request.
 
@@ -125,7 +125,10 @@ import {
 
 await reportLighthouseImpact({
   ...readGitHubWorkflowEnv(),
-  lighthouseReportPath: "./lighthouse.mjs#lighthouseReport",
+  lighthouseReportUrl: new URL(
+    "./lighthouse.mjs#lighthouseReport",
+    import.meta.url,
+  ),
 })
 ```
 
@@ -167,7 +170,7 @@ reportLighthouseImpact({
 +  repositoryName: process.env.TRAVIS_REPO_SLUG.split("/")[1],
 +  pullRequestNumber: process.env.TRAVIS_PULL_REQUEST,
 +  githubToken: process.env.GITHUB_TOKEN, // see next step
-   lighthouseReportPath: "./lighthouse.mjs#lighthouseReport",
+   lighthouseReportUrl: "./lighthouse.mjs#lighthouseReport",
 })
 ```
 
@@ -186,7 +189,7 @@ The pull request comment can contain links to see lighthouse reports in [Lightho
 To unlock this you need a GitHub token with the right to create gists.
 Every github workflow has access to a magic token `secrets.GITHUB_TOKEN`.
 But this token is not allowed to create gists.
-We need to update the worflow file like [lighthouse-score-impact.yml#L21](./.github/workflows/lighthouse_impact.yml#L21) to use an other token that will have the rights to create gists.
+We need to update the worflow file to use an other token that will have the rights to create gists.
 
 ```diff
 - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/lighthouse-impact",
-  "version": "2.1.10",
+  "version": "3.0.0",
   "description": "Package description",
   "license": "MIT",
   "author": {
@@ -23,29 +23,25 @@
   "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",
-    "snapshot": "node ./test/comment/generate_comment_snapshot_file.mjs",
-    "test": "node ./script/test/test.mjs",
-    "test-with-coverage": "npm run test -- --coverage",
-    "prettier": "prettier --write ."
+    "snapshot": "node ./tests/comment/generate_comment_snapshot_file.mjs",
+    "test": "node ./scripts/test.mjs"
   },
   "dependencies": {
-    "@jsenv/abort": "4.1.2",
-    "@jsenv/dynamic-import-worker": "1.0.1",
-    "@jsenv/filesystem": "3.1.0",
-    "@jsenv/github-pull-request-impact": "1.6.11",
-    "@jsenv/logger": "4.0.1",
-    "chrome-launcher": "0.15.0",
-    "lighthouse": "9.2.0"
+    "@jsenv/abort": "4.2.3",
+    "@jsenv/dynamic-import-worker": "1.1.0",
+    "@jsenv/filesystem": "4.1.0",
+    "@jsenv/github-pull-request-impact": "1.7.0",
+    "@jsenv/log": "2.1.0",
+    "chrome-launcher": "0.15.1",
+    "lighthouse": "9.6.2"
   }
 }

package/src/generateLighthouseReport.js

@@ -1,13 +1,8 @@
 // https://github.com/GoogleChrome/lighthouse/blob/5a14deb5c4e0ec4e8e58f50ff72b53851b021bcf/docs/readme.md#using-programmatically
 
 import { createRequire } from "node:module"
-
-import {
-  writeFile,
-  resolveUrl,
-  assertAndNormalizeDirectoryUrl,
-} from "@jsenv/filesystem"
-import { createLogger } from "@jsenv/logger"
+import { writeFile, assertAndNormalizeFileUrl } from "@jsenv/filesystem"
+import { createLogger } from "@jsenv/log"
 import { Abort, raceProcessTeardownEvents } from "@jsenv/abort"
 
 import { formatLighthouseReportForLog } from "./internal/formatLighthouseReportForLog.js"
@@ -31,13 +26,10 @@ export const generateLighthouseReport = async (
     runCount = 1,
     delayBetweenEachRunInSeconds = 1,
 
-    rootDirectoryUrl, // required only when jsonFile or htmlFile is passed
     log = false,
-    jsonFile = false,
-    jsonFileRelativeUrl = "./lighthouse/lighthouse_report.json",
+    jsonFileUrl,
     jsonFileLog = true,
-    htmlFile = false,
-    htmlFileRelativeUrl = "./lighthouse/lighthouse_report.html",
+    htmlFileUrl,
     htmlFileLog = true,
   } = {},
 ) => {
@@ -117,15 +109,11 @@ export const generateLighthouseReport = async (
 
     await chrome.kill()
 
-    if (jsonFile || htmlFile) {
-      rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
-    }
-
     const promises = []
-    if (jsonFile) {
+    if (jsonFileUrl) {
+      assertAndNormalizeFileUrl(jsonFileUrl)
       promises.push(
         (async () => {
-          const jsonFileUrl = resolveUrl(jsonFileRelativeUrl, rootDirectoryUrl)
           const json = JSON.stringify(lighthouseReport, null, "  ")
           await writeFile(jsonFileUrl, json)
           if (jsonFileLog) {
@@ -134,10 +122,10 @@ export const generateLighthouseReport = async (
         })(),
       )
     }
-    if (htmlFile) {
+    if (htmlFileUrl) {
+      assertAndNormalizeFileUrl(htmlFileUrl)
       promises.push(
         (async () => {
-          const htmlFileUrl = resolveUrl(htmlFileRelativeUrl, rootDirectoryUrl)
           const html = ReportGenerator.generateReportHtml(lighthouseReport)
           await writeFile(htmlFileUrl, html)
           if (htmlFileLog) {

package/src/internal/patchOrPostGists.js

@@ -1,5 +1,5 @@
 import * as githubRESTAPI from "@jsenv/github-pull-request-impact/src/internal/github_rest_api.js"
-import { createDetailedMessage } from "@jsenv/logger"
+import { createDetailedMessage } from "@jsenv/log"
 
 // https://developer.github.com/v3/gists/#create-a-gist
 

package/src/main.js

@@ -0,0 +1,4 @@
+export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
+
+export { generateLighthouseReport } from "./generateLighthouseReport.js"
+export { reportLighthouseImpact } from "./reportLighthouseImpact.js"

package/src/reportLighthouseImpact.js

@@ -1,4 +1,4 @@
-import { assertAndNormalizeDirectoryUrl, resolveUrl } from "@jsenv/filesystem"
+import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
 import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
 import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 
@@ -16,7 +16,7 @@ export const reportLighthouseImpact = async ({
   repositoryName,
   pullRequestNumber,
   installCommand = "npm install",
-  lighthouseReportPath,
+  lighthouseReportUrl,
 
   runLink,
   commitInGeneratedByInfo,
@@ -24,13 +24,14 @@ export const reportLighthouseImpact = async ({
   skipGistWarning = false,
 }) => {
   rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
-  if (typeof lighthouseReportPath !== "string") {
+  if (lighthouseReportUrl === "string") {
+    lighthouseReportUrl = new URL(lighthouseReportUrl, rootDirectoryUrl).href
+  } else if (lighthouseReportUrl instanceof URL) {
+  } else {
     throw new TypeError(
-      `lighthouseReportPath must be a string but received ${lighthouseReportPath}`,
+      `lighthouseReportUrl must be a string or an url but received ${lighthouseReportUrl}`,
     )
   }
-  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
-  const lighthouseReportUrl = resolveUrl(lighthouseReportPath, rootDirectoryUrl)
 
   return commentGitHubPullRequestImpact({
     logLevel,
@@ -45,8 +46,8 @@ export const reportLighthouseImpact = async ({
     repositoryName,
     pullRequestNumber,
 
-    collectInfo: async ({ execCommandInProjectDirectory }) => {
-      await execCommandInProjectDirectory(installCommand)
+    collectInfo: async ({ execCommandInRootDirectory }) => {
+      await execCommandInRootDirectory(installCommand)
       const lighthouseReport = await importOneExportFromFile(
         lighthouseReportUrl,
       )

package/main.js

@@ -1,4 +0,0 @@
-export { generateLighthouseReport } from "./src/generateLighthouseReport.js"
-
-export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
-export { reportLighthouseImpact } from "./src/reportLighthouseImpact.js"