ESM modules (#3924)

.github/workflows/assets.yml

@@ -26,9 +26,6 @@ jobs:
       - name: Build
         run: yarn build
 
-      - name: Bundle
-        run: yarn bundle
-
       - name: Fetch latest assets
         id: fetch
         working-directory: ./packages/adblocker/assets

.github/workflows/release.yml

@@ -31,9 +31,6 @@ jobs:
       - name: Build
         run: yarn build
 
-      - name: Bundle
-        run: yarn bundle
-
       - name: Lint
         run: yarn lint
 

.github/workflows/tests.yml

@@ -34,6 +34,3 @@ jobs:
 
       - name: Test
         run: yarn test
-
-      - name: Bundle
-        run: yarn bundle

.mocharc.json

@@ -0,0 +1,13 @@
+{
+  "timeout": 10000,
+  "reporter": "spec",
+  "require": "ts-node/register",
+  "retries": 0,
+  "color": false,
+  "extension": ["ts"],
+  "recursive": true,
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "loader=ts-node/esm"
+  ]
+}

package.json

@@ -3,6 +3,7 @@
   "author": {
     "name": "Ghostery"
   },
+  "type": "module",
   "description": "Cliqz adblocker",
   "contributors": [
     {
@@ -61,7 +62,6 @@
     "lint": "lerna run --parallel lint",
     "watch": "tsc --build ./tsconfig.project.json --watch",
     "build": "tsc --build ./tsconfig.project.json && lerna run build",
-    "bundle": "lerna run --concurrency 4 bundle",
     "test": "lerna run --concurrency 4 test",
     "clean": "lerna run --parallel clean && lerna clean --yes",
     "release": "auto shipit -v",
@@ -83,7 +83,7 @@
     "lerna": "^8.0.0",
     "patch-package": "^8.0.0",
     "prettier": "^3.0.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   },
   "auto": {
     "extends": "@remusao/auto-config",

packages/adblocker-content/package.json

@@ -7,8 +7,14 @@
   },
   "homepage": "https://github.com/cliqz-oss/adblocker#readme",
   "license": "MPL-2.0",
-  "main": "dist/cjs/adblocker.js",
-  "module": "dist/es6/adblocker.js",
+  "type": "module",
+  "exports": {
+    "require": "./dist/cjs/adblocker.cjs",
+    "import": "./dist/esm/adblocker.js",
+    "types": "./dist/types/adblocker.d.ts"
+  },
+  "main": "dist/cjs/adblocker.cjs",
+  "module": "dist/esm/adblocker.js",
   "types": "dist/types/adblocker.d.ts",
   "files": [
     "LICENSE",
@@ -25,9 +31,7 @@
   "scripts": {
     "clean": "rimraf dist coverage",
     "lint": "eslint adblocker.ts",
-    "build": "tsc --build ./tsconfig.json",
-    "bundle": "tsc --build ./tsconfig.bundle.json && rollup --config ./rollup.config.ts --configPlugin typescript",
-    "prepack": "yarn run bundle"
+    "build": "tsc --build ./tsconfig.json && rollup --config ./rollup.config.ts --configPlugin typescript"
   },
   "bugs": {
     "url": "https://github.com/cliqz-oss/adblocker/issues"
@@ -44,7 +48,7 @@
     "rollup": "^4.0.2",
     "rollup-plugin-sourcemaps": "^0.6.3",
     "rollup-plugin-terser": "^7.0.2",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   },
   "contributors": [
     {

packages/adblocker-content/rollup.config.ts

@@ -10,21 +10,40 @@ import resolve from '@rollup/plugin-node-resolve';
 import sourcemaps from 'rollup-plugin-sourcemaps';
 import { terser } from 'rollup-plugin-terser';
 
-export default {
-  input: './dist/es6/adblocker.js',
-  output: {
-    file: './dist/adblocker.umd.min.js',
-    format: 'umd',
-    name: 'adblocker',
-    sourcemap: true,
+export default [
+  {
+    input: './dist/src/adblocker.js',
+    output: {
+      file: './dist/adblocker.umd.min.js',
+      format: 'umd',
+      name: 'adblocker',
+      sourcemap: true,
+    },
+    plugins: [
+      resolve(),
+      sourcemaps(),
+      terser({
+        output: {
+          comments: false,
+        },
+      }),
+    ],
   },
-  plugins: [
-    resolve(),
-    sourcemaps(),
-    terser({
-      output: {
-        comments: false,
+  {
+    input: './dist/src/adblocker.js',
+    output: [
+      {
+        dir: './dist/esm',
+        format: 'esm',
+        preserveModules: true,
+        entryFileNames: '[name].js',
       },
-    }),
-  ],
-};
+      {
+        dir: './dist/cjs',
+        format: 'cjs',
+        preserveModules: true,
+        entryFileNames: '[name].cjs',
+      },
+    ],
+  },
+];

packages/adblocker-content/tsconfig.json

@@ -1,9 +1,8 @@
 {
   "extends": "../../tsconfig",
   "compilerOptions": {
-    "composite": true,
-    "outDir": "dist/cjs",
-    "declarationDir": "dist/types"
+    "outDir": "./dist/src",
+    "declarationDir": "./dist/types",
   },
   "references": [
     { "path": "../adblocker-extended-selectors/tsconfig.json" },

packages/adblocker-electron-example/package.json

@@ -61,13 +61,12 @@
   ],
   "dependencies": {
     "@cliqz/adblocker-electron": "^1.27.3",
+    "cross-fetch": "^4.0.0",
     "electron": "^30.0.0",
-    "node-fetch": "^3.3.2",
     "ts-node": "^10.9.1"
   },
   "devDependencies": {
-    "@types/node-fetch": "^3.0.3",
     "eslint": "^8.49.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   }
 }

packages/adblocker-electron-preload/package.json

@@ -7,8 +7,14 @@
   },
   "homepage": "https://github.com/cliqz-oss/adblocker#readme",
   "license": "MPL-2.0",
-  "main": "dist/preload.cjs.js",
-  "module": "dist/preload.es6.js",
+  "type": "module",
+  "exports": {
+    "require": "./dist/cjs/preload.cjs",
+    "import": "./dist/esm/preload.js",
+    "types": "./dist/types/preload.d.ts"
+  },
+  "main": "dist/preload.cjs",
+  "module": "dist/esm/preload.js",
   "types": "dist/types/preload.d.ts",
   "files": [
     "LICENSE",
@@ -29,7 +35,6 @@
     "clean": "rimraf dist coverage",
     "lint": "eslint preload.ts",
     "build": "tsc --build ./tsconfig.json && rollup --config ./rollup.config.ts --configPlugin typescript",
-    "bundle": "yarn build",
     "prepack": "yarn run bundle"
   },
   "peerDependencies": {
@@ -48,7 +53,7 @@
     "rimraf": "^5.0.1",
     "rollup": "^4.0.2",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   },
   "contributors": [
     {

packages/adblocker-electron-preload/rollup.config.ts

@@ -11,17 +11,17 @@ import sourcemaps from 'rollup-plugin-sourcemaps';
 import commonjs from '@rollup/plugin-commonjs';
 
 export default {
-  input: './dist/es6/preload.js',
+  input: './dist/src/preload.js',
   external: ['electron'],
   output: [
     {
-      file: './dist/preload.es6.js',
-      format: 'esm',
+      file: './dist/cjs/preload.cjs',
+      format: 'commonjs',
       sourcemap: true,
     },
     {
-      file: './dist/preload.cjs.js',
-      format: 'commonjs',
+      file: './dist/esm/preload.cjs',
+      format: 'esm',
       sourcemap: true,
     },
   ],

packages/adblocker-electron-preload/tsconfig.json

@@ -1,10 +1,8 @@
 {
   "extends": "../../tsconfig",
   "compilerOptions": {
-    "composite": true,
-    "outDir": "dist/es6",
-    "module": "es6",
-    "declarationDir": "dist/types"
+    "outDir": "./dist/src",
+    "declarationDir": "./dist/types",
   },
   "references": [
     { "path": "../adblocker-content/tsconfig.json" }

packages/adblocker-electron/adblocker.ts

@@ -6,17 +6,19 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import { resolve } from 'path';
-import { ipcMain } from 'electron';
+import * as electron from 'electron';
 import { parse } from 'tldts-experimental';
+import { createRequire } from 'node:module';
 
 import { ElectronRequestType, FiltersEngine, Request } from '@cliqz/adblocker';
 import type {
   IBackgroundCallback,
   IMessageFromBackground,
 } from '@cliqz/adblocker-electron-preload';
 
-const PRELOAD_PATH = resolve(require.resolve('@cliqz/adblocker-electron-preload'));
+const { ipcMain } = electron;
+
+const PRELOAD_PATH = createRequire(import.meta.url).resolve('@cliqz/adblocker-electron-preload');
 
 // https://stackoverflow.com/questions/48854265/why-do-i-see-an-electron-security-warning-after-updating-my-electron-project-t
 process.env['ELECTRON_DISABLE_SECURITY_WARNINGS'] = 'true';

packages/adblocker-electron/package.json

@@ -7,8 +7,14 @@
   },
   "homepage": "https://github.com/cliqz-oss/adblocker#readme",
   "license": "MPL-2.0",
-  "main": "dist/cjs/adblocker.js",
-  "module": "dist/es6/adblocker.js",
+  "type": "module",
+  "exports": {
+    "require": "./dist/cjs/adblocker.cjs",
+    "import": "./dist/esm/adblocker.js",
+    "types": "./dist/types/adblocker.d.ts"
+  },
+  "main": "dist/cjs/adblocker.cjs",
+  "module": "dist/esm/adblocker.js",
   "types": "dist/types/adblocker.d.ts",
   "files": [
     "LICENSE",
@@ -28,10 +34,9 @@
   "scripts": {
     "clean": "rimraf dist coverage",
     "lint": "eslint adblocker.ts",
-    "build": "tsc --build ./tsconfig.json",
-    "bundle": "tsc --build ./tsconfig.bundle.json",
+    "build": "tsc --build ./tsconfig.json && rollup --config ./rollup.config.ts --configPlugin typescript",
     "prepack": "yarn run bundle",
-    "test": "nyc mocha --config ../../.mocharc.js"
+    "test": "nyc mocha --config ../../.mocharc.json"
   },
   "peerDependencies": {
     "electron": ">11"
@@ -42,16 +47,20 @@
     "tldts-experimental": "^6.0.14"
   },
   "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
     "@types/chai": "^4.3.6",
     "@types/mocha": "^10.0.1",
-    "chai": "^4.3.8",
+    "chai": "^5.1.0",
     "electron": "^30.0.0",
     "eslint": "^8.49.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "rimraf": "^5.0.1",
+    "rollup": "^4.17.2",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "rollup-plugin-terser": "^7.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   },
   "contributors": [
     {