chore: migrate package to ES module

Author: dessant

.gitignore

@@ -6,7 +6,7 @@
 /report.json
 /report.html
 
-/web-ext-config.js
+/web-ext-config.mjs
 
 node_modules/
 /npm-debug.log

.nvmrc

@@ -1 +1 @@
-20.12.2
+24.13.0

babel.config.js

@@ -1,10 +1,13 @@
-const path = require('node:path');
+import path from 'node:path';
+import {createRequire} from 'node:module';
+
+const require = createRequire(import.meta.url);
 
 const corejsVersion = require(
   path.join(path.dirname(require.resolve('core-js')), 'package.json')
 ).version;
 
-module.exports = function (api) {
+export default function (api) {
   api.cache(true);
 
   const presets = [
@@ -25,7 +28,7 @@ module.exports = function (api) {
     new RegExp(`node_modules\\${path.sep}(?!(vueton|wesa)\\${path.sep}).*`)
   ];
 
-  const parserOpts = {plugins: ['importAttributes']};
+  const parserOpts = {};
 
   return {presets, plugins, ignore, parserOpts};
-};
+}

gulpfile.js

@@ -1,22 +1,21 @@
-const path = require('node:path');
-const {exec} = require('node:child_process');
-const {
-  lstatSync,
-  readdirSync,
-  readFileSync,
-  writeFileSync,
-  rmSync
-} = require('node:fs');
-
-const {series, parallel, src, dest} = require('gulp');
-const postcss = require('gulp-postcss');
-const gulpif = require('gulp-if');
+import path from 'node:path';
+import {exec} from 'node:child_process';
+import {lstat, readdir, readFile, writeFile, rm} from 'node:fs/promises';
+import {createRequire} from 'node:module';
+
+import {series, parallel, src, dest} from 'gulp';
+import postcss from 'gulp-postcss';
+import gulpif from 'gulp-if';
+import jsonmin from 'gulp-jsonmin';
+import htmlmin from 'gulp-htmlmin';
+import imagemin from 'gulp-imagemin';
+import {ensureDir} from 'fs-extra';
+import sharp from 'sharp';
+
+const require = createRequire(import.meta.url);
+const __dirname = import.meta.dirname;
+
 const jsonMerge = require('gulp-merge-json');
-const jsonmin = require('gulp-jsonmin');
-const htmlmin = require('gulp-htmlmin');
-const imagemin = require('gulp-imagemin');
-const {ensureDirSync} = require('fs-extra');
-const sharp = require('sharp');
 
 const targetEnv = process.env.TARGET_ENV || 'chrome';
 const isProduction = process.env.NODE_ENV === 'production';
@@ -31,20 +30,22 @@ function initEnv() {
   process.env.BROWSERSLIST_ENV = targetEnv;
 }
 
-function init(done) {
+async function init() {
   initEnv();
 
-  rmSync(distDir, {recursive: true, force: true});
-  ensureDirSync(distDir);
-  done();
+  await rm(distDir, {recursive: true, force: true});
+  await ensureDir(distDir);
 }
 
 function js(done) {
-  exec('webpack-cli build --color', function (err, stdout, stderr) {
-    console.log(stdout);
-    console.log(stderr);
-    done(err);
-  });
+  exec(
+    `webpack-cli build --color --env mv3=${mv3}`,
+    function (err, stdout, stderr) {
+      console.log(stdout);
+      console.log(stderr);
+      done(err);
+    }
+  );
 }
 
 function html() {
@@ -64,8 +65,8 @@ function html() {
 }
 
 async function images(done) {
-  ensureDirSync(path.join(distDir, 'src/assets/icons/app'));
-  const appIconSvg = readFileSync('src/assets/icons/app/icon.svg');
+  await ensureDir(path.join(distDir, 'src/assets/icons/app'));
+  const appIconSvg = await readFile('src/assets/icons/app/icon.svg');
   const appIconSizes = [16, 19, 24, 32, 38, 48, 64, 96, 128];
   if (targetEnv === 'safari') {
     appIconSizes.push(256, 512, 1024);
@@ -136,9 +137,16 @@ async function fonts(done) {
 
 async function locale(done) {
   const localesRootDir = path.join(__dirname, 'src/assets/locales');
-  const localeDirs = readdirSync(localesRootDir).filter(function (file) {
-    return lstatSync(path.join(localesRootDir, file)).isDirectory();
-  });
+  const localeDirs = (
+    await Promise.all(
+      (await readdir(localesRootDir)).map(async function (file) {
+        if ((await lstat(path.join(localesRootDir, file))).isDirectory()) {
+          return file;
+        }
+      })
+    )
+  ).filter(Boolean);
+
   for (const localeDir of localeDirs) {
     const localePath = path.join(localesRootDir, localeDir);
     await new Promise(resolve => {
@@ -187,7 +195,7 @@ function manifest() {
     .pipe(dest(distDir));
 }
 
-function license(done) {
+async function license(done) {
   let year = '2017';
   const currentYear = new Date().getFullYear().toString();
   if (year !== currentYear) {
@@ -199,18 +207,28 @@ Copyright (c) ${year} Armin Sebastian
 `;
 
   if (['safari', 'samsung'].includes(targetEnv)) {
-    writeFileSync(path.join(distDir, 'NOTICE'), notice);
-    done();
+    await writeFile(path.join(distDir, 'NOTICE'), notice);
   } else {
     notice = `${notice}
 This software is released under the terms of the GNU General Public License v3.0.
 See the LICENSE file for further information.
 `;
-    writeFileSync(path.join(distDir, 'NOTICE'), notice);
-    return src('LICENSE').pipe(dest(distDir));
+    await writeFile(path.join(distDir, 'NOTICE'), notice);
+
+    await new Promise(resolve => {
+      src('LICENSE')
+        .pipe(dest(distDir))
+        .on('error', done)
+        .on('finish', resolve);
+    });
   }
 }
 
+const build = series(
+  init,
+  parallel(js, html, images, fonts, locale, manifest, license)
+);
+
 function zip(done) {
   exec(
     `web-ext build -s dist/${targetEnv} -a artifacts/${targetEnv} -n "{name}-{version}-${targetEnv}.zip" --overwrite-dest`,
@@ -238,9 +256,4 @@ function inspect(done) {
   );
 }
 
-exports.build = series(
-  init,
-  parallel(js, html, images, fonts, locale, manifest, license)
-);
-exports.zip = zip;
-exports.inspect = inspect;
+export {build, zip, inspect};