refactor: switch to ESM (#90)

BREAKING CHANGES: ESM only * chore: update imports and export index.js esm import/export syntax Signed-off-by: Lakshya Singh <[email protected]> * chore: update imports in tests esm import syntax with path Signed-off-by: Lakshya Singh <[email protected]> * chore: bump bitfield for esm 4.1.0 is esm based while 4.0.0 was commonjs Signed-off-by: Lakshya Singh <[email protected]> * chore: update package.json for esm specify minimum nodejs version for esm support exports defined type change to module Signed-off-by: Lakshya Singh <[email protected]> * chore: update readme with esm syntax Signed-off-by: Lakshya Singh <[email protected]>
webtorrent · Apr 28, 2022 · fce2548 · fce2548
1 parent 6d180d5
commit fce2548
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -35,8 +35,8 @@ duplex streams | a.pipe(b).pipe(a)
 (Images from the ["harnessing streams"](https://github.com/substack/lxjs-stream-examples/blob/master/slides.markdown) talk by substack.)
 
 ```js
-const Protocol = require('bittorrent-protocol')
-const net = require('net')
+import Protocol from 'bittorrent-protocol'
+import net from 'net'
 
 net.createServer(socket => {
 	const wire = new Protocol()
@@ -305,9 +305,9 @@ Here is an example of the **ut_metadata** extension being used with
 **bittorrent-protocol**:
 
 ```js
-const Protocol = require('bittorrent-protocol')
-const net = require('net')
-const ut_metadata = require('ut_metadata')
+import Protocol from 'bittorrent-protocol'
+import net from 'net'
+import ut_metadata from 'ut_metadata'
 
 net.createServer(socket => {
   const wire = new Protocol()

diff --git a/index.js b/index.js
@@ -1,14 +1,16 @@
 /*! bittorrent-protocol. MIT License. WebTorrent LLC <https://webtorrent.io/opensource> */
-const arrayRemove = require('unordered-array-remove')
-const bencode = require('bencode')
-const BitField = require('bitfield').default
-const crypto = require('crypto')
-const debug = require('debug')('bittorrent-protocol')
-const randombytes = require('randombytes')
-const sha1 = require('simple-sha1')
-const speedometer = require('speedometer')
-const stream = require('readable-stream')
-const RC4 = require('rc4')
+import bencode from 'bencode'
+import BitField from 'bitfield'
+import crypto from 'crypto'
+import Debug from 'debug'
+import randombytes from 'randombytes'
+import RC4 from 'rc4'
+import stream from 'readable-stream'
+import sha1 from 'simple-sha1'
+import speedometer from 'speedometer'
+import arrayRemove from 'unordered-array-remove'
+
+const debug = Debug('bittorrent-protocol')
 
 const BITFIELD_GROW = 400000
 const KEEP_ALIVE_TIMEOUT = 55000
@@ -1353,4 +1355,4 @@ class Wire extends stream.Duplex {
   }
 }
 
-module.exports = Wire
+export default Wire
diff --git a/package.json b/package.json
@@ -1,5 +1,6 @@
 {
   "name": "bittorrent-protocol",
+  "type": "module",
   "description": "Simple, robust, BitTorrent peer wire protocol implementation",
   "version": "3.5.3",
   "author": {
@@ -12,7 +13,7 @@
   },
   "dependencies": {
     "bencode": "^2.0.2",
-    "bitfield": "^4.0.0",
+    "bitfield": "^4.1.0",
     "debug": "^4.3.4",
     "randombytes": "^2.1.0",
     "rc4": "^0.1.5",
@@ -27,6 +28,12 @@
     "standard": "*",
     "tape": "5.5.3"
   },
+  "engines": {
+    "node": ">=12.20.0"
+  },
+  "exports": {
+    "import": "./index.js"
+  },
   "keywords": [
     "bittorrent",
     "p2p",
@@ -38,7 +45,6 @@
     "wire"
   ],
   "license": "MIT",
-  "main": "index.js",
   "repository": {
     "type": "git",
     "url": "git://github.com/webtorrent/bittorrent-protocol.git"

diff --git a/test/extension.js b/test/extension.js
@@ -1,5 +1,5 @@
-const Protocol = require('../')
-const test = require('tape')
+import test from 'tape'
+import Protocol from '../index.js'
 
 test('Extension.prototype.name', t => {
   t.plan(2)

diff --git a/test/no-timeout.js b/test/no-timeout.js
@@ -1,5 +1,5 @@
-const Protocol = require('../')
-const test = require('tape')
+import test from 'tape'
+import Protocol from '../index.js'
 
 test('No timeout when peer is good', t => {
   t.plan(3)

diff --git a/test/protocol.js b/test/protocol.js
@@ -1,5 +1,5 @@
-const Protocol = require('../')
-const test = require('tape')
+import test from 'tape'
+import Protocol from '../index.js'
 
 test('Handshake', t => {
   t.plan(4)

diff --git a/test/state-change-on-end.js b/test/state-change-on-end.js
@@ -1,5 +1,5 @@
-const Protocol = require('../')
-const test = require('tape')
+import test from 'tape'
+import Protocol from '../index.js'
 
 test('State changes correctly on wire \'end\'', t => {
   t.plan(11)

diff --git a/test/timeout-destroy.js b/test/timeout-destroy.js
@@ -1,5 +1,5 @@
-const Protocol = require('../')
-const test = require('tape')
+import test from 'tape'
+import Protocol from '../index.js'
 
 test('Timeout and destroy when peer does not respond', t => {
   t.plan(4)

diff --git a/test/timeout.js b/test/timeout.js
@@ -1,5 +1,5 @@
-const Protocol = require('../')
-const test = require('tape')
+import test from 'tape'
+import Protocol from '../index.js'
 
 test('Timeout when peer does not respond', t => {
   t.plan(9)