compressing 1.5.1 → 1.6.2

package/History.md

@@ -1,4 +1,28 @@
 
+1.6.2 / 2022-07-11
+==================
+
+**fixes**
+  * [[`96226d3`](http://github.com/node-modules/compressing/commit/96226d363c7c8fa9ef1a8098af646de19e729ce7)] - fix: add `suppressSizeWarning` to types and typo fix (#72) (Zeeko <<zeeko@zeeko.dev>>)
+
+1.6.1 / 2022-07-11
+==================
+
+**fixes**
+  * [[`ba49232`](http://github.com/node-modules/compressing/commit/ba49232780a57c9a3800642d7d39ae1dcdfc9409)] - fix(types): onEntry stream type should ReadStream (#73) (Songhn <<songhn233@gmail.com>>)
+
+**others**
+  * [[`054d4a4`](http://github.com/node-modules/compressing/commit/054d4a41ae4ca5d7b9b83e7298e32cc1d62d7ef4)] - 🤖 TEST: Use GitHub Action (#69) (fengmk2 <<fengmk2@gmail.com>>)
+
+1.6.0 / 2022-06-13
+==================
+
+**features**
+  * [[`bd8ef44`](http://github.com/node-modules/compressing/commit/bd8ef44ade2f4b93d41ff2f78d6f17902d965798)] - feat: unzip should keep file mode (#68) (Artin <<lengthmin@gmail.com>>)
+
+**others**
+  * [[`592e518`](http://github.com/node-modules/compressing/commit/592e5180dfbdbc6cb1becd1baf6a007ce7b7cd39)] - Create codeql-analysis.yml (fengmk2 <<fengmk2@gmail.com>>)
+
 1.5.1 / 2020-05-11
 ==================
 

package/README.md

@@ -1,22 +1,13 @@
 # compressing
 
 [![NPM version][npm-image]][npm-url]
-[![build status][travis-image]][travis-url]
 [![Test coverage][codecov-image]][codecov-url]
-[![David deps][david-image]][david-url]
-[![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
 
 [npm-image]: https://img.shields.io/npm/v/compressing.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/compressing
-[travis-image]: https://img.shields.io/travis/node-modules/compressing.svg?style=flat-square
-[travis-url]: https://travis-ci.org/node-modules/compressing
 [codecov-image]: https://codecov.io/gh/node-modules/compressing/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/node-modules/compressing
-[david-image]: https://img.shields.io/david/node-modules/compressing.svg?style=flat-square
-[david-url]: https://david-dm.org/node-modules/compressing
-[snyk-image]: https://snyk.io/test/npm/compressing/badge.svg?style=flat-square
-[snyk-url]: https://snyk.io/test/npm/compressing
 [download-image]: https://img.shields.io/npm/dm/compressing.svg?style=flat-square
 [download-url]: https://npmjs.org/package/compressing
 
@@ -88,7 +79,6 @@ const destStream = fs.createWriteStream('path/to/destination.gz');
 pump(sourceStream, gzipStream, destStream, handleError);
 ```
 
-
 ### Compress a dir
 
 Use tar as an example, tgz and zip is same as gzip.
@@ -167,8 +157,7 @@ compressing.tgz.uncompress(stream, 'path/to/destination/dir')
 .catch(handleError);
 ```
 
-**Note: tar, tgz and zip have the same uncompressing API as above: destination should be a path of a directory, while that of gzip is slightly different: destination must be a file or filestream.**
-
+__Note: tar, tgz and zip have the same uncompressing API as above: destination should be a path of a directory, while that of gzip is slightly different: destination must be a file or filestream.__
 
 And working with urllib is super easy. Let's download a tgz file and uncompress to a directory:
 
@@ -280,7 +269,7 @@ Use this API to uncompress a file. This is a convenient method, which wraps Unco
 Params
 
 - source {String|Buffer|Stream} - source to be uncompressed
-- dest {String|Stream} - uncompressing destination. When uncompressing tar, tgz and zip, it should be a directory path (eg. `/path/to/xx`). **When uncompressing gzip, it should be a file path or a writable stream.**
+- dest {String|Stream} - uncompressing destination. When uncompressing tar, tgz and zip, it should be a directory path (eg. `/path/to/xx`). __When uncompressing gzip, it should be a file path or a writable stream.__
 - opts {Object} - usually you don't need it
   - opts.zipFileNameEncoding {String} - Only work on zip format, default is 'utf8'.
     Major non-UTF8 encodings by languages:
@@ -374,4 +363,15 @@ Due to the design of the .zip file format, it's impossible to interpret a .zip f
 
 Although the API is streaming style(try to keep it handy), it still loads all data into memory.
 
-https://github.com/thejoshwolfe/yauzl#no-streaming-unzip-api
+<https://github.com/thejoshwolfe/yauzl#no-streaming-unzip-api>
+<!-- GITCONTRIBUTOR_START -->
+
+## Contributors
+
+|[<img src="https://avatars.githubusercontent.com/u/456108?v=4" width="100px;"/><br/><sub><b>shaoshuai0102</b></sub>](https://github.com/shaoshuai0102)<br/>|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/9692408?v=4" width="100px;"/><br/><sub><b>DiamondYuan</b></sub>](https://github.com/DiamondYuan)<br/>|[<img src="https://avatars.githubusercontent.com/u/13938334?v=4" width="100px;"/><br/><sub><b>bytemain</b></sub>](https://github.com/bytemain)<br/>|[<img src="https://avatars.githubusercontent.com/u/8382136?v=4" width="100px;"/><br/><sub><b>Ryqsky</b></sub>](https://github.com/Ryqsky)<br/>|
+| :---: | :---: | :---: | :---: | :---: | :---: |
+[<img src="https://avatars.githubusercontent.com/u/47357585?v=4" width="100px;"/><br/><sub><b>songhn233</b></sub>](https://github.com/songhn233)<br/>|[<img src="https://avatars.githubusercontent.com/u/9857273?v=4" width="100px;"/><br/><sub><b>ShadyZOZ</b></sub>](https://github.com/ShadyZOZ)<br/>
+
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Jul 11 2022 08:28:25 GMT+0800`.
+
+<!-- GITCONTRIBUTOR_END -->

package/index.d.ts

@@ -8,6 +8,7 @@ interface streamEntryOpts {
   relativePath?: string
   ignoreBase?: boolean
   size?: number
+  suppressSizeWarning?: boolean
 }
 
 interface streamHeader {
@@ -15,6 +16,12 @@ interface streamHeader {
   name: string
 }
 
+interface streamHeaderWithMode {
+  type: 'file' | 'directory',
+  name: string
+  mode: number
+}
+
 export namespace gzip {
 
   function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>
@@ -79,7 +86,7 @@ export namespace tar {
     });
 
     on(event: string, listener: (...args: any[]) => void): this
-    on(event: 'entry', listener: (header: streamHeader, stream: WriteStream, next: () => void) => void): this
+    on(event: 'entry', listener: (header: streamHeaderWithMode, stream: ReadStream, next: () => void) => void): this
     on(event: 'finish', listener: () => void): this
     on(event: 'error', listener: (err: Error) => void): this
 
@@ -124,7 +131,7 @@ export namespace tgz {
     });
 
     on(event: string, listener: (...args: any[]) => void): this
-    on(event: 'entry', listener: (header: streamHeader, stream: WriteStream, next: () => void) => void): this
+    on(event: 'entry', listener: (header: streamHeaderWithMode, stream: ReadStream, next: () => void) => void): this
     on(event: 'finish', listener: () => void): this
     on(event: 'error', listener: (err: Error) => void): this
 
@@ -177,7 +184,7 @@ export namespace zip {
     });
 
     on(event: string, listener: (...args: any[]) => void): this
-    on(event: 'entry', listener: (header: streamHeader, stream: WriteStream, next: () => void) => void): this
+    on(event: 'entry', listener: (header: streamHeaderWithMode, stream: ReadStream, next: () => void) => void): this
     on(event: 'finish', listener: () => void): this
     on(event: 'error', listener: (err: Error) => void): this
 

package/lib/tar/file_stream.js

@@ -45,7 +45,7 @@ class TarFileStream extends stream.Transform {
         });
       } else {
         if (!opts.suppressSizeWarning) {
-          console.warn('You should specify the size of streamming data by opts.size to prevent all streaming data from loading into memory. If you are sure about memory cost, pass opts.supressSizeWarning: true to suppress this warning');
+          console.warn('You should specify the size of streamming data by opts.size to prevent all streaming data from loading into memory. If you are sure about memory cost, pass opts.suppressSizeWarning: true to suppress this warning');
         }
         const buf = [];
         this.entry = new stream.Writable({

package/lib/tar/stream.js

@@ -101,7 +101,7 @@ class TarStream extends BaseStream {
       entry.pipe(entryStream);
     } else {
       if (!opts.suppressSizeWarning) {
-        console.warn('You should specify the size of streamming data by opts.size to prevent all streaming data from loading into memory. If you are sure about memory cost, pass opts.supressSizeWarning: true to suppress this warning');
+        console.warn('You should specify the size of streamming data by opts.size to prevent all streaming data from loading into memory. If you are sure about memory cost, pass opts.suppressSizeWarning: true to suppress this warning');
       }
       const buf = [];
       const collectStream = new stream.Writable({

package/lib/zip/uncompress_stream.js

@@ -18,6 +18,15 @@ const STRIP_NAME = Symbol('ZipUncompressStream#stripName');
 //  - support "absolute path"
 const DEFAULTS = { lazyEntries: true, decodeStrings: false };
 
+// from: https://github.com/microsoft/vscode/blob/c0769274fa136b45799edeccc0d0a2f645b75caf/src/vs/base/node/zip.ts#L51
+function modeFromEntry(entry) {
+  const attr = entry.externalFileAttributes >> 16 || 33188;
+
+  return [ 448 /* S_IRWXU */, 56 /* S_IRWXG */, 7 /* S_IRWXO */ ]
+    .map(mask => attr & mask)
+    .reduce((a, b) => a + b, attr & 61440 /* S_IFMT */);
+}
+
 class ZipUncompressStream extends UncompressBaseStream {
   constructor(opts) {
     opts = opts || {};
@@ -77,6 +86,7 @@ class ZipUncompressStream extends UncompressBaseStream {
 
     zipFile
     .on('entry', entry => {
+      const mode = modeFromEntry(entry);
       // fileName is buffer by default because decodeStrings = false
       if (Buffer.isBuffer(entry.fileName)) {
         if (this._zipFileNameEncoding === 'utf8') {
@@ -92,7 +102,7 @@ class ZipUncompressStream extends UncompressBaseStream {
       const type = /\/$/.test(entry.fileName) ? 'directory' : 'file';
       const name = entry.fileName = this[STRIP_NAME](entry.fileName, type);
 
-      const header = { name, type, yauzl: entry };
+      const header = { name, type, yauzl: entry, mode };
 
       if (type === 'file') {
         zipFile.openReadStream(entry, (err, readStream) => {

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "compressing",
-  "version": "1.5.1",
+  "version": "1.6.2",
   "description": "Everything you need for compressing and uncompressing",
   "main": "index.js",
   "scripts": {
+    "contributor": "git-contributor",
     "ts-test": "tsc -p ./test/fixtures/types/tsconfig.json",
     "test": "egg-bin test && npm run ts-test",
     "cov": "egg-bin cov",
-    "lint": "eslint .",
+    "lint": "eslint . --fix",
     "ci": "npm run lint && npm run ts-test && npm run cov"
   },
   "repository": {
@@ -52,9 +53,10 @@
     "@types/node": "^10.12.9",
     "dir-compare": "^1.3.0",
     "egg-bin": "^1.9.1",
-    "egg-ci": "^1.8.0",
+    "egg-ci": "^2.1.0",
     "eslint": "^3.10.2",
     "eslint-config-egg": "^3.2.0",
+    "git-contributor": "^1.1.0",
     "mm": "^2.0.0",
     "mz-modules": "^2.1.0",
     "power-assert": "^1.4.2",
@@ -66,7 +68,8 @@
     "node": ">= 4.0.0"
   },
   "ci": {
-    "version": "4, 6, 8, 10, 12",
+    "version": "10, 12, 14, 16, 18",
+    "os": "linux, macos",
     "license": {
       "year": "2017",
       "fullname": "node-modules and other contributors"