From b714d1666e0feebf81d095efe99b33940e0014d4 Mon Sep 17 00:00:00 2001 From: Brendan Kenny Date: Thu, 19 Aug 2021 16:11:14 -0500 Subject: [PATCH] readme feedback --- report/README.md | 2 +- report/generator/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/report/README.md b/report/README.md index c4d4fc2c9cf9..9b2c89f69596 100644 --- a/report/README.md +++ b/report/README.md @@ -9,7 +9,7 @@ Example standalone HTML report, delivered by the CLI: [`dbwtest-3.0.3.html`](htt ### Report Renderer components 1. [`report/generator/report-generator.js`](https://github.com/GoogleChrome/lighthouse/blob/master/report/generator/report-generator.js) is the entry point for generating the HTML from Node. It compiles together the HTML string with everything required within it. - - It runs natively in Node.js but can run in the browser after a compile step is applied during our bundling pipeline. That compile step uses a browserify transform that takes any `fs.readFileSync()` calls and replaces them with the stringified file content. + - It runs natively in Node.js but can run in the browser after a compile step is applied during our bundling pipeline. That compile step uses `brfs`, which takes any `fs.readFileSync()` calls and replaces them with the stringified file content. 1. [`report/renderer`](https://github.com/GoogleChrome/lighthouse/tree/master/report/renderer) are all client-side JS files. They transform an LHR object into a report DOM tree. They are all executed within the browser. 1. [`report/assets/standalone-template.html`](https://github.com/GoogleChrome/lighthouse/blob/master/lighthouse-core/report/html/report-template.html) is where the client-side build of the DOM report is typically kicked off ([with these four lines](https://github.com/GoogleChrome/lighthouse/blob/eda3a3e2e271249f261655f9504fd542d6acf0f8/lighthouse-core/report/html/report-template.html#L29-L33)) However, see _Current Uses.._ below for more possibilities. diff --git a/report/generator/README.md b/report/generator/README.md index c226feb1b208..3c9ef06d2116 100644 --- a/report/generator/README.md +++ b/report/generator/README.md @@ -4,6 +4,6 @@ Lighthouse's report generator is the entry point for creating reports from an **LHR** (Lighthouse Result object). It returns results as HTML, JSON, and CSV. -It runs natively in Node.js but can run in the browser after a compile step is applied during our bundling pipeline. That compile step uses a browserify transform that takes any `fs.readFileSync()` calls and replaces them with the stringified file content. +It runs natively in Node.js but can run in the browser after a compile step is applied during our bundling pipeline. That compile step uses `brfs`, which takes any `fs.readFileSync()` calls and replaces them with the stringified file content. Because it's shared between core and the report, dependencies (both code and types) should be kept minimal.