chore!: use pure ES modules (#506)

Author: ehmicky

.eslintrc.js renamed to .eslintrc.cjs

@@ -2,5 +2,11 @@ const { overrides } = require('@netlify/eslint-config-node')
 
 module.exports = {
   extends: '@netlify/eslint-config-node',
+  parserOptions: {
+    sourceType: 'module',
+  },
+  rules: {
+    'import/extensions': [2, 'ignorePackages'],
+  },
   overrides: [...overrides],
 }

commitlint.config.js renamed to commitlint.config.cjs

@@ -1,9 +1,9 @@
-const { applyPatch } = require('diff')
+import { applyPatch } from 'diff'
 
-const { fetchText } = require('./fetch')
+import { fetchText } from './fetch.js'
 
 // Retrieve list of plugins differences
-const computeDiffs = async function ({ baseSha, baseRepoUrl, diffUrl }) {
+export const computeDiffs = async function ({ baseSha, baseRepoUrl, diffUrl }) {
   const [baseFile, diffText] = await Promise.all([getBaseFile({ baseSha, baseRepoUrl }), getDiffText(diffUrl)])
 
   const basePlugins = JSON.parse(baseFile)
@@ -39,12 +39,12 @@ const getDiffedFile = (baseFile, diffText) => {
 const getDiffs = (basePlugins, headPlugins) =>
   headPlugins.map((headPlugin) => getDiff(basePlugins, headPlugin)).filter(Boolean)
 
-const getDiff = function (basePlugins, { package, version, author }) {
-  const basePlugin = basePlugins.find((plugin) => plugin.author === author && plugin.package === package)
+const getDiff = function (basePlugins, { package: packageName, version, author }) {
+  const basePlugin = basePlugins.find((plugin) => plugin.author === author && plugin.package === packageName)
 
   // New plugin
   if (basePlugin === undefined) {
-    return { package, version, status: 'added' }
+    return { package: packageName, version, status: 'added' }
   }
 
   // Existing plugin, same version
@@ -53,8 +53,6 @@ const getDiff = function (basePlugins, { package, version, author }) {
   }
 
   // Existing plugin, different version
-  const url = `https://diff.intrinsic.com/${package}/${basePlugin.version}/${version}`
-  return { package, version, url, status: 'updated' }
+  const url = `https://diff.intrinsic.com/${packageName}/${basePlugin.version}/${version}`
+  return { package: packageName, version, url, status: 'updated' }
 }
-
-module.exports = { computeDiffs }

functions/npm-diff/compute.js

@@ -1,9 +1,9 @@
-const { env } = require('process')
+import { env } from 'process'
 
-const fetch = require('node-fetch')
+import fetch from 'node-fetch'
 
 // Make an HTTP request with a JSON request/response
-const fetchJson = async (url, errorPrefix, { headers, body, ...options } = {}) => {
+export const fetchJson = async (url, errorPrefix, { headers, body, ...options } = {}) => {
   const response = await fetch(url, {
     ...options,
     body: JSON.stringify({ body }),
@@ -21,13 +21,11 @@ const fetchJson = async (url, errorPrefix, { headers, body, ...options } = {}) =
 }
 
 // Make a regular HTTP request
-const fetchText = async (url, errorPrefix, options) => {
+export const fetchText = async (url, errorPrefix, options) => {
   const response = await fetch(url, options)
   const text = await response.text()
   if (!response.ok) {
     throw new Error(`${errorPrefix}: ${text}`)
   }
   return text
 }
-
-module.exports = { fetchJson, fetchText }

functions/npm-diff/fetch.js

@@ -1,12 +1,12 @@
-const { computeDiffs } = require('./compute')
-const { getNewPluginsUrls } = require('./new_urls')
-const { upsertComment } = require('./upsert_comment')
-const { validatePayload } = require('./validate')
+import { computeDiffs } from './compute.js'
+import { getNewPluginsUrls } from './new_urls.js'
+import { upsertComment } from './upsert_comment.js'
+import { validatePayload } from './validate.js'
 
 // Main function handler.
 // Add/update a comment on each PR adding/updating a plugin showing the code
 // difference of the npm package.
-const handler = async function (rawEvent) {
+export const handler = async function (rawEvent) {
   console.log(rawEvent)
 
   try {
@@ -60,5 +60,3 @@ const performDiff = async function ({
   const diffUrls = await getNewPluginsUrls(diffs)
   await upsertComment(diffUrls, commentsUrl)
 }
-
-module.exports = { handler }

functions/npm-diff/index.js

@@ -1,7 +1,7 @@
-const pacote = require('pacote')
+import pacote from 'pacote'
 
 // Add npm URLs to new plugins.
-const getNewPluginsUrls = (diffs) => Promise.all(diffs.map(getDiffNewPluginsUrls))
+export const getNewPluginsUrls = (diffs) => Promise.all(diffs.map(getDiffNewPluginsUrls))
 
 const getDiffNewPluginsUrls = async function (diff) {
   if (diff.status !== 'added') {
@@ -13,5 +13,3 @@ const getDiffNewPluginsUrls = async function (diff) {
   } = await pacote.manifest(`${diff.package}@${diff.version}`)
   return { ...diff, url: tarball }
 }
-
-module.exports = { getNewPluginsUrls }

functions/npm-diff/new_urls.js

@@ -1,7 +1,7 @@
-const { fetchJson } = require('./fetch')
+import { fetchJson } from './fetch.js'
 
 // Add or update a comment on the GitHub PR displaying the diff
-const upsertComment = async (diffUrls, commentsUrl) => {
+export const upsertComment = async (diffUrls, commentsUrl) => {
   const comment = getComment(diffUrls)
   if (comment === '') {
     return
@@ -52,5 +52,3 @@ const UPDATE_TYPES = [
   { status: 'added', header: '#### Added Packages' },
   { status: 'updated', header: '#### Updated Packages' },
 ]
-
-module.exports = { upsertComment }

functions/npm-diff/upsert_comment.js

@@ -1,8 +1,8 @@
-const { createHmac } = require('crypto')
-const { env } = require('process')
+import { createHmac } from 'crypto'
+import { env } from 'process'
 
 // Validate Function event payload
-const validatePayload = (rawEvent) => {
+export const validatePayload = (rawEvent) => {
   const failedValidation = VALIDATIONS.find(({ test }) => test(rawEvent))
   if (failedValidation === undefined) {
     return
@@ -37,5 +37,3 @@ const VALIDATIONS = [
 ]
 
 const REQUIRED_HEADERS = ['x-hub-signature', 'x-github-event', 'x-github-delivery']
-
-module.exports = { validatePayload }

functions/npm-diff/validate.js

@@ -1,7 +1,11 @@
 'use strict'
 
-const pluginsList = require('./site/plugins.json')
+import { readFileSync } from 'fs'
+import { fileURLToPath } from 'url'
 
-const pluginsUrl = 'https://list-v2--netlify-plugins.netlify.app/plugins.json'
+const PLUGINS_FILE = fileURLToPath(new URL('./site/plugins.json', import.meta.url))
 
-module.exports = { pluginsList, pluginsUrl }
+// TODO: replace with a JSON import once this is supported without any
+// experimental flag
+export const pluginsList = JSON.parse(readFileSync(PLUGINS_FILE))
+export const pluginsUrl = 'https://list-v2--netlify-plugins.netlify.app/plugins.json'

index.js

@@ -2,7 +2,9 @@
   "name": "@netlify/plugins-list",
   "version": "5.0.0",
   "description": "List of Netlify plugins",
-  "main": "index.js",
+  "type": "module",
+  "exports": "./index.js",
+  "main": "./index.js",
   "files": [
     "site/plugins.json"
   ],
@@ -21,8 +23,8 @@
     "test:ci": "nyc -r lcovonly -r text -r json ava"
   },
   "config": {
-    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{functions,test,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
-    "prettier": "--ignore-path .gitignore --loglevel=warn \"{functions,test,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!package-lock.json\""
+    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{functions,test,.github}/**/*.{cjs,mjs,js,md,html}\" \"*.{cjs,mjs,js,md,html}\" \".*.{cjs,mjs,js,md,html}\"",
+    "prettier": "--ignore-path .gitignore --loglevel=warn \"{functions,test,.github}/**/*.{cjs,mjs,js,md,yml,json,html}\" \"*.{cjs,mjs,js,yml,json,html}\" \".*.{cjs,mjs,js,yml,json,html}\" \"!package-lock.json\""
   },
   "husky": {
     "hooks": {

package.json

@@ -1,6 +1,4 @@
 /* eslint-disable max-lines */
-import { URL } from 'url'
-
 import test from 'ava'
 import got from 'got'
 import isPlainObj from 'is-plain-obj'