lighthouse 9.6.7 → 10.0.0

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

@@ -1,155 +0,0 @@
-/**
- * @license Copyright 2017 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const Audit = require('../audit.js');
-// TODO(esmodules): cast can be removed when this switches to import.
-const robotsParser = /** @type {typeof import('robots-parser').default} */ (/** @type {unknown} */(require('robots-parser'))); // eslint-disable-line max-len
-const URL = require('../../lib/url-shim.js');
-const MainResource = require('../../computed/main-resource.js');
-const BLOCKLIST = new Set([
-  'noindex',
-  'none',
-]);
-const ROBOTS_HEADER = 'x-robots-tag';
-const UNAVAILABLE_AFTER = 'unavailable_after';
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on if search-engine crawlers are blocked from indexing the page. This title is shown when the page is not blocked from indexing and can be crawled. */
-  title: 'Page isn’t blocked from indexing',
-  /** Title of a Lighthouse audit that provides detail on if search-engine crawlers are blocked from indexing the page. This title is shown when the page has been configured to block indexing and therefore cannot be indexed by search engines. */
-  failureTitle: 'Page is blocked from indexing',
-  /** Description of a Lighthouse audit that tells the user *why* allowing search-engine crawling of their page is beneficial. 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://web.dev/is-crawable/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * Checks if given directive is a valid unavailable_after directive with a date in the past
- * @param {string} directive
- * @return {boolean}
- */
-function isUnavailable(directive) {
-  const parts = directive.split(':');
-
-  if (parts.length <= 1 || parts[0] !== UNAVAILABLE_AFTER) {
-    return false;
-  }
-
-  const date = Date.parse(parts.slice(1).join(':'));
-
-  return !isNaN(date) && date < Date.now();
-}
-
-/**
- * Returns true if any of provided directives blocks page from being indexed
- * @param {string} directives
- * @return {boolean}
- */
-function hasBlockingDirective(directives) {
-  return directives.split(',')
-    .map(d => d.toLowerCase().trim())
-    .some(d => BLOCKLIST.has(d) || isUnavailable(d));
-}
-
-/**
- * Returns true if robots header specifies user agent (e.g. `googlebot: noindex`)
- * @param {string} directives
- * @return {boolean}
- */
-function hasUserAgent(directives) {
-  const parts = directives.match(/^([^,:]+):/);
-
-  // Check if directives are prefixed with `googlebot:`, `googlebot-news:`, `otherbot:`, etc.
-  // but ignore `unavailable_after:` which is a valid directive
-  return !!parts && parts[1].toLowerCase() !== UNAVAILABLE_AFTER;
-}
-
-class IsCrawlable extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'is-crawlable',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['MetaElements', 'RobotsTxt', 'URL', 'devtoolsLogs'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static audit(artifacts, context) {
-    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const metaRobots = artifacts.MetaElements.find(meta => meta.name === 'robots');
-
-    return MainResource.request({devtoolsLog, URL: artifacts.URL}, context)
-      .then(mainResource => {
-        /** @type {LH.Audit.Details.Table['items']} */
-        const blockingDirectives = [];
-
-        if (metaRobots) {
-          const metaRobotsContent = metaRobots.content || '';
-          const isBlocking = hasBlockingDirective(metaRobotsContent);
-
-          if (isBlocking) {
-            blockingDirectives.push({
-              source: {
-                ...Audit.makeNodeItem(metaRobots.node),
-                snippet: `<meta name="robots" content="${metaRobotsContent}" />`,
-              },
-            });
-          }
-        }
-
-        mainResource.responseHeaders && mainResource.responseHeaders
-          .filter(h => h.name.toLowerCase() === ROBOTS_HEADER && !hasUserAgent(h.value) &&
-            hasBlockingDirective(h.value))
-          .forEach(h => blockingDirectives.push({source: `${h.name}: ${h.value}`}));
-
-        if (artifacts.RobotsTxt.content) {
-          const robotsFileUrl = new URL('/robots.txt', mainResource.url);
-          const robotsTxt = robotsParser(robotsFileUrl.href, artifacts.RobotsTxt.content);
-
-          if (!robotsTxt.isAllowed(mainResource.url)) {
-            const line = robotsTxt.getMatchingLineNumber(mainResource.url) || 1;
-            blockingDirectives.push({
-              source: {
-                type: /** @type {const} */ ('source-location'),
-                url: robotsFileUrl.href,
-                urlProvider: /** @type {const} */ ('network'),
-                line: line - 1,
-                column: 0,
-              },
-            });
-          }
-        }
-
-        /** @type {LH.Audit.Details.Table['headings']} */
-        const headings = [
-          {key: 'source', itemType: 'code', text: 'Blocking Directive Source'},
-        ];
-        const details = Audit.makeTableDetails(headings, blockingDirectives);
-
-        return {
-          score: Number(blockingDirectives.length === 0),
-          details,
-        };
-      });
-  }
-}
-
-module.exports = IsCrawlable;
-module.exports.UIStrings = UIStrings;

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

@@ -1,158 +0,0 @@
-/**
- * @license Copyright 2017 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const Audit = require('../audit.js');
-const URL = require('../../lib/url-shim.js');
-const BLOCKLIST = new Set([
-  // English
-  'click here',
-  'click this',
-  'go',
-  'here',
-  'information',
-  'learn more',
-  'more',
-  'more info',
-  'more information',
-  'right here',
-  'read more',
-  'see more',
-  'start',
-  'this',
-  // Japanese
-  'ここをクリック',
-  'こちらをクリック',
-  'リンク',
-  '続きを読む',
-  '続く',
-  '全文表示',
-  // Spanish
-  'click aquí',
-  'click aqui',
-  'clicka aquí',
-  'clicka aqui',
-  'pincha aquí',
-  'pincha aqui',
-  'aquí',
-  'aqui',
-  'más',
-  'mas',
-  'más información',
-  'más informacion',
-  'mas información',
-  'mas informacion',
-  'este',
-  'enlace',
-  'este enlace',
-  'empezar',
-  // Portuguese
-  'clique aqui',
-  'ir',
-  'mais informação',
-  'mais informações',
-  'mais',
-  'veja mais',
-  // Korean
-  '여기',
-  '여기를 클릭',
-  '클릭',
-  '링크',
-  '자세히',
-  '자세히 보기',
-  '계속',
-  '이동',
-  '전체 보기',
-  // Swedish
-  'här',
-  'klicka här',
-  'läs mer',
-  'mer',
-  'mer info',
-  'mer information',
-]);
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that tests if each link on a page contains a sufficient description of what a user will find when they click it. Generic, non-descriptive text like "click here" doesn't give an indication of what the link leads to. This descriptive title is shown when all links on the page have sufficient textual descriptions. */
-  title: 'Links have descriptive text',
-  /** Title of a Lighthouse audit that tests if each link on a page contains a sufficient description of what a user will find when they click it. Generic, non-descriptive text like "click here" doesn't give an indication of what the link leads to. This descriptive title is shown when one or more links on the page contain generic, non-descriptive text. */
-  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://web.dev/link-text/).',
-  /** [ICU Syntax] Label for the audit identifying the number of links found. "link" here refers to the links in a web page to other web pages. */
-  displayValue: `{itemCount, plural,
-    =1 {1 link found}
-    other {# links found}
-    }`,
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class LinkText extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'link-text',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['URL', 'AnchorElements'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts) {
-    const failingLinks = artifacts.AnchorElements
-      .filter(link => link.href && !link.rel.includes('nofollow'))
-      .filter(link => {
-        const href = link.href.toLowerCase();
-        if (
-          href.startsWith('javascript:') ||
-          href.startsWith('mailto:') ||
-          URL.equalWithExcludedFragments(link.href, artifacts.URL.finalUrl)
-        ) {
-          return false;
-        }
-
-        return BLOCKLIST.has(link.text.trim().toLowerCase());
-      })
-      .map(link => {
-        return {
-          href: link.href,
-          text: link.text.trim(),
-        };
-      });
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'href', itemType: 'url', text: 'Link destination'},
-      {key: 'text', itemType: 'text', text: 'Link Text'},
-    ];
-
-    const details = Audit.makeTableDetails(headings, failingLinks, {});
-    let displayValue;
-
-    if (failingLinks.length) {
-      displayValue = str_(UIStrings.displayValue, {itemCount: failingLinks.length});
-    }
-
-    return {
-      score: Number(failingLinks.length === 0),
-      details,
-      displayValue,
-    };
-  }
-}
-
-module.exports = LinkText;
-module.exports.UIStrings = UIStrings;

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

@@ -1,38 +0,0 @@
-/**
- * @license Copyright 2017 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const ManualAudit = require('../../manual/manual-audit.js');
-const i18n = require('../../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Description of a Lighthouse audit that provides detail on the structured data in a page. "Structured data" is a standardized data format on a page that helps a search engine categorize and understand its contents. This description 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://web.dev/structured-data/).',
-  /** Title of a Lighthouse audit that prompts users to manually check their page for valid structured data. "Structured data" is a standardized data format on a page that helps a search engine categorize and understand its contents. */
-  title: 'Structured data is valid',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * @fileoverview Manual SEO audit to check if structured data on page is valid.
- */
-
-class StructuredData extends ManualAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return Object.assign({
-      id: 'structured-data',
-      description: str_(UIStrings.description),
-      title: str_(UIStrings.title),
-    }, super.partialMeta);
-  }
-}
-
-module.exports = StructuredData;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/seo/meta-description.js

@@ -1,67 +0,0 @@
-/**
- * @license Copyright 2017 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const Audit = require('../audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on the web page's document meta description. This descriptive title is shown when the document has a meta description. "meta" should be left untranslated because it refers to an HTML element. */
-  title: 'Document has a meta description',
-  /** Title of a Lighthouse audit that provides detail on the web page's document meta description. This descriptive title is shown when the document does not have a meta description. "meta" should be left untranslated because it refers to an HTML element. */
-  failureTitle: 'Document does not have a meta description',
-  /** Description of a Lighthouse audit that tells the user *why* they need to have meta descriptions 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: 'Meta descriptions may be included in search results to concisely summarize ' +
-      'page content. ' +
-      '[Learn more](https://web.dev/meta-description/).',
-  /** Explanatory message stating that there was a failure in an audit caused by the page's meta description text being empty. */
-  explanation: 'Description text is empty.',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class Description extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'meta-description',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['MetaElements'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts) {
-    const metaDescription = artifacts.MetaElements.find(meta => meta.name === 'description');
-    if (!metaDescription) {
-      return {
-        score: 0,
-      };
-    }
-
-    const description = metaDescription.content || '';
-    if (description.trim().length === 0) {
-      return {
-        score: 0,
-        explanation: str_(UIStrings.explanation),
-      };
-    }
-
-    return {
-      score: 1,
-    };
-  }
-}
-
-module.exports = Description;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/seo/plugins.js

@@ -1,152 +0,0 @@
-/**
- * @license Copyright 2018 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const Audit = require('../audit.js');
-const URL = require('../../lib/url-shim.js');
-
-const JAVA_APPLET_TYPE = 'application/x-java-applet';
-const JAVA_BEAN_TYPE = 'application/x-java-bean';
-const TYPE_BLOCKLIST = new Set([
-  'application/x-shockwave-flash',
-  // See https://docs.oracle.com/cd/E19683-01/816-0378/using_tags/index.html
-  JAVA_APPLET_TYPE,
-  JAVA_BEAN_TYPE,
-  // See https://msdn.microsoft.com/es-es/library/cc265156(v=vs.95).aspx
-  'application/x-silverlight',
-  'application/x-silverlight-2',
-]);
-const FILE_EXTENSION_BLOCKLIST = new Set([
-  'swf',
-  'flv',
-  'class',
-  'xap',
-]);
-const SOURCE_PARAMS = new Set([
-  'code',
-  'movie',
-  'source',
-  'src',
-]);
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on the browser plugins used by the page. This descriptive title is shown when there is no plugin content on the page that would restrict search indexing. */
-  title: 'Document avoids plugins',
-  /** Descriptive title of a Lighthouse audit that provides detail on the browser plugins used by the page. This title is shown when there is plugin content on the page. */
-  failureTitle: 'Document uses plugins',
-  /** Description of a Lighthouse audit that tells the user *why* they need to avoid using browser plugins in their content. 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 can\'t index plugin content, and ' +
-    'many devices restrict plugins or don\'t support them. ' +
-    '[Learn more](https://web.dev/plugins/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * Verifies if given MIME type matches any known plugin MIME type
- * @param {string} type
- * @return {boolean}
- */
-function isPluginType(type) {
-  type = type.trim().toLowerCase();
-
-  return TYPE_BLOCKLIST.has(type) ||
-    type.startsWith(JAVA_APPLET_TYPE) || // e.g. "application/x-java-applet;jpi-version=1.4"
-    type.startsWith(JAVA_BEAN_TYPE);
-}
-
-/**
- * Verifies if given url points to a file that has a known plugin extension
- * @param {string} url
- * @return {boolean}
- */
-function isPluginURL(url) {
-  try {
-    // in order to support relative URLs we need to provied a base URL
-    const filePath = new URL(url, 'http://example.com').pathname;
-    const parts = filePath.split('.');
-
-    if (parts.length < 2) {
-      return false;
-    }
-    const part = parts[parts.length - 1];
-    return FILE_EXTENSION_BLOCKLIST.has(part.trim().toLowerCase());
-  } catch (e) {
-    return false;
-  }
-}
-
-class Plugins extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'plugins',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['EmbeddedContent'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts) {
-    const plugins = artifacts.EmbeddedContent
-      .filter(item => {
-        if (item.tagName === 'APPLET') {
-          return true;
-        }
-
-        if (
-          (item.tagName === 'EMBED' || item.tagName === 'OBJECT') &&
-          item.type &&
-          isPluginType(item.type)
-        ) {
-          return true;
-        }
-
-        const embedSrc = item.src || item.code;
-        if (item.tagName === 'EMBED' && embedSrc && isPluginURL(embedSrc)) {
-          return true;
-        }
-
-        if (item.tagName === 'OBJECT' && item.data && isPluginURL(item.data)) {
-          return true;
-        }
-
-        const failingParams = item.params.filter(param =>
-          SOURCE_PARAMS.has(param.name.trim().toLowerCase()) && isPluginURL(param.value)
-        );
-
-        return failingParams.length > 0;
-      })
-      .map(plugin => {
-        return {
-          source: Audit.makeNodeItem(plugin.node),
-        };
-      });
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'source', itemType: 'code', text: 'Element source'},
-    ];
-
-    const details = Audit.makeTableDetails(headings, plugins);
-
-    return {
-      score: Number(plugins.length === 0),
-      details,
-    };
-  }
-}
-
-module.exports = Plugins;
-module.exports.UIStrings = UIStrings;