report: rename i18n to i18n-formatter, move strings to Util #13933
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -77,7 +77,7 @@ const SidebarHeader: FunctionComponent<{title: string, date: string}> = ({title, | |
| return ( | ||
| <div className="SidebarHeader"> | ||
| <div className="SidebarHeader__title">{title}</div> | ||
| <div className="SidebarHeader__date">{i18n.formatter.formatDateTime(date)}</div> | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -132,7 +132,7 @@ const SummaryTooltip: FunctionComponent<{ | |
| { | ||
| !displayAsFraction && category.score !== null && <> | ||
| <span> · </span> | ||
| <span>{i18n.formatter.formatInteger(category.score * 100)}</span> | ||
| </> | ||
| } | ||
| </div> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,10 +39,10 @@ export class CategoryRenderer { | |
| */ | ||
| get _clumpTitles() { | ||
| return { | ||
| warning: Util.strings.warningAuditsGroupTitle, | ||
| manual: Util.strings.manualAuditsGroupTitle, | ||
| passed: Util.strings.passedAuditsGroupTitle, | ||
| notApplicable: Util.strings.notApplicableAuditsGroupTitle, | ||
| }; | ||
| } | ||
|
|
||
|
|
@@ -62,7 +62,7 @@ export class CategoryRenderer { | |
| * @return {!Element} | ||
| */ | ||
| populateAuditValues(audit, component) { | ||
| const strings = Util.strings; | ||
| const auditEl = this.dom.find('.lh-audit', component); | ||
| auditEl.id = audit.result.id; | ||
| const scoreDisplayMode = audit.result.scoreDisplayMode; | ||
|
|
@@ -334,8 +334,8 @@ export class CategoryRenderer { | |
| el.append(descriptionEl); | ||
| } | ||
|
|
||
| this.dom.find('.lh-clump-toggletext--show', el).textContent = Util.strings.show; | ||
| this.dom.find('.lh-clump-toggletext--hide', el).textContent = Util.strings.hide; | ||
|
|
||
| clumpElement.classList.add(`lh-clump--${clumpId.toLowerCase()}`); | ||
| return el; | ||
|
|
@@ -393,7 +393,7 @@ export class CategoryRenderer { | |
| percentageEl.textContent = scoreOutOf100.toString(); | ||
| if (category.score === null) { | ||
| percentageEl.textContent = '?'; | ||
| percentageEl.title = Util.strings.errorLabel; | ||
| } | ||
|
|
||
| // Render a numerical score if the category has applicable audits, or no audits whatsoever. | ||
|
|
@@ -402,7 +402,7 @@ export class CategoryRenderer { | |
| } else { | ||
| wrapper.classList.add(`lh-gauge__wrapper--not-applicable`); | ||
| percentageEl.textContent = '-'; | ||
| percentageEl.title = Util.strings.notApplicableAuditsGroupTitle; | ||
| } | ||
|
|
||
| this.dom.find('.lh-gauge__label', tmpl).textContent = category.title; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -136,7 +136,8 @@ class CriticalRequestChainRenderer { | |
| if (!segment.hasChildren) { | ||
| const {startTime, endTime, transferSize} = segment.node.request; | ||
| const span = dom.createElement('span', 'lh-crc-node__chain-duration'); | ||
| span.textContent = | ||
| ' - ' + Util.i18n.formatMilliseconds((endTime - startTime) * 1000) + ', '; | ||
| const span2 = dom.createElement('span', 'lh-crc-node__chain-duration'); | ||
| span2.textContent = Util.i18n.formatBytesToKiB(transferSize, 0.01); | ||
|
|
||
|
|
@@ -177,9 +178,9 @@ class CriticalRequestChainRenderer { | |
| const containerEl = dom.find('.lh-crc', tmpl); | ||
|
|
||
| // Fill in top summary. | ||
| dom.find('.lh-crc-initial-nav', tmpl).textContent = Util.strings.crcInitialNavigation; | ||
| dom.find('.lh-crc__longest_duration_label', tmpl).textContent = | ||
| Util.strings.crcLongestDurationLabel; | ||
| dom.find('.lh-crc__longest_duration', tmpl).textContent = | ||
| Util.i18n.formatMilliseconds(details.longestChain.duration); | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,27 +9,18 @@ const NBSP2 = '\xa0'; | |
| const KiB = 1024; | ||
| const MiB = KiB * KiB; | ||
|
|
||
| export class I18nFormatter { | ||
| /** | ||
| * @param {LH.Locale} locale | ||
| */ | ||
| constructor(locale) { | ||
| // When testing, use a locale with more exciting numeric formatting. | ||
| if (locale === 'en-XA') locale = 'de'; | ||
|
|
||
| this._locale = locale; | ||
| this._cachedNumberFormatters = new Map(); | ||
| } | ||
|
|
||
| /** | ||
| * @param {number} number | ||
| * @param {number|undefined} granularity | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -178,7 +178,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer { | |
| * @override | ||
| */ | ||
| render(category, groups, options) { | ||
| const strings = Util.strings; | ||
| const element = this.dom.createElement('div', 'lh-category'); | ||
| element.id = category.id; | ||
| element.append(this.renderCategoryHeader(category, groups, options)); | ||
|
|
@@ -200,8 +200,8 @@ export class PerformanceCategoryRenderer extends CategoryRenderer { | |
| labelEl.htmlFor = checkboxId; | ||
| const showEl = this.dom.createChildOf(labelEl, 'span', 'lh-metrics-toggle__labeltext--show'); | ||
| const hideEl = this.dom.createChildOf(labelEl, 'span', 'lh-metrics-toggle__labeltext--hide'); | ||
| showEl.textContent = Util.strings.expandView; | ||
| hideEl.textContent = Util.strings.collapseView; | ||
|
|
||
| const metricsBoxesEl = this.dom.createElement('div', 'lh-metrics-container'); | ||
| metricsGroupEl.insertBefore(metricsBoxesEl, metricsFooterEl); | ||
|
|
@@ -333,7 +333,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer { | |
| renderMetricAuditFilter(filterableMetrics, categoryEl) { | ||
| const metricFilterEl = this.dom.createElement('div', 'lh-metricfilter'); | ||
| const textEl = this.dom.createChildOf(metricFilterEl, 'span', 'lh-metricfilter__text'); | ||
| textEl.textContent = Util.strings.showRelevantAudits; | ||
|
|
||
| const filterChoices = /** @type {LH.ReportResult.AuditRef[]} */ ([ | ||
| ({acronym: 'All'}), | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ | |
| import {CategoryRenderer} from './category-renderer.js'; | ||
| import {DetailsRenderer} from './details-renderer.js'; | ||
| import {ElementScreenshotRenderer} from './element-screenshot-renderer.js'; | ||
| import {I18nFormatter} from './i18n-formatter.js'; | ||
| import {PerformanceCategoryRenderer} from './performance-category-renderer.js'; | ||
| import {PwaCategoryRenderer} from './pwa-category-renderer.js'; | ||
| import {Util} from './util.js'; | ||
|
|
@@ -108,7 +108,7 @@ export class ReportRenderer { | |
|
|
||
| this._renderMetaBlock(report, footer); | ||
|
|
||
| this._dom.find('.lh-footer__version_issue', footer).textContent = Util.strings.footerIssue; | ||
| this._dom.find('.lh-footer__version', footer).textContent = report.lighthouseVersion; | ||
| return footer; | ||
| } | ||
|
|
@@ -128,15 +128,15 @@ export class ReportRenderer { | |
| const axeVersion = report.environment.credits?.['axe-core']; | ||
|
|
||
| const devicesTooltipTextLines = [ | ||
| `${Util.strings.runtimeSettingsBenchmark}: ${benchmarkIndex}`, | ||
| `${Util.strings.runtimeSettingsCPUThrottling}: ${envValues.cpuThrottling}`, | ||
| ]; | ||
| if (envValues.screenEmulation) { | ||
| devicesTooltipTextLines.push( | ||
| `${Util.strings.runtimeSettingsScreenEmulation}: ${envValues.screenEmulation}`); | ||
| } | ||
| if (axeVersion) { | ||
| devicesTooltipTextLines.push(`${Util.strings.runtimeSettingsAxeVersion}: ${axeVersion}`); | ||
| } | ||
|
|
||
| // [CSS icon class, textContent, tooltipText] | ||
|
|
@@ -147,16 +147,16 @@ export class ReportRenderer { | |
| `${envValues.deviceEmulation} with Lighthouse ${report.lighthouseVersion}`, | ||
| devicesTooltipTextLines.join('\n')], | ||
| ['samples-one', | ||
| Util.strings.runtimeSingleLoad, | ||
| Util.strings.runtimeSingleLoadTooltip], | ||
| ['stopwatch', | ||
| Util.strings.runtimeAnalysisWindow], | ||
| ['networkspeed', | ||
| `${envValues.summary}`, | ||
| `${Util.strings.runtimeSettingsNetworkThrottling}: ${envValues.networkThrottling}`], | ||
| ['chrome', | ||
| `Using ${chromeVer}` + (channel ? ` with ${channel}` : ''), | ||
| `${Util.strings.runtimeSettingsUANetwork}: "${report.environment.networkUserAgent}"`], | ||
| ]; | ||
|
|
||
| const metaItemsEl = this._dom.find('.lh-meta__items', footer); | ||
|
|
@@ -184,7 +184,7 @@ export class ReportRenderer { | |
|
|
||
| const container = this._dom.createComponent('warningsToplevel'); | ||
| const message = this._dom.find('.lh-warnings__msg', container); | ||
| message.textContent = Util.strings.toplevelWarningsMessage; | ||
|
|
||
| const warnings = []; | ||
| for (const warningString of report.runWarnings) { | ||
|
|
@@ -260,12 +260,8 @@ export class ReportRenderer { | |
| * @return {!DocumentFragment} | ||
| */ | ||
| _renderReport(report) { | ||
| Util.applyStrings(report.i18n.rendererFormattedStrings); | ||
| Util.i18n = new I18nFormatter(report.configSettings.locale); | ||
| Util.reportJson = report; | ||
|
|
||
| const detailsRenderer = new DetailsRenderer(this._dom, { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What was the reason we set these "static" variables here rather than in the class declaration? Might be a good comment to add.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case, it's because moving UIStrings declaration to be before the
classwill be bad forgit blamehistory. I'm not sure that's a particularly useful thing to call out in a comment tho