.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "06:05"
+    open-pull-requests-limit: 12
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "06:00"
+    open-pull-requests-limit: 12

.github/release-drafter.yml

@@ -0,0 +1,4 @@
+template: |
+  ## What’s Changed
+
+  $CHANGES

.github/workflows/nodejs.yml

@@ -0,0 +1,30 @@
+name: Node CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+    - uses: actions/checkout@v2.3.1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2.1.0
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: npm install and test
+      run: |
+        npm ci
+        npm test
+      env:
+        CI: true

.github/workflows/npmpublish.yml

@@ -0,0 +1,30 @@
+name: Node Publish Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.1
+      - uses: actions/setup-node@v2.1.0
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.1
+      - uses: actions/setup-node@v2.1.0
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/release-drafter.yml

@@ -0,0 +1,15 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    name: Update Release Draft
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,5 +1,4 @@
 npm-debug.log
-package-lock.json
 node_modules/
 tmp/
 test/fixtures/bench

CHANGELOG.md

@@ -1,6 +1,90 @@
 ## Changelog
 
-**2.0.0** — <small>_July 5th, 2017_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/1.3.0...2.0.0)
+**5.0.0** - <small>_July 22, 2020_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/4.0.2...5.0.0)
+
+* breaking: absolute path glob patterns are no longer supported: use cwd option instead.
+* Replaced glob with readdir-glob to be memory efficient (#433) @Yqnn
+* Bump zip-stream from 4.0.0 to 4.0.2 (#431) @dependabot
+* Bump zip-stream from 3.0.1 to 4.0.0 (#430) @dependabot
+* Bump mocha from 6.2.3 to 8.0.1 (#424) @dependabot
+* Bump tar from 4.4.13 to 6.0.2 (#426) @dependabot
+* Bump tar-stream from 2.1.2 to 2.1.3 (#427) @dependabot
+* Bump rimraf from 2.7.1 to 3.0.2 (#425) @dependabot
+* Bump actions/setup-node from v1 to v2.1.0 (#428) @dependabot
+* Bump actions/checkout from v1 to v2.3.1 (#429) @dependabot
+* Bump lodash from 4.17.15 to 4.17.19 (#423) @dependabot
+
+**4.0.2** - <small>_July 11, 2020_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/4.0.1...4.0.2)
+
+- update to async@^3.2.0 (#420)
+
+**4.0.1** - <small>_April 14, 2020_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/4.0.0...4.0.1)
+
+- update to zip-stream@^3.0.1
+
+**4.0.0** - <small>_April 14, 2020_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/3.1.1...4.0.0)
+
+- breaking: slowly catch up with node LTS, remove support for versions under 8.
+- update multiple deps.
+- fix for a hang with _statQueue (#388)
+
+**3.1.1** - <small>_August 2, 2019_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/3.1.0...3.1.1)
+
+- update zip-stream to v2.1.2
+
+**3.1.0** - <small>_August 2, 2019_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/3.0.3...3.1.0)
+
+- update zip-stream to v2.1.0
+
+**3.0.3** - <small>_July 19, 2019_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/3.0.2...3.0.3)
+
+- test: now targeting node v12
+- other: update zip-stream@2.0.0
+
+**3.0.2** - <small>_July 19, 2019_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/3.0.1...3.0.2)
+
+- other: update dependencies
+
+**3.0.1** - <small>_July 19, 2019_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/3.0.0...3.0.1)
+
+- other: update dependencies
+- docs: now deployed using netlify
+
+**3.0.0** - <small>_August 22, 2018_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/2.1.1...3.0.0)
+
+- breaking: follow node LTS, remove support for versions under 6. (#339)
+- bugfix: use stats in tar.js and core.js (#326)
+- other: update to archiver-utils@2 and zip-stream@2
+- other: remove lodash npm module usage (#335, #339)
+- other: Avoid using deprecated Buffer constructor (#312)
+- other: Remove unnecessary return and fix indentation (#297)
+- test: now targeting node v10 (#320)
+
+**2.1.1** — <small>_January 10, 2018_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/2.1.0...2.1.1)
+
+- bugfix: fix relative symlink paths (#293)
+- other: coding style fixes (#294)
+
+**2.1.0** — <small>_October 12, 2017_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/2.0.3...2.1.0)
+
+- refactor: `directory` now uses glob behind the scenes. should fix some directory recursion issues. (#267, #275)
+- docs: more info in quick start. (#284)
+
+**2.0.3** — <small>_August 25, 2017_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/2.0.2...2.0.3)
+
+- bugfix: revert #261 due to potential issues with editing entryData in special cases.
+- bugfix: add var to entryData in glob callback (#273)
+
+**2.0.2** — <small>_August 25, 2017_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/2.0.1...2.0.2)
+
+- docs: fix changelog date.
+
+**2.0.1** — <small>_August 25, 2017_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/2.0.0...2.0.1)
+
+- bugfix: add const to entryData in glob callback (#261)
+- other: coding style fixes (#263)
+
+**2.0.0** — <small>_July 5, 2017_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/1.3.0...2.0.0)
 
 - feature: support for symlinks. (#228)
 - feature: support for promises on `finalize`. (#248)
@@ -9,7 +93,7 @@
 - change: errors and warnings now contain extended data (where available) and have standardized error codes (#256)
 - change: removal of deprecated `bulk` functionality. (#249)
 - change: removal of internal  `_entries` property in favor of `progress` event. (#247)
-- change: support for node v0.4+ only. node v0.10 and v0.12 support has been dropped. (#241)
+- change: support for node v4.0+ only. node v0.10 and v0.12 support has been dropped. (#241)
 
 **1.3.0** — <small>_December 13, 2016_</small> — [Diff](https://github.com/archiverjs/node-archiver/compare/1.2.0...1.3.0)
 
@@ -49,4 +133,4 @@
 - simpler path normalization as path.join was a bit restrictive. #162
 - move utils to separate module to DRY.
 
-[Release Archive](https://github.com/archiverjs/node-archiver/releases)
+[Release Archive](https://github.com/archiverjs/node-archiver/releases)

README.md

@@ -1,10 +1,8 @@
-# Archiver v2.0.0
-
-[![Build Status](https://travis-ci.org/archiverjs/node-archiver.svg?branch=master)](https://travis-ci.org/archiverjs/node-archiver) [![Build status](https://ci.appveyor.com/api/projects/status/38kqu3yp159nodxe/branch/master?svg=true)](https://ci.appveyor.com/project/ctalkington/node-archiver/branch/master)
+# Archiver
 
 a streaming interface for archive generation
 
-Visit the [API documentation](http://archiverjs.com/docs) for a list of all methods available.
+Visit the [API documentation](https://www.archiverjs.com/) for a list of all methods available.
 
 ## Install
 
@@ -22,22 +20,30 @@ var archiver = require('archiver');
 // create a file to stream archive data to.
 var output = fs.createWriteStream(__dirname + '/example.zip');
 var archive = archiver('zip', {
-    zlib: { level: 9 } // Sets the compression level.
+  zlib: { level: 9 } // Sets the compression level.
 });
 
 // listen for all archive data to be written
+// 'close' event is fired only when a file descriptor is involved
 output.on('close', function() {
   console.log(archive.pointer() + ' total bytes');
   console.log('archiver has been finalized and the output file descriptor has closed.');
 });
 
+// This event is fired when the data source is drained no matter what was the data source.
+// It is not part of this library but rather from the NodeJS Stream API.
+// @see: https://nodejs.org/api/stream.html#stream_event_end
+output.on('end', function() {
+  console.log('Data has been drained');
+});
+
 // good practice to catch warnings (ie stat failures and other non-blocking errors)
 archive.on('warning', function(err) {
   if (err.code === 'ENOENT') {
-      // log warning
+    // log warning
   } else {
-      // throw error
-      throw err;
+    // throw error
+    throw err;
   }
 });
 
@@ -73,6 +79,7 @@ archive.directory('subdir/', false);
 archive.glob('subdir/*.txt');
 
 // finalize the archive (ie we are done appending files but streams have to finish yet)
+// 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
 archive.finalize();
 ```
 
@@ -82,4 +89,4 @@ Archiver ships with out of the box support for TAR and ZIP archives.
 
 You can register additional formats with `registerFormat`.
 
-_Formats will be changing in the next few releases to implement a middleware approach._
+_Formats will be changing in the future to implement a middleware approach._

appveyor.yml

@@ -1,12 +1,10 @@
 environment:
   matrix:
-    - nodejs_version: '8'
-    - nodejs_version: '6'
-    - nodejs_version: '4'
+    - nodejs_version: '12'
+    - nodejs_version: '10'
 install:
   - ps: Install-Product node $env:nodejs_version
   - set CI=true
-  - npm -g install npm@latest
   - set PATH=%APPDATA%\npm;%PATH%
   - npm install
 matrix:
@@ -18,4 +16,4 @@ clone_depth: 1
 test_script:
   - node --version
   - npm --version
-  - npm test
+  - npm test

benchmark/common.js

@@ -1,5 +1,5 @@
 function binaryBuffer(n) {
-  var buffer = new Buffer(n);
+  var buffer = Buffer.alloc(n);
 
   for (var i = 0; i < n; i++) {
     buffer.writeUInt8(i&255, i);

benchmark/simple/pack-zip.js

@@ -3,7 +3,7 @@ var fs = require('fs');
 var mkdir = require('mkdirp');
 var streamBench = require('stream-bench');
 
-var archiver = require('../../lib/archiver');
+var archiver = require('../../');
 var common = require('../common');
 
 var binaryBuffer = common.binaryBuffer;
@@ -55,4 +55,4 @@ archive.pipe(bench);
 
 archive
   .file(file, { name: 'large file' })
-  .finalize();
+  .finalize();