i18n: seo

lighthouse-core/audits/seo/canonical.js

@@ -10,6 +10,31 @@ const LinkHeader = require('http-link-header');
 const URL = require('../../lib/url-shim');
 const MainResource = require('../../computed/main-resource.js');
 const LINK_HEADER = 'link';
+const i18n = require('../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Imperative title of a Lighthouse audit that tells the user their site has a valid rel=canonical links. This is displayed in a list of audit titles that Lighthouse generates. */
+  title: 'Document has a valid `rel=canonical`',
+  /** Imperative title of a Lighthouse audit that tells the user their site has a valid rel=canonical links. This imperative title is shown to users when the rel=canonical link is invalid. */
+  failureTitle: 'Document does not have a valid `rel=canonical`',
+  /** Description of a Lighthouse audit that tells the user *why* they need to have a valid rel=canonical link. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
+  description: 'Canonical links suggest which URL to show in search results. ' +
+    '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/canonical).',
+  /** [ICU Syntax] Explanatory message stating that there was a failure in an audit caused by multiple URLs conflicting with each other. */
+  explanationConflict: 'Multiple conflicting URLs ({urlList})',
+  /** [ICU Syntax] Explanatory message stating that there was a failure in an audit caused by a URL being invalid. */
+  explanationInvalid: 'Invalid URL ({url})',
+  /** [ICU Syntax] Explanatory message stating that there was a failure in an audit caused by a URL being relative. */
+  explanationRelative: 'Relative URL ({url})',
+  /** [ICU Syntax] Explanatory message stating that there was a failure in an audit caused by a URL pointing to a different hreflang than the current context. */
+  explanationPointsElsewhere: 'Points to another hreflang location ({href})',
+  /** [ICU Syntax] Explanatory message stating that there was a failure in an audit caused by a URL pointing to a different domain. */
+  explanationDifferentDomain: 'Points to a different domain ({url})',
+  /** Explanatory message stating that there was a failure in an audit caused by a URL pointing to a root of the same origin. */
+  explanationRoot: 'Points to a root of the same origin',
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 /**
  * @param {string} headerValue
@@ -62,10 +87,9 @@ class Canonical extends Audit {
   static get meta() {
     return {
       id: 'canonical',
-      title: 'Document has a valid `rel=canonical`',
-      failureTitle: 'Document does not have a valid `rel=canonical`',
-      description: 'Canonical links suggest which URL to show in search results. ' +
-        '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/canonical).',
+      title: str_(UIStrings.title),
+      failureTitle: str_(UIStrings.failureTitle),
+      description: str_(UIStrings.description),
       requiredArtifacts: ['Canonical', 'Hreflang', 'URL'],
     };
   }
@@ -118,7 +142,7 @@ class Canonical extends Audit {
         if (canonicals.length > 1) {
           return {
             rawValue: false,
-            explanation: `Multiple conflicting URLs (${canonicals.join(', ')})`,
+            explanation: str_(UIStrings.explanationConflict, {urlList: canonicals.join(', ')}),
           };
         }
 
@@ -127,14 +151,14 @@ class Canonical extends Audit {
         if (!isValidRelativeOrAbsoluteURL(canonical)) {
           return {
             rawValue: false,
-            explanation: `Invalid URL (${canonical})`,
+            explanation: str_(UIStrings.explanationInvalid, {url: canonical}),
           };
         }
 
         if (!URL.isValid(canonical)) {
           return {
             rawValue: false,
-            explanation: `Relative URL (${canonical})`,
+            explanation: str_(UIStrings.explanationRelative, {url: canonical}),
           };
         }
 
@@ -145,7 +169,7 @@ class Canonical extends Audit {
           baseURL.href !== canonicalURL.href) {
           return {
             rawValue: false,
-            explanation: `Points to another hreflang location (${baseURL.href})`,
+            explanation: str_(UIStrings.explanationPointsElsewhere, {href: baseURL.href}),
           };
         }
 
@@ -154,7 +178,7 @@ class Canonical extends Audit {
         if (getPrimaryDomain(canonicalURL) !== getPrimaryDomain(baseURL)) {
           return {
             rawValue: false,
-            explanation: `Points to a different domain (${canonicalURL})`,
+            explanation: str_(UIStrings.explanationDifferentDomain, {url: canonicalURL}),
           };
         }
 
@@ -163,7 +187,7 @@ class Canonical extends Audit {
           canonicalURL.pathname === '/' && baseURL.pathname !== '/') {
           return {
             rawValue: false,
-            explanation: 'Points to a root of the same origin',
+            explanation: str_(UIStrings.explanationRoot),
           };
         }
 
@@ -175,3 +199,4 @@ class Canonical extends Audit {
 }
 
 module.exports = Canonical;
+module.exports.UIStrings = UIStrings;

lighthouse-core/audits/seo/font-size.js

@@ -22,6 +22,10 @@ const UIStrings = {
   description: 'Font sizes less than 12px are too small to be legible and require mobile visitors to “pinch to zoom” in order to read. Strive to have >60% of page text ≥12px. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/font-sizes).',
   /** [ICU Syntax] Label for the audit identifying font sizes that are too small. */
   displayValue: '{decimalProportion, number, extendedPercent} legible text',
+  /** Explanatory message stating that there was a failure in an audit caused by a missing page viewport config. */
+  explanationViewport: 'Text is illegible because of a missing viewport config',
+  /** Explanatory message stating that there was a failure in an audit caused by a certain percentage of the text on the page being too small. */
+  explanation: '{decimalProportion, number, extendedPercent} of text is too small{disclaimer}.',
 };
 
 const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
@@ -212,7 +216,7 @@ class FontSize extends Audit {
     if (!hasViewportSet) {
       return {
         rawValue: false,
-        explanation: 'Text is illegible because of a missing viewport config',
+        explanation: str_(UIStrings.explanationViewport),
       };
     }
 
@@ -285,16 +289,16 @@ class FontSize extends Audit {
 
     let explanation;
     if (!passed) {
-      const percentageOfFailingText = parseFloat((100 - percentageOfPassingText).toFixed(2));
+      const percentageOfFailingText = parseFloat((100 - percentageOfPassingText).toFixed(2)) / 100;
       let disclaimer = '';
 
       // if we were unable to visit all text nodes we should disclose that information
       if (visitedTextLength < totalTextLength) {
         const percentageOfVisitedText = visitedTextLength / totalTextLength * 100;
         disclaimer = ` (based on ${percentageOfVisitedText.toFixed()}% sample)`;
       }
-
-      explanation = `${percentageOfFailingText}% of text is too small${disclaimer}.`;
+      explanation = str_(UIStrings.explanation,
+        {decimalProportion: percentageOfFailingText, disclaimer});
     }
 
     return {

lighthouse-core/audits/seo/hreflang.js

@@ -11,6 +11,20 @@ const MainResource = require('../../computed/main-resource.js');
 const VALID_LANGS = importValidLangs();
 const LINK_HEADER = 'link';
 const NO_LANGUAGE = 'x-default';
+const i18n = require('../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Imperative title of a Lighthouse audit that tells the user the hreflang is valid for their site. This is displayed in a list of audit titles that Lighthouse generates. */
+  title: 'Document has a valid `hreflang`',
+  /** Imperative title of a Lighthouse audit that tells the user the hreflang is valid for their site. This imperative title is shown when the site does not have a valid hreflang element. */
+  failureTitle: 'Document doesn\'t have a valid `hreflang`',
+  /** Description of a Lighthouse audit that tells the user *why* they need to have an hreflang link on their page. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
+  description: 'hreflang links tell search engines what version of a page they should ' +
+    'list in search results for a given language or region. [Learn more]' +
+    '(https://developers.google.com/web/tools/lighthouse/audits/hreflang).',
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 /**
  * Import list of valid languages from axe core without including whole axe-core package
@@ -65,11 +79,9 @@ class Hreflang extends Audit {
   static get meta() {
     return {
       id: 'hreflang',
-      title: 'Document has a valid `hreflang`',
-      failureTitle: 'Document doesn\'t have a valid `hreflang`',
-      description: 'hreflang links tell search engines what version of a page they should ' +
-        'list in search results for a given language or region. [Learn more]' +
-        '(https://developers.google.com/web/tools/lighthouse/audits/hreflang).',
+      title: str_(UIStrings.title),
+      failureTitle: str_(UIStrings.failureTitle),
+      description: str_(UIStrings.description),
       requiredArtifacts: ['Hreflang', 'URL'],
     };
   }
@@ -119,3 +131,4 @@ class Hreflang extends Audit {
 }
 
 module.exports = Hreflang;
+module.exports.UIStrings = UIStrings;

lighthouse-core/audits/seo/http-status-code.js

@@ -9,6 +9,20 @@ const Audit = require('../audit');
 const MainResource = require('../../computed/main-resource.js');
 const HTTP_UNSUCCESSFUL_CODE_LOW = 400;
 const HTTP_UNSUCCESSFUL_CODE_HIGH = 599;
+const i18n = require('../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Imperative title of a Lighthouse audit that tells the user their site has loaded with an appropriate HTTP status code. This is displayed in a list of audit titles that Lighthouse generates. */
+  title: 'Page has successful HTTP status code',
+  /** Imperative title of a Lighthouse audit that tells the user their site has loaded with an appropriate HTTP status code. This imperative title is shown when a site has sent an invalid HTTP status code. */
+  failureTitle: 'Page has unsuccessful HTTP status code',
+  /** Description of a Lighthouse audit that tells the user *why* they need to serve pages with a valid HTTP status code. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
+  description: 'Pages with unsuccessful HTTP status codes may not be indexed properly. ' +
+  '[Learn more]' +
+  '(https://developers.google.com/web/tools/lighthouse/audits/successful-http-code).',
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 class HTTPStatusCode extends Audit {
   /**
@@ -17,11 +31,9 @@ class HTTPStatusCode extends Audit {
   static get meta() {
     return {
       id: 'http-status-code',
-      title: 'Page has successful HTTP status code',
-      failureTitle: 'Page has unsuccessful HTTP status code',
-      description: 'Pages with unsuccessful HTTP status codes may not be indexed properly. ' +
-      '[Learn more]' +
-      '(https://developers.google.com/web/tools/lighthouse/audits/successful-http-code).',
+      title: str_(UIStrings.title),
+      failureTitle: str_(UIStrings.failureTitle),
+      description: str_(UIStrings.description),
       requiredArtifacts: ['devtoolsLogs', 'URL'],
     };
   }
@@ -55,3 +67,4 @@ class HTTPStatusCode extends Audit {
 }
 
 module.exports = HTTPStatusCode;
+module.exports.UIStrings = UIStrings;

lighthouse-core/audits/seo/is-crawlable.js

@@ -15,6 +15,20 @@ const BLOCKLIST = new Set([
 ]);
 const ROBOTS_HEADER = 'x-robots-tag';
 const UNAVAILABLE_AFTER = 'unavailable_after';
+const i18n = require('../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Imperative title of a Lighthouse audit that tells the user their page is not blocked from being indexed by search engine crawlers. This is displayed in a list of audit titles that Lighthouse generates. */
+  title: 'Page isn’t blocked from indexing',
+  /** Imperative title of a Lighthouse audit that tells the user their page is not blocked from being indexed by search engine crawlers. This imperative title is shown when the site has been blocked from indexing by search engine crawlers. */
+  failureTitle: 'Page is blocked from indexing',
+  /** Description of a Lighthouse audit that tells the user *why* they need to allow crawling on their page. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
+  description: 'Search engines are unable to include your pages in search results ' +
+      'if they don\'t have permission to crawl them. [Learn ' +
+      'more](https://developers.google.com/web/tools/lighthouse/audits/indexing).',
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 /**
  * Checks if given directive is a valid unavailable_after directive with a date in the past
@@ -64,11 +78,9 @@ class IsCrawlable extends Audit {
   static get meta() {
     return {
       id: 'is-crawlable',
-      title: 'Page isn’t blocked from indexing',
-      failureTitle: 'Page is blocked from indexing',
-      description: 'Search engines are unable to include your pages in search results ' +
-          'if they don\'t have permission to crawl them. [Learn ' +
-          'more](https://developers.google.com/web/tools/lighthouse/audits/indexing).',
+      title: str_(UIStrings.title),
+      failureTitle: str_(UIStrings.failureTitle),
+      description: str_(UIStrings.description),
       requiredArtifacts: ['MetaRobots', 'RobotsTxt', 'URL'],
     };
   }
@@ -132,3 +144,4 @@ class IsCrawlable extends Audit {
 }
 
 module.exports = IsCrawlable;
+module.exports.UIStrings = UIStrings;

lighthouse-core/audits/seo/link-text.js

@@ -18,6 +18,24 @@ const BLOCKLIST = new Set([
   'more',
   'learn more',
 ]);
+const i18n = require('../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Imperative title of a Lighthouse audit that tells the user their links have descriptive enough text for a search engine crawler to parse them. This is displayed in a list of audit titles that Lighthouse generates. */
+  title: 'Links have descriptive text',
+  /** Imperative title of a Lighthouse audit that tells the user their links have descriptive enough text for a search engine crawler to parse them. This imperative title is shown when there are links on the page without proper text to describe them. */
+  failureTitle: 'Links do not have descriptive text',
+  /** Description of a Lighthouse audit that tells the user *why* they need to have descriptive text on the links in their page. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
+  description: 'Descriptive link text helps search engines understand your content. ' +
+  '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/descriptive-link-text).',
+  /** [ICU Syntax] Label for the audit identifying the number of links found. */
+  displayValue: `{itemCount, plural,
+    =1 {1 link found}
+    other {# links found}
+    }`,
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 class LinkText extends Audit {
   /**
@@ -26,10 +44,9 @@ class LinkText extends Audit {
   static get meta() {
     return {
       id: 'link-text',
-      title: 'Links have descriptive text',
-      failureTitle: 'Links do not have descriptive text',
-      description: 'Descriptive link text helps search engines understand your content. ' +
-      '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/descriptive-link-text).',
+      title: str_(UIStrings.title),
+      failureTitle: str_(UIStrings.failureTitle),
+      description: str_(UIStrings.description),
       requiredArtifacts: ['URL', 'CrawlableLinks'],
     };
   }
@@ -68,8 +85,7 @@ class LinkText extends Audit {
     let displayValue;
 
     if (failingLinks.length) {
-      displayValue = failingLinks.length > 1 ?
-        `${failingLinks.length} links found` : '1 link found';
+      displayValue = str_(UIStrings.displayValue, {itemCount: failingLinks.length});
     }
 
     return {
@@ -81,3 +97,4 @@ class LinkText extends Audit {
 }
 
 module.exports = LinkText;
+module.exports.UIStrings = UIStrings;

lighthouse-core/audits/seo/manual/mobile-friendly.js

@@ -6,6 +6,16 @@
 'use strict';
 
 const ManualAudit = require('../../manual/manual-audit');
+const i18n = require('../../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Description of a Lighthouse audit that tells the user *why* and *how* they need to test their site to be mobile friendly. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
+  description: 'Take the [Mobile-Friendly Test](https://search.google.com/test/mobile-friendly) to check for audits not covered by Lighthouse, like sizing tap targets appropriately. [Learn more](https://developers.google.com/search/mobile-sites/).',
+  /** Imperative title of a Lighthouse audit that tells the user that their page is setup to be compatible with mobile devices such as cellphones. This is displayed in a list of audit titles that Lighthouse generates. */
+  title: 'Page is mobile friendly',
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 /**
  * @fileoverview Manual SEO audit to check if page is mobile friendly.
@@ -18,10 +28,11 @@ class MobileFriendly extends ManualAudit {
   static get meta() {
     return Object.assign({
       id: 'mobile-friendly',
-      description: 'Take the [Mobile-Friendly Test](https://search.google.com/test/mobile-friendly) to check for audits not covered by Lighthouse, like sizing tap targets appropriately. [Learn more](https://developers.google.com/search/mobile-sites/).',
-      title: 'Page is mobile friendly',
+      description: str_(UIStrings.description),
+      title: str_(UIStrings.title),
     }, super.partialMeta);
   }
 }
 
 module.exports = MobileFriendly;
+module.exports.UIStrings = UIStrings;

lighthouse-core/audits/seo/manual/structured-data.js

@@ -6,6 +6,16 @@
 'use strict';
 
 const ManualAudit = require('../../manual/manual-audit');
+const i18n = require('../../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Description of a Lighthouse audit that tells the user *how* to test their page for using valid structured data. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
+  description: 'Run the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) and the [Structured Data Linter](http://linter.structured-data.org/) to validate structured data. [Learn more](https://developers.google.com/search/docs/guides/mark-up-content).',
+  /** Imperative title of a Lighthouse audit that tells the user that their page has structured data. This is displayed in a list of audit titles that Lighthouse generates. */
+  title: 'Structured data is valid',
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 /**
  * @fileoverview Manual SEO audit to check if structured data on page is valid.
@@ -18,10 +28,11 @@ class StructuredData extends ManualAudit {
   static get meta() {
     return Object.assign({
       id: 'structured-data',
-      description: 'Run the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) and the [Structured Data Linter](http://linter.structured-data.org/) to validate structured data. [Learn more](https://developers.google.com/search/docs/guides/mark-up-content).',
-      title: 'Structured data is valid',
+      description: str_(UIStrings.description),
+      title: str_(UIStrings.title),
     }, super.partialMeta);
   }
 }
 
 module.exports = StructuredData;
+module.exports.UIStrings = UIStrings;