fix esm export (#131)

Author: ctalkington

.github/workflows/nodejs.yml

@@ -17,14 +17,14 @@ jobs:
         node-version: [18.x, 20.x]
 
     steps:
-    - uses: actions/checkout@v4.2.1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4.0.4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: npm install and test
-      run: |
-        npm ci
-        npm test
-      env:
-        CI: true
+      - uses: actions/checkout@v4.2.1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4.0.4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: npm install and test
+        run: |
+          npm ci
+          npm test
+        env:
+          CI: true

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts:
+build
+coverage

CONTRIBUTING.md

@@ -2,13 +2,13 @@
 
 #### Code Style Guide
 
-* code should be indented with 2 spaces
-* single quotes should be used where feasible
-* commas should be followed by a single space (function params, etc)
-* variable declaration should include `var`, [no multiple declarations](http://benalman.com/news/2012/05/multiple-var-statements-javascript/)
+- code should be indented with 2 spaces
+- single quotes should be used where feasible
+- commas should be followed by a single space (function params, etc)
+- variable declaration should include `var`, [no multiple declarations](http://benalman.com/news/2012/05/multiple-var-statements-javascript/)
 
 #### Tests
 
-* tests should be added to the nodeunit configs in `test/`
-* tests can be run with `npm test`
-* see existing tests for guidance
+- tests should be added to the nodeunit configs in `test/`
+- tests can be run with `npm test`
+- see existing tests for guidance

README.md

@@ -17,20 +17,20 @@ You can also use `npm install https://github.com/archiverjs/node-crc32-stream/ar
 Inherits [Transform Stream](http://nodejs.org/api/stream.html#stream_class_stream_transform) options and methods.
 
 ```js
-const {CRC32Stream} = require('crc32-stream');
+const { CRC32Stream } = require("crc32-stream");
 
-const source = fs.createReadStream('file.txt');
+const source = fs.createReadStream("file.txt");
 const checksum = new CRC32Stream();
 
-checksum.on('end', function(err) {
+checksum.on("end", function (err) {
   // do something with checksum.digest() here
 });
 
 // either pipe it
 source.pipe(checksum);
 
 // or write it
-checksum.write('string');
+checksum.write("string");
 checksum.end();
 ```
 
@@ -39,20 +39,20 @@ checksum.end();
 Inherits [zlib.DeflateRaw](http://nodejs.org/api/zlib.html#zlib_class_zlib_deflateraw) options and methods.
 
 ```js
-const {DeflateCRC32Stream} = require('crc32-stream');
+const { DeflateCRC32Stream } = require("crc32-stream");
 
-const source = fs.createReadStream('file.txt');
+const source = fs.createReadStream("file.txt");
 const checksum = new DeflateCRC32Stream();
 
-checksum.on('end', function(err) {
+checksum.on("end", function (err) {
   // do something with checksum.digest() here
 });
 
 // either pipe it
 source.pipe(checksum);
 
 // or write it
-checksum.write('string');
+checksum.write("string");
 checksum.end();
 ```
 

lib/crc32-stream.js

@@ -2,28 +2,28 @@ import { Transform } from "readable-stream";
 import crc32 from "crc-32";
 
 export default class CRC32Stream extends Transform {
-    constructor(options) {
-        super(options);
-        this.checksum = Buffer.allocUnsafe(4);
-        this.checksum.writeInt32BE(0, 0);
-        this.rawSize = 0;
+  constructor(options) {
+    super(options);
+    this.checksum = Buffer.allocUnsafe(4);
+    this.checksum.writeInt32BE(0, 0);
+    this.rawSize = 0;
+  }
+  _transform(chunk, encoding, callback) {
+    if (chunk) {
+      this.checksum = crc32.buf(chunk, this.checksum) >>> 0;
+      this.rawSize += chunk.length;
     }
-    _transform(chunk, encoding, callback) {
-        if (chunk) {
-            this.checksum = crc32.buf(chunk, this.checksum) >>> 0;
-            this.rawSize += chunk.length;
-        }
-        callback(null, chunk);
-    }
-    digest(encoding) {
-        const checksum = Buffer.allocUnsafe(4);
-        checksum.writeUInt32BE(this.checksum >>> 0, 0);
-        return encoding ? checksum.toString(encoding) : checksum;
-    }
-    hex() {
-        return this.digest('hex').toUpperCase();
-    }
-    size() {
-        return this.rawSize;
-    }
-}
+    callback(null, chunk);
+  }
+  digest(encoding) {
+    const checksum = Buffer.allocUnsafe(4);
+    checksum.writeUInt32BE(this.checksum >>> 0, 0);
+    return encoding ? checksum.toString(encoding) : checksum;
+  }
+  hex() {
+    return this.digest("hex").toUpperCase();
+  }
+  size() {
+    return this.rawSize;
+  }
+}

lib/deflate-crc32-stream.js

@@ -2,40 +2,39 @@ import { DeflateRaw } from "zlib";
 import crc32 from "crc-32";
 
 export default class DeflateCRC32Stream extends DeflateRaw {
-    constructor(options) {
-        super(options);
-        this.checksum = Buffer.allocUnsafe(4);
-        this.checksum.writeInt32BE(0, 0);
-        this.rawSize = 0;
-        this.compressedSize = 0;
+  constructor(options) {
+    super(options);
+    this.checksum = Buffer.allocUnsafe(4);
+    this.checksum.writeInt32BE(0, 0);
+    this.rawSize = 0;
+    this.compressedSize = 0;
+  }
+  push(chunk, encoding) {
+    if (chunk) {
+      this.compressedSize += chunk.length;
     }
-    push(chunk, encoding) {
-        if (chunk) {
-            this.compressedSize += chunk.length;
-        }
-        return super.push(chunk, encoding);
+    return super.push(chunk, encoding);
+  }
+  _transform(chunk, encoding, callback) {
+    if (chunk) {
+      this.checksum = crc32.buf(chunk, this.checksum) >>> 0;
+      this.rawSize += chunk.length;
     }
-    _transform(chunk, encoding, callback) {
-        if (chunk) {
-            this.checksum = crc32.buf(chunk, this.checksum) >>> 0;
-            this.rawSize += chunk.length;
-        }
-        super._transform(chunk, encoding, callback);
-    }
-    digest(encoding) {
-        const checksum = Buffer.allocUnsafe(4);
-        checksum.writeUInt32BE(this.checksum >>> 0, 0);
-        return encoding ? checksum.toString(encoding) : checksum;
-    }
-    hex() {
-        return this.digest('hex').toUpperCase();
-    }
-    size(compressed = false) {
-        if (compressed) {
-            return this.compressedSize;
-        }
-        else {
-            return this.rawSize;
-        }
+    super._transform(chunk, encoding, callback);
+  }
+  digest(encoding) {
+    const checksum = Buffer.allocUnsafe(4);
+    checksum.writeUInt32BE(this.checksum >>> 0, 0);
+    return encoding ? checksum.toString(encoding) : checksum;
+  }
+  hex() {
+    return this.digest("hex").toUpperCase();
+  }
+  size(compressed = false) {
+    if (compressed) {
+      return this.compressedSize;
+    } else {
+      return this.rawSize;
     }
+  }
 }

lib/index.js

@@ -5,9 +5,11 @@
  * Licensed under the MIT license.
  * https://github.com/archiverjs/node-crc32-stream/blob/master/LICENSE-MIT
  */
-export const CRC32Stream = require('./crc32-stream');
-export const DeflateCRC32Stream = require('./deflate-crc32-stream');
+import CRC32Stream from "./crc32-stream.js";
+import DeflateCRC32Stream from "./deflate-crc32-stream.js";
+
+export { CRC32Stream, DeflateCRC32Stream };
 export default {
-    CRC32Stream,
-    DeflateCRC32Stream
+  CRC32Stream,
+  DeflateCRC32Stream,
 };

package-lock.json

@@ -32,7 +32,8 @@
   },
   "devDependencies": {
     "chai": "^5.1.1",
-    "mocha": "10.7.3"
+    "mocha": "10.7.3",
+    "prettier": "3.3.3"
   },
   "keywords": [
     "crc32-stream",

package.json

@@ -3,42 +3,44 @@ import crc32 from "crc-32";
 import { BinaryStream, DeadEndStream } from "./helpers/index.js";
 import CRC32Stream from "../lib/crc32-stream.js";
 /*global before,describe,it */
-describe('CRC32Stream', function () {
-    it('should checksum data while passing through data', function (done) {
-        const binary = new BinaryStream(1024 * 16);
-        const checksum = new CRC32Stream();
-        const deadend = new DeadEndStream();
-        checksum.on('end', function () {
-            assert.equal(checksum.digest().readUInt32BE(0), 3893830384);
-            assert.equal(checksum.digest('hex'), 'e81722f0');
-            assert.equal(checksum.hex(), 'E81722F0');
-            assert.equal(checksum.size(), 16384);
-            done();
-        });
-        checksum.pipe(deadend);
-        binary.pipe(checksum);
+
+describe("CRC32Stream", function () {
+  it("should checksum data while passing through data", function (done) {
+    const binary = new BinaryStream(1024 * 16);
+    const checksum = new CRC32Stream();
+    const deadend = new DeadEndStream();
+    checksum.on("end", function () {
+      assert.equal(checksum.digest().readUInt32BE(0), 3893830384);
+      assert.equal(checksum.digest("hex"), "e81722f0");
+      assert.equal(checksum.hex(), "E81722F0");
+      assert.equal(checksum.size(), 16384);
+      done();
     });
-    it('should have same checksum when bytes written together or separately', function (done) {
-        const checksum = new CRC32Stream();
-        const deadend = new DeadEndStream();
-        const expectedChecksumValue = crc32.buf([157, 10, 217, 109, 100, 200, 300]) >>> 0;
-        checksum.on('end', function () {
-            assert.equal(checksum.digest().readUInt32BE(0), expectedChecksumValue);
-            done();
-        });
-        checksum.write(Buffer.from([157, 10, 217, 109]));
-        checksum.write(Buffer.from([100, 200, 300]));
-        checksum.end();
-        checksum.pipe(deadend);
+    checksum.pipe(deadend);
+    binary.pipe(checksum);
+  });
+  it("should have same checksum when bytes written together or separately", function (done) {
+    const checksum = new CRC32Stream();
+    const deadend = new DeadEndStream();
+    const expectedChecksumValue =
+      crc32.buf([157, 10, 217, 109, 100, 200, 300]) >>> 0;
+    checksum.on("end", function () {
+      assert.equal(checksum.digest().readUInt32BE(0), expectedChecksumValue);
+      done();
     });
-    it('should gracefully handle having no data chunks passed to it', function (done) {
-        const checksum = new CRC32Stream();
-        const deadend = new DeadEndStream();
-        checksum.on('end', function () {
-            assert.equal(checksum.digest().readUInt32BE(0), 0);
-            done();
-        });
-        checksum.pipe(deadend);
-        checksum.end();
+    checksum.write(Buffer.from([157, 10, 217, 109]));
+    checksum.write(Buffer.from([100, 200, 300]));
+    checksum.end();
+    checksum.pipe(deadend);
+  });
+  it("should gracefully handle having no data chunks passed to it", function (done) {
+    const checksum = new CRC32Stream();
+    const deadend = new DeadEndStream();
+    checksum.on("end", function () {
+      assert.equal(checksum.digest().readUInt32BE(0), 0);
+      done();
     });
+    checksum.pipe(deadend);
+    checksum.end();
+  });
 });