lighthouse 11.0.0-dev.20230828 → 11.0.0-dev.20230830

package/core/audits/bf-cache.js

@@ -59,6 +59,7 @@ class BFCache extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       supportedModes: ['navigation', 'timespan'],
+      guidanceLevel: 2,
       requiredArtifacts: ['BFCacheFailures'],
     };
   }

package/core/audits/bootup-time.js

@@ -44,6 +44,7 @@ class BootupTime extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 1,
       requiredArtifacts: ['traces', 'devtoolsLogs'],
     };
   }

package/core/audits/byte-efficiency/duplicated-javascript.js

@@ -47,6 +47,7 @@ class DuplicatedJavascript extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 2,
       requiredArtifacts: ['devtoolsLogs', 'traces', 'SourceMaps', 'Scripts',
         'GatherContext', 'URL'],
     };

package/core/audits/byte-efficiency/efficient-animated-content.js

@@ -37,6 +37,7 @@ class EfficientAnimatedContent extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 3,
       requiredArtifacts: ['devtoolsLogs', 'traces', 'GatherContext', 'URL'],
     };
   }

package/core/audits/byte-efficiency/legacy-javascript.js

@@ -118,6 +118,7 @@ class LegacyJavascript extends ByteEfficiencyAudit {
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
       description: str_(UIStrings.description),
       title: str_(UIStrings.title),
+      guidanceLevel: 2,
       requiredArtifacts: ['devtoolsLogs', 'traces', 'Scripts', 'SourceMaps',
         'GatherContext', 'URL'],
     };

package/core/audits/byte-efficiency/modern-image-formats.js

@@ -35,6 +35,7 @@ class ModernImageFormats extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 3,
       requiredArtifacts: ['OptimizedImages', 'devtoolsLogs', 'traces', 'URL', 'GatherContext',
         'ImageElements'],
     };

package/core/audits/byte-efficiency/offscreen-images.js

@@ -50,6 +50,7 @@ class OffscreenImages extends ByteEfficiencyAudit {
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
       supportedModes: ['navigation'],
+      guidanceLevel: 2,
       requiredArtifacts: ['ImageElements', 'ViewportDimensions', 'GatherContext', 'devtoolsLogs',
         'traces', 'URL'],
     };

package/core/audits/byte-efficiency/render-blocking-resources.js

@@ -115,6 +115,7 @@ class RenderBlockingResources extends Audit {
       supportedModes: ['navigation'],
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
       description: str_(UIStrings.description),
+      guidanceLevel: 2,
       // TODO: look into adding an `optionalArtifacts` property that captures the non-required nature
       // of CSSUsage
       requiredArtifacts: ['URL', 'TagsBlockingFirstPaint', 'traces', 'devtoolsLogs', 'CSSUsage',

package/core/audits/byte-efficiency/total-byte-weight.js

@@ -35,6 +35,7 @@ class TotalByteWeight extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 1,
       requiredArtifacts: ['devtoolsLogs'],
     };
   }

package/core/audits/byte-efficiency/unminified-css.js

@@ -35,6 +35,7 @@ class UnminifiedCSS extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 3,
       requiredArtifacts: ['CSSUsage', 'devtoolsLogs', 'traces', 'URL', 'GatherContext'],
     };
   }

package/core/audits/byte-efficiency/unminified-javascript.js

@@ -43,6 +43,7 @@ class UnminifiedJavaScript extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 3,
       requiredArtifacts: ['Scripts', 'devtoolsLogs', 'traces', 'GatherContext', 'URL'],
     };
   }

package/core/audits/byte-efficiency/unused-css-rules.js

@@ -33,6 +33,7 @@ class UnusedCSSRules extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 2,
       requiredArtifacts: ['CSSUsage', 'URL', 'devtoolsLogs', 'traces', 'GatherContext'],
     };
   }

package/core/audits/byte-efficiency/unused-javascript.js

@@ -67,6 +67,7 @@ class UnusedJavaScript extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 2,
       requiredArtifacts: ['JsUsage', 'Scripts', 'SourceMaps', 'GatherContext',
         'devtoolsLogs', 'traces', 'URL'],
     };

package/core/audits/byte-efficiency/uses-long-cache-ttl.js

@@ -45,6 +45,7 @@ class CacheHeaders extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 3,
       requiredArtifacts: ['devtoolsLogs'],
     };
   }

package/core/audits/byte-efficiency/uses-optimized-images.js

@@ -35,6 +35,7 @@ class UsesOptimizedImages extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 2,
       requiredArtifacts: ['OptimizedImages', 'ImageElements', 'GatherContext', 'devtoolsLogs',
         'traces', 'URL'],
     };

package/core/audits/byte-efficiency/uses-responsive-images-snapshot.js

@@ -43,6 +43,7 @@ class UsesResponsiveImagesSnapshot extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: UsesResponsiveImages.str_(UsesResponsiveImages.UIStrings.description),
       supportedModes: ['snapshot'],
+      guidanceLevel: 2,
       requiredArtifacts: ['ImageElements', 'ViewportDimensions'],
     };
   }

package/core/audits/byte-efficiency/uses-responsive-images.js

@@ -46,6 +46,7 @@ class UsesResponsiveImages extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 2,
       requiredArtifacts: ['ImageElements', 'ViewportDimensions', 'GatherContext',
         'devtoolsLogs', 'traces', 'URL'],
     };

package/core/audits/byte-efficiency/uses-text-compression.js

@@ -37,6 +37,7 @@ class ResponsesAreCompressed extends ByteEfficiencyAudit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 3,
       requiredArtifacts: ['ResponseCompression', 'GatherContext', 'devtoolsLogs', 'traces', 'URL'],
     };
   }

package/core/audits/critical-request-chains.js

@@ -37,6 +37,7 @@ class CriticalRequestChains extends Audit {
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
       supportedModes: ['navigation'],
+      guidanceLevel: 1,
       requiredArtifacts: ['traces', 'devtoolsLogs', 'URL'],
     };
   }

package/core/audits/dobetterweb/dom-size.js

@@ -54,6 +54,7 @@ class DOMSize extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 1,
       requiredArtifacts: ['DOMStats', 'URL', 'GatherContext'],
       __internalOptionalArtifacts: ['traces', 'devtoolsLogs'],
     };

package/core/audits/dobetterweb/no-document-write.js

@@ -53,6 +53,7 @@ class NoDocWriteAudit extends ViolationAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      guidanceLevel: 2,
       requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts'],
     };
   }

package/core/audits/dobetterweb/uses-http2.js

@@ -62,6 +62,7 @@ class UsesHTTP2Audit extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 3,
       supportedModes: ['timespan', 'navigation'],
       requiredArtifacts: ['URL', 'devtoolsLogs', 'traces', 'GatherContext'],
     };

package/core/audits/dobetterweb/uses-passive-event-listeners.js

@@ -36,6 +36,7 @@ class PassiveEventsAudit extends ViolationAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      guidanceLevel: 3,
       requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts'],
     };
   }

package/core/audits/font-display.js

@@ -49,6 +49,7 @@ class FontDisplay extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
+      guidanceLevel: 3,
       requiredArtifacts: ['devtoolsLogs', 'CSSUsage', 'URL'],
     };
   }

package/core/audits/largest-contentful-paint-element.js

@@ -47,6 +47,7 @@ class LargestContentfulPaintElement extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
+      guidanceLevel: 1,
       supportedModes: ['navigation'],
       requiredArtifacts:
         ['traces', 'TraceElements', 'devtoolsLogs', 'GatherContext', 'settings', 'URL'],

package/core/audits/layout-shift-elements.js

@@ -29,6 +29,7 @@ class LayoutShiftElements extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
+      guidanceLevel: 2,
       requiredArtifacts: ['traces', 'TraceElements'],
     };
   }

package/core/audits/lcp-lazy-loaded.js

@@ -33,6 +33,7 @@ class LargestContentfulPaintLazyLoaded extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
+      guidanceLevel: 3,
       requiredArtifacts: ['TraceElements', 'ViewportDimensions', 'ImageElements',
         'traces', 'devtoolsLogs', 'GatherContext', 'URL'],
     };

package/core/audits/long-tasks.js

@@ -66,6 +66,7 @@ class LongTasks extends Audit {
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
+      guidanceLevel: 1,
       requiredArtifacts: ['traces', 'devtoolsLogs', 'URL'],
     };
   }

package/core/audits/mainthread-work-breakdown.js

@@ -42,6 +42,7 @@ class MainThreadWorkBreakdown extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      guidanceLevel: 1,
       requiredArtifacts: ['traces'],
     };
   }

package/core/audits/non-composited-animations.js

@@ -110,6 +110,7 @@ class NonCompositedAnimations extends Audit {
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
+      guidanceLevel: 2,
       requiredArtifacts: ['TraceElements', 'HostUserAgent'],
     };
   }

package/core/audits/prioritize-lcp-image.js

@@ -38,6 +38,7 @@ class PrioritizeLcpImage extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
+      guidanceLevel: 3,
       requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext', 'URL', 'TraceElements'],
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
     };

package/core/audits/redirects.js

@@ -31,6 +31,7 @@ class Redirects extends Audit {
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
       supportedModes: ['navigation'],
+      guidanceLevel: 2,
       requiredArtifacts: ['URL', 'GatherContext', 'devtoolsLogs', 'traces'],
     };
   }

package/core/audits/server-response-time.js

@@ -37,6 +37,7 @@ class ServerResponseTime extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
+      guidanceLevel: 1,
       requiredArtifacts: ['devtoolsLogs', 'URL', 'GatherContext'],
     };
   }

package/core/audits/third-party-facades.js

@@ -86,6 +86,7 @@ class ThirdPartyFacades extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
+      guidanceLevel: 3,
       requiredArtifacts: ['traces', 'devtoolsLogs', 'URL', 'GatherContext'],
     };
   }

package/core/audits/third-party-summary.js

@@ -74,6 +74,7 @@ class ThirdPartySummary extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      guidanceLevel: 1,
       requiredArtifacts: ['traces', 'devtoolsLogs', 'URL', 'GatherContext'],
     };
   }

package/core/audits/unsized-images.js

@@ -34,6 +34,7 @@ class UnsizedImages extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      guidanceLevel: 3,
       requiredArtifacts: ['ImageElements'],
     };
   }

package/core/audits/user-timings.js

@@ -39,6 +39,7 @@ class UserTimings extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
+      guidanceLevel: 2,
       requiredArtifacts: ['traces'],
     };
   }

package/core/audits/uses-rel-preconnect.js

@@ -62,6 +62,7 @@ class UsesRelPreconnectAudit extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
+      guidanceLevel: 3,
       requiredArtifacts: ['traces', 'devtoolsLogs', 'URL', 'LinkElements'],
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
     };

package/core/audits/uses-rel-preload.js

@@ -43,6 +43,7 @@ class UsesRelPreloadAudit extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
+      guidanceLevel: 3,
       requiredArtifacts: ['devtoolsLogs', 'traces', 'URL'],
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
     };

package/core/audits/viewport.js

@@ -34,6 +34,7 @@ class Viewport extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      guidanceLevel: 3,
       requiredArtifacts: ['MetaElements'],
     };
   }

package/core/audits/work-during-interaction.js

@@ -60,6 +60,7 @@ class WorkDuringInteraction extends Audit {
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
       supportedModes: ['timespan'],
+      guidanceLevel: 1,
       requiredArtifacts: ['traces', 'devtoolsLogs', 'TraceElements'],
     };
   }

package/core/config/config-helpers.js

@@ -16,7 +16,7 @@ import ConfigPlugin from './config-plugin.js';
 import {Runner} from '../runner.js';
 import * as i18n from '../lib/i18n/i18n.js';
 import * as validation from './validation.js';
-import {getModuleDirectory} from '../../esm-utils.js';
+import {getModuleDirectory} from '../../shared/esm-utils.js';
 
 const require = createRequire(import.meta.url);
 

package/core/config/config.js

@@ -28,7 +28,7 @@ import {
   mergeConfigFragment,
   mergeConfigFragmentArrayByKey,
 } from './config-helpers.js';
-import {getModuleDirectory} from '../../esm-utils.js';
+import {getModuleDirectory} from '../../shared/esm-utils.js';
 import * as format from '../../shared/localization/format.js';
 
 const defaultConfigPath = path.join(

package/core/lib/i18n/i18n.js

@@ -15,7 +15,7 @@ import log from 'lighthouse-logger';
 import {getAvailableLocales} from '../../../shared/localization/format.js';
 import {LH_ROOT} from '../../../root.js';
 import {isIcuMessage, formatMessage, DEFAULT_LOCALE} from '../../../shared/localization/format.js';
-import {getModulePath} from '../../../esm-utils.js';
+import {getModulePath} from '../../../shared/esm-utils.js';
 
 const UIStrings = {
   /** Used to show the duration in milliseconds that something lasted. The `{timeInMs}` placeholder will be replaced with the time duration, shown in milliseconds (e.g. 63 ms) */

package/core/runner.js

@@ -20,7 +20,7 @@ import {Sentry} from './lib/sentry.js';
 import {ReportGenerator} from '../report/generator/report-generator.js';
 import {LighthouseError} from './lib/lh-error.js';
 import {lighthouseVersion} from '../root.js';
-import {getModuleDirectory} from '../esm-utils.js';
+import {getModuleDirectory} from '../shared/esm-utils.js';
 import {EntityClassification} from './computed/entity-classification.js';
 import UrlUtils from './lib/url-utils.js';
 

package/flow-report/tsconfig.json

@@ -21,7 +21,6 @@
     "./types",
     "../types/internal/test.d.ts",
     "../root.js",
-    "../esm-utils.js",
     "../core/test/test-env/fake-timers.js",
   ],
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "11.0.0-dev.20230828",
+  "version": "11.0.0-dev.20230830",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {

package/report/generator/flow-report-assets.js

@@ -7,7 +7,7 @@
 
 import fs from 'fs';
 
-import {getModuleDirectory} from '../../esm-utils.js';
+import {getModuleDirectory} from '../../shared/esm-utils.js';
 
 const moduleDir = getModuleDirectory(import.meta);
 

package/report/generator/report-assets.js

@@ -8,7 +8,7 @@
 import fs from 'fs';
 
 import {flowReportAssets} from './flow-report-assets.js';
-import {getModuleDirectory} from '../../esm-utils.js';
+import {getModuleDirectory} from '../../shared/esm-utils.js';
 
 const moduleDir = getModuleDirectory(import.meta);
 

package/report/generator/tsconfig.json

@@ -8,9 +8,9 @@
   },
   "references": [
     {"path": "../../types/lhr/"},
+    {"path": "../../shared/"},
   ],
   "include": [
     "**/*.js",
-    "../../esm-utils.js",
   ],
 }

package/root.js

@@ -6,7 +6,7 @@
 
 import fs from 'fs';
 
-import {getModuleDirectory} from './esm-utils.js';
+import {getModuleDirectory} from './shared/esm-utils.js';
 
 const LH_ROOT = getModuleDirectory(import.meta);
 const pkg = JSON.parse(fs.readFileSync(`${LH_ROOT}/package.json`, 'utf-8'));

package/shared/localization/format.js

@@ -8,7 +8,7 @@ import fs from 'fs';
 
 import IntlMessageFormat from 'intl-messageformat';
 
-import {getModuleDirectory} from '../../esm-utils.js';
+import {getModuleDirectory} from '../esm-utils.js';
 import {isObjectOfUnknownValues, isObjectOrArrayOfUnknownValues} from '../type-verifiers.js';
 import {locales} from './locales.js';
 

package/shared/localization/locales.js

@@ -23,7 +23,7 @@
 
 import fs from 'fs';
 
-import {getModuleDirectory} from '../../esm-utils.js';
+import {getModuleDirectory} from '../esm-utils.js';
 
 /** @typedef {import('../../types/lhr/settings').Locale} Locale */
 /** @typedef {Record<string, {message: string}>} LhlMessages */

package/shared/tsconfig.json

@@ -13,7 +13,6 @@
   "include": [
     "**/*.js",
     "types/**/*.d.ts",
-    "../esm-utils.js",
   ],
   "exclude": [
     "test/**/*.js",

package/tsconfig.json

@@ -12,7 +12,6 @@
   ],
   "include": [
     "root.js",
-    "esm-utils.js",
     "cli/**/*.js",
     "core/**/*.js",
     "core/index.cjs",

package/types/audit.d.ts

@@ -54,6 +54,8 @@ declare module Audit {
     scoreDisplayMode?: AuditResult.ScoreDisplayMode;
     /** A list of gather modes that this audit is applicable to. */
     supportedModes?: Gatherer.GatherMode[],
+    /** A number indicating how much guidance Lighthouse provides to solve the problem in this audit on a 1-3 scale. Higher means more guidance. */
+    guidanceLevel?: number;
   }
 
   interface ByteEfficiencyItem extends AuditDetails.OpportunityItem {