kevva / kevva/decompress

Suggestion: Add clarification regarding output directory, use "./" for same folder

Open
#104 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
419
Forks
55
PR merge metrics
No merged PRs in 30d

Description

My problem was that unpacking zipfile 6010.zip using 6010 as output did not work. I got 6010/6010/ and in the latter was the files. Because the archive was a zipped folder named 6010.

Empty string as output, or emitting output completely does not accomplish what I want. Neither finding out the parent directory and using that for output.

Suggestion for this simple clarification in the ReadMe under Output directory.

Add

> Use "./" as output to unpack in the same directory.

> Example:
>
> decompress('unicorn.zip', './').then(files => {
> console.log('done!');
> });
>

Thanks for a great package.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the README and find the Output directory section mentioned in the issue. Add the clarification and example showing "./" for unpacking in the same directory; the work is done when the README clearly explains this behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.