@jsenv/lighthouse-impact 2.1.9 → 2.2.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",
+  lighthouseReportPath: new URL(
+    "./lighthouse.mjs#lighthouseReport",
+    import.meta.url,
+  ),
 })
 ```
 
@@ -162,7 +165,7 @@ The example below assume code is executed by Travis.
 
 reportLighthouseImpact({
 -  ...readGitHubWorkflowEnv(),
-+  projectDirectoryUrl: process.env.TRAVIS_BUILD_DIR,
++  rootDirectoryUrl: process.env.TRAVIS_BUILD_DIR,
 +  repositoryOwner: process.env.TRAVIS_REPO_SLUG.split("/")[0],
 +  repositoryName: process.env.TRAVIS_REPO_SLUG.split("/")[1],
 +  pullRequestNumber: process.env.TRAVIS_PULL_REQUEST,
@@ -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.9",
+  "version": "2.2.0",
   "description": "Package description",
   "license": "MIT",
   "author": {
@@ -34,7 +34,6 @@
   ],
   "scripts": {
     "eslint": "npx eslint . --ext=.js,.mjs",
-    "importmap": "node ./script/importmap/importmap.mjs",
     "snapshot": "node ./test/comment/generate_comment_snapshot_file.mjs",
     "test": "node ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
@@ -43,20 +42,10 @@
   "dependencies": {
     "@jsenv/abort": "4.1.2",
     "@jsenv/dynamic-import-worker": "1.0.1",
-    "@jsenv/filesystem": "2.7.1",
-    "@jsenv/github-pull-request-impact": "1.6.10",
+    "@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"
-  },
-  "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"
   }
 }

package/src/generateLighthouseReport.js

@@ -31,7 +31,7 @@ export const generateLighthouseReport = async (
     runCount = 1,
     delayBetweenEachRunInSeconds = 1,
 
-    projectDirectoryUrl, // required only when jsonFile or htmlFile is passed
+    rootDirectoryUrl, // required only when jsonFile or htmlFile is passed
     log = false,
     jsonFile = false,
     jsonFileRelativeUrl = "./lighthouse/lighthouse_report.json",
@@ -118,17 +118,14 @@ export const generateLighthouseReport = async (
     await chrome.kill()
 
     if (jsonFile || htmlFile) {
-      projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
+      rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
     }
 
     const promises = []
     if (jsonFile) {
       promises.push(
         (async () => {
-          const jsonFileUrl = resolveUrl(
-            jsonFileRelativeUrl,
-            projectDirectoryUrl,
-          )
+          const jsonFileUrl = resolveUrl(jsonFileRelativeUrl, rootDirectoryUrl)
           const json = JSON.stringify(lighthouseReport, null, "  ")
           await writeFile(jsonFileUrl, json)
           if (jsonFileLog) {
@@ -140,10 +137,7 @@ export const generateLighthouseReport = async (
     if (htmlFile) {
       promises.push(
         (async () => {
-          const htmlFileUrl = resolveUrl(
-            htmlFileRelativeUrl,
-            projectDirectoryUrl,
-          )
+          const htmlFileUrl = resolveUrl(htmlFileRelativeUrl, rootDirectoryUrl)
           const html = ReportGenerator.generateReportHtml(lighthouseReport)
           await writeFile(htmlFileUrl, html)
           if (htmlFileLog) {

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"
 
@@ -9,7 +9,7 @@ export const reportLighthouseImpact = async ({
   logLevel,
   commandLogs = false,
   cancelOnSIGINT,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
 
   githubToken,
   repositoryOwner,
@@ -23,17 +23,17 @@ export const reportLighthouseImpact = async ({
   catchError,
   skipGistWarning = false,
 }) => {
-  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
-  if (typeof lighthouseReportPath !== "string") {
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
+  let lighthouseReportUrl
+  if (lighthouseReportPath === "string") {
+    lighthouseReportUrl = new URL(lighthouseReportPath, rootDirectoryUrl).href
+  } else if (lighthouseReportPath instanceof URL) {
+    lighthouseReportUrl = lighthouseReportPath.href
+  } else {
     throw new TypeError(
-      `lighthouseReportPath must be a string but received ${lighthouseReportPath}`,
+      `lighthouseReportPath must be a string or an url but received ${lighthouseReportPath}`,
     )
   }
-  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
-  const lighthouseReportUrl = resolveUrl(
-    lighthouseReportPath,
-    projectDirectoryUrl,
-  )
 
   return commentGitHubPullRequestImpact({
     logLevel,
@@ -41,15 +41,15 @@ export const reportLighthouseImpact = async ({
     // lighthouse report are super verbose, do not log them
     infoLogs: false,
     cancelOnSIGINT,
-    projectDirectoryUrl,
+    rootDirectoryUrl,
 
     githubToken,
     repositoryOwner,
     repositoryName,
     pullRequestNumber,
 
-    collectInfo: async ({ execCommandInProjectDirectory }) => {
-      await execCommandInProjectDirectory(installCommand)
+    collectInfo: async ({ execCommandInRootDirectory }) => {
+      await execCommandInRootDirectory(installCommand)
       const lighthouseReport = await importOneExportFromFile(
         lighthouseReportUrl,
       )