Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

report: isolate viewer type checking #12951

Merged
merged 1 commit into from
Aug 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lighthouse-viewer/app/src/lighthouse-report-viewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ export class LighthouseReportViewer {
_replaceReportHtml(json) {
// Allow users to view the runnerResult
if ('lhr' in json) {
const runnerResult = /** @type {LH.RunnerResult} */ (/** @type {unknown} */ (json));
const runnerResult = /** @type {{lhr: LH.Result}} */ (/** @type {unknown} */ (json));
json = runnerResult.lhr;
}
// Allow users to drop in PSI's json
Expand Down
29 changes: 26 additions & 3 deletions lighthouse-viewer/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
{
"extends": "../tsconfig",
"compilerOptions": {
"composite": true,
"outDir": "../.tmp/tsbuildinfo/lighthouse-viewer",
"emitDeclarationOnly": true,
"declarationMap": true,

// Limit to base JS and DOM defs.
"lib": ["es2020", "dom", "dom.iterable"],
// Don't include any types from node_modules.
"types": [],
"target": "es2020",
"module": "es2020",
"moduleResolution": "node",
"esModuleInterop": true,
"composite": false,

"allowJs": true,
"checkJs": true,
"strict": true,
// TODO: remove the next line to be fully `strict`.
"useUnknownInCatchVariables": false,

// "listFiles": true,
// "noErrorTruncation": true,
"extendedDiagnostics": true,
},
"include": [
"app/src/**/*.js",
"../types/**/*.d.ts",
"./types/*.d.ts",
],
"references": [
{"path": "../types/lhr/"},
{"path": "../report/"}
],
}
10 changes: 4 additions & 6 deletions lighthouse-viewer/types/viewer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@
import _ReportGenerator = require('../../report/generator/report-generator.js');
import {Logger as _Logger} from '../../report/renderer/logger.js';
import {LighthouseReportViewer as _LighthouseReportViewer} from '../app/src/lighthouse-report-viewer.js';
import 'google.analytics';
import {FirebaseNamespace} from '@firebase/app-types';
import _ReportResult from '../../report/types/report-result';

// Import for needed DOM type augmentation.
import '../../report/types/augment-dom';

// Import for LH globals needed for report files.
import '../../report/types/html-renderer';

declare global {
var ReportGenerator: typeof _ReportGenerator;
var logger: _Logger;
Expand All @@ -26,9 +29,4 @@ declare global {
// Inserted by viewer build.
LH_CURRENT_VERSION: string;
}

// Expose global types in LH namespace.
module LH {
export import ReportResult = _ReportResult;
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"dogfood-lhci": "./lighthouse-core/scripts/dogfood-lhci.sh",
"timing-trace": "node lighthouse-core/scripts/generate-timing-trace.js",
"changelog": "conventional-changelog --config ./build/changelog-generator/index.js --infile changelog.md --same-file",
"type-check": "tsc -b . && tsc -b report/ && tsc -p lighthouse-viewer/ && tsc -p lighthouse-treemap/ && tsc -p flow-report/",
"type-check": "tsc --build ./ report/ lighthouse-viewer/ && tsc -p lighthouse-treemap/ && tsc -p flow-report/",
"i18n:checks": "./lighthouse-core/scripts/i18n/assert-strings-collected.sh",
"i18n:collect-strings": "node lighthouse-core/scripts/i18n/collect-strings.js",
"update:lantern-baseline": "node lighthouse-core/scripts/lantern/update-baseline-lantern-values.js",
Expand Down
2 changes: 1 addition & 1 deletion report/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

// Limit to base JS and DOM defs.
"lib": ["es2020", "dom", "dom.iterable"],
// Don't include any node_module types.
// Don't include any types from node_modules.
"types": [],
"target": "es2020",
"module": "es2020",
Expand Down