generate skeletons

.github/workflows/ci.yml

@@ -60,6 +60,7 @@ jobs:
     - run: yarn test-legacy-javascript
     - run: yarn i18n:checks
     - run: yarn dogfood-lhci
+    - run: yarn generate-insight-audits
 
     # Fail if any changes were written to any source files or generated untracked files (ex, from: build/build-cdt-lib.js).
     - run: git add -A && git diff --cached --exit-code

core/audits/insights/README.md

@@ -0,0 +1,3 @@
+# Insight audits
+
+When adding new insight audits, you can start off by just running `yarn generate-insight-audits`

core/audits/insights/cls-culprits-insight.js

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {UIStrings} from '@paulirish/trace_engine/models/trace/insights/CLSCulprits.js';
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {adaptInsightToAuditProduct, makeNodeItemForNodeId} from './insight-audit.js';
+
+// eslint-disable-next-line max-len
+const str_ = i18n.createIcuMessageFn('node_modules/@paulirish/trace_engine/models/trace/insights/CLSCulprits.js', UIStrings);
+
+class CLSCulpritsInsight extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'cls-culprits-insight',
+      title: str_(UIStrings.title),
+      description: str_(UIStrings.description),
+      guidanceLevel: 3, // TODO: confirm/change.
+      requiredArtifacts: ['traces', 'TraceElements'],
+      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS, // TODO: confirm/change.
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    // TODO: implement.
+    return adaptInsightToAuditProduct(artifacts, context, 'CLSCulprits', (insight) => {
+      /** @type {LH.Audit.Details.Table['headings']} */
+      const headings = [
+      ];
+      /** @type {LH.Audit.Details.Table['items']} */
+      const items = [
+      ];
+      return Audit.makeTableDetails(headings, items);
+    });
+  }
+}
+
+export default CLSCulpritsInsight;

core/audits/insights/document-latency-insight.js

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {UIStrings} from '@paulirish/trace_engine/models/trace/insights/DocumentLatency.js';
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {adaptInsightToAuditProduct, makeNodeItemForNodeId} from './insight-audit.js';
+
+// eslint-disable-next-line max-len
+const str_ = i18n.createIcuMessageFn('node_modules/@paulirish/trace_engine/models/trace/insights/DocumentLatency.js', UIStrings);
+
+class DocumentLatencyInsight extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'document-latency-insight',
+      title: str_(UIStrings.title),
+      description: str_(UIStrings.description),
+      guidanceLevel: 3, // TODO: confirm/change.
+      requiredArtifacts: ['traces', 'TraceElements'],
+      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS, // TODO: confirm/change.
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    // TODO: implement.
+    return adaptInsightToAuditProduct(artifacts, context, 'DocumentLatency', (insight) => {
+      /** @type {LH.Audit.Details.Table['headings']} */
+      const headings = [
+      ];
+      /** @type {LH.Audit.Details.Table['items']} */
+      const items = [
+      ];
+      return Audit.makeTableDetails(headings, items);
+    });
+  }
+}
+
+export default DocumentLatencyInsight;

core/audits/insights/font-display-insight.js

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {UIStrings} from '@paulirish/trace_engine/models/trace/insights/FontDisplay.js';
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {adaptInsightToAuditProduct, makeNodeItemForNodeId} from './insight-audit.js';
+
+// eslint-disable-next-line max-len
+const str_ = i18n.createIcuMessageFn('node_modules/@paulirish/trace_engine/models/trace/insights/FontDisplay.js', UIStrings);
+
+class FontDisplayInsight extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'font-display-insight',
+      title: str_(UIStrings.title),
+      description: str_(UIStrings.description),
+      guidanceLevel: 3, // TODO: confirm/change.
+      requiredArtifacts: ['traces', 'TraceElements'],
+      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS, // TODO: confirm/change.
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    // TODO: implement.
+    return adaptInsightToAuditProduct(artifacts, context, 'FontDisplay', (insight) => {
+      /** @type {LH.Audit.Details.Table['headings']} */
+      const headings = [
+      ];
+      /** @type {LH.Audit.Details.Table['items']} */
+      const items = [
+      ];
+      return Audit.makeTableDetails(headings, items);
+    });
+  }
+}
+
+export default FontDisplayInsight;

core/audits/insights/forced-reflow-insight.js

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {UIStrings} from '@paulirish/trace_engine/models/trace/insights/ForcedReflow.js';
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {adaptInsightToAuditProduct, makeNodeItemForNodeId} from './insight-audit.js';
+
+// eslint-disable-next-line max-len
+const str_ = i18n.createIcuMessageFn('node_modules/@paulirish/trace_engine/models/trace/insights/ForcedReflow.js', UIStrings);
+
+class ForcedReflowInsight extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'forced-reflow-insight',
+      title: str_(UIStrings.title),
+      description: str_(UIStrings.description),
+      guidanceLevel: 3, // TODO: confirm/change.
+      requiredArtifacts: ['traces', 'TraceElements'],
+      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS, // TODO: confirm/change.
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    // TODO: implement.
+    return adaptInsightToAuditProduct(artifacts, context, 'ForcedReflow', (insight) => {
+      /** @type {LH.Audit.Details.Table['headings']} */
+      const headings = [
+      ];
+      /** @type {LH.Audit.Details.Table['items']} */
+      const items = [
+      ];
+      return Audit.makeTableDetails(headings, items);
+    });
+  }
+}
+
+export default ForcedReflowInsight;

core/audits/insights/image-delivery-insight.js

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {UIStrings} from '@paulirish/trace_engine/models/trace/insights/ImageDelivery.js';
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {adaptInsightToAuditProduct, makeNodeItemForNodeId} from './insight-audit.js';
+
+// eslint-disable-next-line max-len
+const str_ = i18n.createIcuMessageFn('node_modules/@paulirish/trace_engine/models/trace/insights/ImageDelivery.js', UIStrings);
+
+class ImageDeliveryInsight extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'image-delivery-insight',
+      title: str_(UIStrings.title),
+      description: str_(UIStrings.description),
+      guidanceLevel: 3, // TODO: confirm/change.
+      requiredArtifacts: ['traces', 'TraceElements'],
+      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS, // TODO: confirm/change.
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    // TODO: implement.
+    return adaptInsightToAuditProduct(artifacts, context, 'ImageDelivery', (insight) => {
+      /** @type {LH.Audit.Details.Table['headings']} */
+      const headings = [
+      ];
+      /** @type {LH.Audit.Details.Table['items']} */
+      const items = [
+      ];
+      return Audit.makeTableDetails(headings, items);
+    });
+  }
+}
+
+export default ImageDeliveryInsight;

core/audits/insights/interaction-to-next-paint-insight.js

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {UIStrings} from '@paulirish/trace_engine/models/trace/insights/InteractionToNextPaint.js';
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {adaptInsightToAuditProduct, makeNodeItemForNodeId} from './insight-audit.js';
+
+// eslint-disable-next-line max-len
+const str_ = i18n.createIcuMessageFn('node_modules/@paulirish/trace_engine/models/trace/insights/InteractionToNextPaint.js', UIStrings);
+
+class InteractionToNextPaintInsight extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'interaction-to-next-paint-insight',
+      title: str_(UIStrings.title),
+      description: str_(UIStrings.description),
+      guidanceLevel: 3, // TODO: confirm/change.
+      requiredArtifacts: ['traces', 'TraceElements'],
+      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS, // TODO: confirm/change.
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    // TODO: implement.
+    return adaptInsightToAuditProduct(artifacts, context, 'InteractionToNextPaint', (insight) => {
+      /** @type {LH.Audit.Details.Table['headings']} */
+      const headings = [
+      ];
+      /** @type {LH.Audit.Details.Table['items']} */
+      const items = [
+      ];
+      return Audit.makeTableDetails(headings, items);
+    });
+  }
+}
+
+export default InteractionToNextPaintInsight;

core/audits/insights/lcp-discovery-insight.js

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {UIStrings} from '@paulirish/trace_engine/models/trace/insights/LCPDiscovery.js';
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {adaptInsightToAuditProduct, makeNodeItemForNodeId} from './insight-audit.js';
+
+// eslint-disable-next-line max-len
+const str_ = i18n.createIcuMessageFn('node_modules/@paulirish/trace_engine/models/trace/insights/LCPDiscovery.js', UIStrings);
+
+class LCPDiscoveryInsight extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'lcp-discovery-insight',
+      title: str_(UIStrings.title),
+      description: str_(UIStrings.description),
+      guidanceLevel: 3, // TODO: confirm/change.
+      requiredArtifacts: ['traces', 'TraceElements'],
+      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS, // TODO: confirm/change.
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    // TODO: implement.
+    return adaptInsightToAuditProduct(artifacts, context, 'LCPDiscovery', (insight) => {
+      /** @type {LH.Audit.Details.Table['headings']} */
+      const headings = [
+      ];
+      /** @type {LH.Audit.Details.Table['items']} */
+      const items = [
+      ];
+      return Audit.makeTableDetails(headings, items);
+    });
+  }
+}
+
+export default LCPDiscoveryInsight;