Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

A Node.js wrapper for 7-Zip, a fork ofhttps://www.npmjs.org/package/node-7z

License

NotificationsYou must be signed in to change notification settings

noderaider/es-7z

 
 

Repository files navigation

Heavily reworked fork of node-7z by Quentin Rossetti that adds support for configurable 7zip path, much thanks to Quentin for doing all the hard work!

Build Statuscodecov

NPM

Install

npm i -S es-7z

Differences fromnode-7z

  • Library is all ES Module syntax, compiled with babel.
  • Tests are ES module syntax, compiled on the fly and run by mocha.
  • Every method export takes an optionalexePath option which is expected to be a path to 7z.exe / 7za.exe. If omitted, the default in path will be attempted.

Usage

import{extractFull7z}from'es-7z'importpathfrom'path'constexePath=path.resolve(__dirname,'..','bin','7za.exe')extractFull7z('myArchive.7z','destination',{ exePath,p:'myPassword'})// Equivalent to `on('data', function (files) { // ... });`.progress(function(files){console.log('Some files are extracted: %s',files);});// When all is done.then(function(){console.log('Extracting done!');});// On error.catch(function(err){console.error(err);});

Installation

You must have the7za executable available in your PATH or in the samedirectory of yourpackage.json file OR specify it as option exePath that ishanded into each method.

On Debian an Ubuntu install thep7zip-full package.

On Windows use the7za.exe (link here)binary.

On Mac OSX use Homebrewbrew install p7zip

API

See the7-Zip documentationfor the full list of usages and options (switches).

The type of the list of files can be eitherString orArray.

Add:Zip.add

Arguments

  • archive Path to the archive you want to create.
  • files The file list to add.
  • options An object of options (7-Zip switches).

Progress

  • files A array of all the extracted filesAND directories. The/character is used as a path separator on every platform.

Error

  • err An Error object.

Delete:Zip.delete

Arguments

  • archive Path to the archive you want to delete files from.
  • files The file list to delete.
  • options An object of options (7-Zip switches).

Error

  • err An Error object.

Extract:Zip.extract

Arguments

  • archive The path to the archive you want to extract.
  • dest Where to extract the archive.
  • options An object of options.

Progress

  • files A array of all the extracted filesAND directories. The/character is used as a path separator on every platform.

Error

  • err An Error object.

Extract with full paths:Zip.extractFull

Arguments

  • archive The path to the archive you want to extract.
  • dest Where to extract the archive (creates folders for you).
  • options An object of options.

Progress

  • files A array of all the extracted filesAND directories. The/character is used as a path separator on every platform.

Error

  • err An Error object.

List contents of archive:Zip.list

Arguments

  • archive The path to the archive you want to analyse.
  • options An object of options.

Progress

  • files A array of objects of all the extracted filesAND directories.The/ character is used as a path separator on every platform. Object'sproperties are:date,attr,size andname.

Fulfill

  • spec An object of tech spec about the archive. Properties are:path,type,method,physicalSize andheadersSize (Some of them may bemissing with non-7z archives).

Error

  • err An Error object.

Test integrity of archive:Zip.test

Arguments

  • archive The path to the archive you want to analyse.
  • options An object of options.

Progress

  • files A array of all the extracted filesAND directories. The/character is used as a path separator on every platform.

Error

  • err An Error object.

Update:Zip.update

Arguments

  • archive Path to the archive you want to update.
  • files The file list to update.
  • options An object of options (7-Zip switches).

Progress

  • files A array of all the extracted filesAND directories. The/character is used as a path separator on every platform.

Error

  • err An Error object.

Advanced usage

Compression method

With the7za binary compression is made like that:

# adds *.exe and *.dll files to solid archive archive.7z using LZMA method# with2 MB dictionary and BCJ filter.7z a archive.7z *.exe -m0=BCJ -m1=LZMA:d=21

Withes-7z you can translate it like that:

import{add7z}from'es-7z'add7z('archive.7z','*.exe',{m0:'=BCJ',m1:'=LZMA:d=21'}).then(function(){// Do stuff...});

Add, delete and update multiple files

When adding, deleting or updating archives you can pass either a string or anarray as second parameter (thefiles parameter).

import{delete7z}from'es-7z'delete7z('bigArchive.7z',['file1','file2']).then(function(){// Do stuff...});

Wildcards

You can extract with wildcards to specify one or more file extensions. To dothis add awildcards attribute to theoptions object. Thewildcardattribute takes anArray as value. In this array each item is a wildcard.

import{extractFull7z}from'es-7z'extractFull7z('archive.zip','destination/',{wildcards:['*.txt','*.md'],// extract all text and Markdown filesr:true// in each subfolder too}).progress(function(files){// Do stuff with files...}).then(function(){// Do stuff...});

Note that ther (for recursive) attribute is passed in this example.

With ❤️ fromquentinrossetti andCole Chamberlain

TEST

Unit tests output for current release:

TOC

add

should return an error on 7z error.

(0,_add2.default)('.tmp/test/addnot.7z','.tmp/test/nothere',{'???':true}).catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return entries on progress.

(0,_add2.default)('.tmp/test/add.zip','*.md').progress(function(entries){(0,_chai.expect)(entries.length).to.be.at.least(1);done();});

delete

should return an error on 7z error.

(0,_delete2.default)('.tmp/test/addnot.7z','.tmp/test/nothere',{'???':true}).catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return on fulfillment.

_fsExtra2.default.copySync('test/zip.7z','.tmp/test/copy.7z');(0,_delete2.default)('.tmp/test/copy.7z','*.txt').then(function(){done();});

should accept array as source.

_fsExtra2.default.copySync('test/zip.7z','.tmp/d.7z');(0,_delete2.default)('.tmp/d.7z',['zip/file0.txt','zip/file1.txt']).then(function(){(0,_extractFull2.default)('.tmp/d.7z','.tmp/d').then(function(){varfiles=_fsExtra2.default.readdirSync('.tmp/d/zip');(0,_chai.expect)(files).not.to.contain('file0.txt');(0,_chai.expect)(files).not.to.contain('file1.txt');(0,_chai.expect)(files).to.contain('file2.txt');(0,_chai.expect)(files).to.contain('folder');done();});});

extract

should return an error on 7z error.

(0,_extract2.default)('test/nothere.7z','.tmp/test').catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return an error on output duplticate.

(0,_extract2.default)('test/zip.7z','.tmp/test',{o:'.tmp/test/duplicate'}).catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return entries on progress.

(0,_extract2.default)('test/zip.7z','.tmp/test').progress(function(entries){(0,_chai.expect)(entries.length).to.be.at.least(1);done();});

should extract on the right path.

(0,_extract2.default)('test/zip.7z','.tmp/test').then(function(){(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test/file0.txt')).to.be.eql(true);(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test/file1.txt')).to.be.eql(true);(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test/file2.txt')).to.be.eql(true);(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test/file3.txt')).to.be.eql(true);done();});

extractFull

should return an error on 7z error.

(0,_extractFull2.default)('test/nothere.7z','.tmp/test').catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return an error on output duplicate.

(0,_extractFull2.default)('test/zip.7z','.tmp/test',{o:'.tmp/test/duplicate'}).catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return entries on progress.

(0,_extractFull2.default)('test/zip.7z','.tmp/test').progress(function(entries){(0,_chai.expect)(entries.length).to.be.at.least(1);done();});

should extract on the right path.

(0,_extractFull2.default)('test/zip.7z','.tmp/test').then(function(){(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test/zip')).to.be.eql(true);done();});

should extract only given wilcards.

(0,_extractFull2.default)('test/wildcards.zip','.tmp/test/',{wildcards:['*.txt'],r:true}).progress(function(files){files.forEach(function(f){(0,_chai.expect)(f).to.include('.txt');});}).then(function(){done();}).catch(function(err){done(err);});

should work with spaces in archive name.

(0,_extractFull2.default)('test/zip spaces test.7z','.tmp/test spaces one').then(function(){(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test spaces one/zip')).to.be.eql(true);done();});

should work with spaces in destination.

(0,_extractFull2.default)('test/zip.7z','.tmp/test spaces agai n').then(function(){(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test spaces agai n/zip')).to.be.eql(true);done();});

should work with spaces in both source and destination.

/*jshint maxlen:false*/_fsExtra2.default.copySync('test/zip.7z','.tmp/test/Folder From/Folder A/Folder B/Folder C/zip file.7z');(0,_extractFull2.default)('.tmp/test/Folder From/Folder A/Folder B/Folder C/zip file.7z','.tmp/test/Folder To/Folder D/Folder E/Folder F').then(function(){(0,_chai.expect)(_fsExtra2.default.existsSync('.tmp/test/Folder To/Folder D/Folder E/Folder F/zip')).to.be.eql(true);done();});

list

should return an error on 7z error.

(0,_list2.default)('test/nothere.7z').catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return an tech spec on fulfill.

(0,_list2.default)('test/zip.7z',{r:true}).then(function(spec){(0,_chai.expect)(spec).to.have.property('path');(0,_chai.expect)(spec).to.have.property('type');(0,_chai.expect)(spec).to.have.property('method');(0,_chai.expect)(spec).to.have.property('physicalSize');(0,_chai.expect)(spec).to.have.property('headersSize');done();});

should return valid entries on progress.

(0,_list2.default)('test/zip.zip').progress(function(entries){(0,_chai.expect)(entries.length).to.be.at.least(1);(0,_chai.expect)(entries[0].date).to.be.an.instanceof(Date);(0,_chai.expect)(entries[0].attr.length).to.eql(5);(0,_chai.expect)(entries[0].name).to.be.a('string');(0,_chai.expect)(entries[0].name).to.not.contain('\\');done();});

test

should return an error on 7z error.

(0,_test2.default)('test/nothere.7z').catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return entries on progress.

(0,_test2.default)('test/zip.7z',{r:true}).progress(function(entries){(0,_chai.expect)(entries.length).to.be.at.least(1);done();});

update

should return an error on 7z error.

(0,_update2.default)('.tmp/test/addnot.7z','.tmp/test/nothere',{'???':true}).catch(function(err){(0,_chai.expect)(err).to.be.an.instanceof(Error);done();});

should return entries on progress.

_fsExtra2.default.copySync('test/zip.7z','.tmp/test/update.7z');(0,_update2.default)('.tmp/test/update.7z','*.md',{w:'test'}).progress(function(entries){(0,_chai.expect)(entries.length).to.be.at.least(1);done();});

should return on fulfillment.

_fsExtra2.default.copySync('test/zip.7z','.tmp/test/update.7z');(0,_update2.default)('.tmp/test/update.7z','*.txt').then(function(){done();});

zip

should exist.

returnshould.exist(zip);

should be an object.

returnzip.should.be.an('object');

should respond to 7-Zip commands as methods.

zip.should.respondTo('add7z');zip.should.respondTo('delete7z');zip.should.respondTo('extract7z');zip.should.respondTo('extractFull7z');zip.should.respondTo('list7z');zip.should.respondTo('test7z');zip.should.respondTo('update7z');

Utility:files

should error on invalid files.

varr=(0,_files2.default)();expect(r).to.eql('');

should works with strings.

varr=(0,_files2.default)('hello test');expect(r).to.eql('"hello test"');

should works with arrays.

varr=(0,_files2.default)(['hello test','hello world']);expect(r).to.eql('"hello test" "hello world"');

Utility:run

should return an error with invalid command type.

(0,_run2.default)(0).catch(function(err){expect(err.message).to.eql('Command must be a string');done();});

should return an error on when 7z gets one.

(0,_run2.default)('7za "???"').catch(function(err){expect(err.message).to.eql('Incorrect command line');done();});

should return an stdout on progress.

(0,_run2.default)('7za',{h:true}).progress(function(data){expect(data).to.be.a('string');}).then(function(){done();});

should correctly parse complex commands.

(0,_run2.default)('7za a ".tmp/test/archive.7z" "*.exe" "*.dll"',{m0:'=BCJ',m1:'=LZMA:d=21'}).then(function(res){expect(res).to.contain('a');expect(res).to.contain('.tmp'+sep+'test'+sep+'archive.7z');expect(res).to.contain('*.exe');expect(res).to.contain('*.dll');expect(res).to.contain('-m0=BCJ');expect(res).to.contain('-m1=LZMA:d=21');expect(res).to.contain('-ssc');expect(res).to.contain('-y');done();});

should correctly parse complex commands with spaces.

(0,_run2.default)('7za a ".tmp/Folder A/Folder B\\archive.7z" "*.exe" "*.dll"',{m0:'=BCJ',m1:'=LZMA:d=21',p:'My mhjls/\\c $^é5°'}).then(function(res){expect(res).to.contain('a');/*jshint maxlen:false*/expect(res).to.contain('.tmp'+sep+'Folder A'+sep+'Folder B'+sep+'archive.7z');expect(res).to.contain('*.exe');expect(res).to.contain('*.dll');expect(res).to.contain('-m0=BCJ');expect(res).to.contain('-m1=LZMA:d=21');expect(res).to.contain('-p"My mhjls/\\c $^é5°"');expect(res).to.contain('-ssc');expect(res).to.contain('-y');done();});

Utility:switches

should return deflaut flags with no args.

expect((0,_switches2.default)({})).to.contain('-ssc');expect((0,_switches2.default)({})).to.contain('-y');

should return -ssc with flag { ssc: true }.

expect((0,_switches2.default)({ssc:true})).to.contain('-ssc');expect((0,_switches2.default)({ssc:true})).to.contain('-y');

should return -ssc- with flag { ssc: false }.

expect((0,_switches2.default)({ssc:false})).to.contain('-ssc-');

should return non default booleans when specified.

varr=(0,_switches2.default)({so:true,spl:true,ssw:true,y:false});expect(r).to.contain('-so');expect(r).to.contain('-spl');expect(r).to.contain('-ssc');expect(r).to.contain('-ssw');expect(r).not.to.contain('-y');

should return complex values when needed.

varr=(0,_switches2.default)({ssc:true,ssw:true,mx0:true});expect(r).to.contain('-ssc');expect(r).to.contain('-ssw');expect(r).to.contain('-mx0');expect(r).to.contain('-y');

should return complex values with spaces and quotes.

varr=(0,_switches2.default)({ssc:true,ssw:true,m0:'=BCJ',m1:'=LZMA:d=21',p:'My Super Pasw,àù£*'});expect(r).to.contain('-ssc');expect(r).to.contain('-ssw');expect(r).to.contain('-m0=BCJ');expect(r).to.contain('-m1=LZMA:d=21');expect(r).to.contain('-p"My Super Pasw,àù£*"');expect(r).to.contain('-y');

About

A Node.js wrapper for 7-Zip, a fork ofhttps://www.npmjs.org/package/node-7z

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript100.0%
[8]ページ先頭
©2009-2025 Movatter.jp