convert to ES modules (#354)

* convert to ES modules

.github/workflows/ci.yml

@@ -10,10 +10,10 @@ jobs:
     steps:
       - name: git clone
         uses: actions/checkout@v2
-      - name: Use Node.js 12.x
+      - name: Use Node.js 14.x
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 14.x
       - run: yarn install --frozen-lockfile --network-timeout 1000000
       - run: yarn lint
 
@@ -23,10 +23,10 @@ jobs:
     steps:
       - name: git clone
         uses: actions/checkout@v2
-      - name: Use Node.js 12.x
+      - name: Use Node.js 14.x
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 14.x
       - run: yarn install --frozen-lockfile --network-timeout 1000000
       - run: yarn type-check
 
@@ -36,10 +36,10 @@ jobs:
     steps:
       - name: git clone
         uses: actions/checkout@v2
-      - name: Use Node.js 12.x
+      - name: Use Node.js 14.x
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 14.x
       - run: yarn install --frozen-lockfile --network-timeout 1000000
       - run: yarn test
 
@@ -49,10 +49,10 @@ jobs:
     steps:
       - name: git clone
         uses: actions/checkout@v2
-      - name: Use Node.js 12.x
+      - name: Use Node.js 14.x
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 14.x
       - run: yarn install --frozen-lockfile --network-timeout 1000000
       - run: sudo apt-get install xvfb
       - name: Run smoke tests
@@ -64,10 +64,10 @@ jobs:
     steps:
       - name: git clone
         uses: actions/checkout@v2
-      - name: Use Node.js 12.x
+      - name: Use Node.js 14.x
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 14.x
       - name: npm install
         run: npm install
       - name: Install Lighthouse CI

config.js

@@ -20,7 +20,7 @@
  * https://github.com/GoogleChrome/lighthouse/tree/master/lighthouse-core/config
  * @const {LH.Config}
  */
-module.exports = {
+const config = {
   extends: 'lighthouse:default',
   plugins: ['lighthouse-plugin-publisher-ads'],
   passes: [
@@ -29,3 +29,5 @@ module.exports = {
     },
   ],
 };
+
+export default config;

index.js → index.cjs

@@ -39,7 +39,8 @@ async function main() {
   }
 
   // @ts-ignore let LH handle the CLI
-  await require('lighthouse/lighthouse-cli/bin.js').begin();
+  const {begin} = await import('lighthouse/lighthouse-cli/bin.js');
+  await begin();
 }
 
 if (require.main == module) {

lighthouse-plugin-publisher-ads/.eslintrc.js → lighthouse-plugin-publisher-ads/.eslintrc.cjs

@@ -19,8 +19,13 @@ module.exports = {
     node: true,
     mocha: true,
   },
+  parser: '@typescript-eslint/parser',
   parserOptions: {
-    ecmaVersion: 2018,
+    ecmaVersion: 2020,
+    ecmaFeatures: {
+      globalReturn: true,
+      jsx: false,
+    },
     sourceType: 'script',
   },
   rules: {
@@ -29,6 +34,7 @@ module.exports = {
       {'MemberExpression': 2},
     ],
     'max-len': ['error', 80, {
+      ignorePattern: '^import |/override',
       ignoreStrings: true,
       ignoreUrls: true,
     }],

lighthouse-plugin-publisher-ads/audits/ad-blocking-tasks.js

@@ -7,13 +7,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const AdRequestTime = require('../computed/ad-request-time');
-const i18n = require('lighthouse/lighthouse-core/lib/i18n/i18n.js');
-const LongTasks = require('../computed/long-tasks');
-const {auditNotApplicable} = require('../messages/common-strings');
-const {Audit} = require('lighthouse');
-const {getAttributableUrl} = require('../utils/tasks');
-const {isAdScript} = require('../utils/resource-classification');
+import AdRequestTime from '../computed/ad-request-time.js';
+
+import * as i18n from 'lighthouse/lighthouse-core/lib/i18n/i18n.js';
+import LongTasks from '../computed/long-tasks.js';
+import {auditNotApplicable} from '../messages/common-strings.js';
+import {Audit} from 'lighthouse';
+import {getAttributableUrl} from '../utils/tasks.js';
+import {isAdScript} from '../utils/resource-classification.js';
 
 const UIStrings = {
   /* Title of the audit */
@@ -31,7 +32,7 @@ const UIStrings = {
   columnDuration: 'Duration',
 };
 
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+const str_ = i18n.createMessageInstanceIdFn(import.meta.url, UIStrings);
 /**
  * @typedef {Object} TaskDetails
  * @property {number} startTime
@@ -70,7 +71,6 @@ const HEADINGS = [
 class AdBlockingTasks extends Audit {
   /**
    * @return {LH.Audit.Meta}
-   * @override
    */
   static get meta() {
     return {
@@ -170,5 +170,5 @@ class AdBlockingTasks extends Audit {
   }
 }
 
-module.exports = AdBlockingTasks;
-module.exports.UIStrings = UIStrings;
+export default AdBlockingTasks;
+export {UIStrings};

lighthouse-plugin-publisher-ads/audits/ad-render-blocking-resources.js

@@ -12,13 +12,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const i18n = require('lighthouse/lighthouse-core/lib/i18n/i18n.js');
-const NetworkRecords = require('lighthouse/lighthouse-core/computed/network-records.js');
+import * as i18n from 'lighthouse/lighthouse-core/lib/i18n/i18n.js';
+
+import NetworkRecords from 'lighthouse/lighthouse-core/computed/network-records.js';
+
 // @ts-ignore
-const {auditNotApplicable} = require('../messages/common-strings');
-const {Audit} = require('lighthouse');
-const {getTimingsByRecord} = require('../utils/network-timing');
-const {isAdTag} = require('../utils/resource-classification');
+import {auditNotApplicable} from '../messages/common-strings.js';
+
+import {Audit} from 'lighthouse';
+import {getTimingsByRecord} from '../utils/network-timing.js';
+import {isAdTag} from '../utils/resource-classification.js';
 
 const UIStrings = {
   title: 'Minimal render-blocking resources found',
@@ -38,7 +41,7 @@ const UIStrings = {
 /** @typedef {LH.Artifacts.NetworkRequest} NetworkRequest */
 /** @typedef {LH.Gatherer.Simulation.NodeTiming} NodeTiming */
 
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+const str_ = i18n.createMessageInstanceIdFn(import.meta.url, UIStrings);
 
 const THRESHOLD_MS = 100;
 
@@ -70,7 +73,6 @@ const HEADINGS = [
 class AdRenderBlockingResources extends Audit {
   /**
    * @return {LH.Audit.Meta}
-   * @override
    */
   static get meta() {
     return {
@@ -165,5 +167,5 @@ class AdRenderBlockingResources extends Audit {
   }
 }
 
-module.exports = AdRenderBlockingResources;
-module.exports.UIStrings = UIStrings;
+export default AdRenderBlockingResources;
+export {UIStrings};

lighthouse-plugin-publisher-ads/audits/ad-request-critical-path.js

@@ -12,13 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const i18n = require('lighthouse/lighthouse-core/lib/i18n/i18n.js');
-const {auditNotApplicable} = require('../messages/common-strings');
-const {Audit} = require('lighthouse');
-const {computeAdRequestWaterfall} = require('../utils/graph');
+import * as i18n from 'lighthouse/lighthouse-core/lib/i18n/i18n.js';
+
+import {auditNotApplicable} from '../messages/common-strings.js';
+import {Audit} from 'lighthouse';
+import {computeAdRequestWaterfall} from '../utils/graph.js';
 
 /** @typedef {LH.Gatherer.Simulation.NodeTiming} NodeTiming */
-/** @typedef {import('../utils/graph').SimpleRequest} SimpleRequest */
+/** @typedef {import('../utils/graph.js').SimpleRequest} SimpleRequest */
 
 const UIStrings = {
   title: 'Ad request waterfall',
@@ -35,7 +36,7 @@ const UIStrings = {
   columnEndTime: 'End',
 };
 
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+const str_ = i18n.createMessageInstanceIdFn(import.meta.url, UIStrings);
 
 /**
  * Table headings for audits details sections.
@@ -118,7 +119,6 @@ function computeIdleTimes(blockingRequests) {
 class AdRequestCriticalPath extends Audit {
   /**
    * @return {LH.Audit.Meta}
-   * @override
    */
   static get meta() {
     return {
@@ -173,5 +173,5 @@ class AdRequestCriticalPath extends Audit {
   }
 }
 
-module.exports = AdRequestCriticalPath;
-module.exports.UIStrings = UIStrings;
+export default AdRequestCriticalPath;
+export {UIStrings};

lighthouse-plugin-publisher-ads/audits/ad-request-from-page-start.js

@@ -12,10 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const ComputedAdRequestTime = require('../computed/ad-request-time');
-const i18n = require('lighthouse/lighthouse-core/lib/i18n/i18n.js');
-const {auditNotApplicable, runWarning} = require('../messages/common-strings');
-const {Audit} = require('lighthouse');
+import ComputedAdRequestTime from '../computed/ad-request-time.js';
+
+import * as i18n from 'lighthouse/lighthouse-core/lib/i18n/i18n.js';
+import {auditNotApplicable, runWarning} from '../messages/common-strings.js';
+import {Audit} from 'lighthouse';
 
 const UIStrings = {
   title: 'First ad request time',
@@ -29,15 +30,14 @@ const UIStrings = {
   displayValue: '{timeInMs, number, seconds} s',
 };
 
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+const str_ = i18n.createMessageInstanceIdFn(import.meta.url, UIStrings);
 
 /**
  * Audit to determine time for first ad request relative to page start.
  */
 class AdRequestFromPageStart extends Audit {
   /**
    * @return {LH.Audit.Meta}
-   * @override
    */
   static get meta() {
     return {
@@ -102,5 +102,5 @@ class AdRequestFromPageStart extends Audit {
   }
 }
 
-module.exports = AdRequestFromPageStart;
-module.exports.UIStrings = UIStrings;
+export default AdRequestFromPageStart;
+export {UIStrings};

lighthouse-plugin-publisher-ads/audits/ad-request-from-tag-load.js

@@ -12,11 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const ComputedAdRequestTime = require('../computed/ad-request-time');
-const ComputedTagLoadTime = require('../computed/tag-load-time');
-const i18n = require('lighthouse/lighthouse-core/lib/i18n/i18n.js');
-const {auditNotApplicable} = require('../messages/common-strings');
-const {Audit} = require('lighthouse');
+import ComputedAdRequestTime from '../computed/ad-request-time.js';
+
+import ComputedTagLoadTime from '../computed/tag-load-time.js';
+import * as i18n from 'lighthouse/lighthouse-core/lib/i18n/i18n.js';
+import {auditNotApplicable} from '../messages/common-strings.js';
+import {Audit} from 'lighthouse';
 
 const UIStrings = {
   title: 'Latency of first ad request, from tag load',
@@ -28,15 +29,14 @@ const UIStrings = {
   displayValue: '{timeInMs, number, seconds} s',
 };
 
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+const str_ = i18n.createMessageInstanceIdFn(import.meta.url, UIStrings);
 
 /**
  * Audit to determine time for first ad request relative to tag load.
  */
 class AdRequestFromTagLoad extends Audit {
   /**
    * @return {LH.Audit.Meta}
-   * @override
    */
   static get meta() {
     return {
@@ -105,5 +105,5 @@ class AdRequestFromTagLoad extends Audit {
   }
 }
 
-module.exports = AdRequestFromTagLoad;
-module.exports.UIStrings = UIStrings;
+export default AdRequestFromTagLoad;
+export {UIStrings};

lighthouse-plugin-publisher-ads/audits/ad-top-of-viewport.js

@@ -12,10 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const i18n = require('lighthouse/lighthouse-core/lib/i18n/i18n.js');
-const {auditNotApplicable} = require('../messages/common-strings');
-const {Audit} = require('lighthouse');
-const {isAdIframe} = require('../utils/resource-classification');
+import * as i18n from 'lighthouse/lighthouse-core/lib/i18n/i18n.js';
+
+import {auditNotApplicable} from '../messages/common-strings.js';
+import {Audit} from 'lighthouse';
+import {isAdIframe} from '../utils/resource-classification.js';
 
 const UIStrings = {
   title: 'No ad found at the very top of the viewport',
@@ -30,7 +31,7 @@ const UIStrings = {
   columnSlot: 'Top Slot ID',
 };
 
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+const str_ = i18n.createMessageInstanceIdFn(import.meta.url, UIStrings);
 
 
 const SCROLL_PX_THRESHOLD = 100;
@@ -48,7 +49,6 @@ const HEADINGS = [
 class AdTopOfViewport extends Audit {
   /**
    * @return {AuditMetadata}
-   * @override
    */
   static get meta() {
     return {
@@ -105,5 +105,5 @@ class AdTopOfViewport extends Audit {
   }
 }
 
-module.exports = AdTopOfViewport;
-module.exports.UIStrings = UIStrings;
+export default AdTopOfViewport;
+export {UIStrings};