Skip to content

Commit b257e80

Browse files
chore: bump version to 0.8.0 (#137)
* chore: bump version to 0.8.0 * chore: update version, add tree example and notify ZIP64 support
1 parent 2a250e3 commit b257e80

File tree

3 files changed

+20
-14
lines changed

3 files changed

+20
-14
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Simple Node.js CLI which allows you to create and extract zip/tar files with sup
1111
Install it locally with
1212

1313
```bash
14-
npm i https://github.com/matteosacchetto/node-zip-cli/releases/download/v0.7.3/node-zip-cli-0.7.3.tgz
14+
npm i https://github.com/matteosacchetto/node-zip-cli/releases/download/v0.8.0/node-zip-cli-0.8.0.tgz
1515
```
1616

1717
Or install it globally with
1818

1919
```bash
20-
npm i --location=global https://github.com/matteosacchetto/node-zip-cli/releases/download/v0.7.3/node-zip-cli-0.7.3.tgz
20+
npm i --location=global https://github.com/matteosacchetto/node-zip-cli/releases/download/v0.8.0/node-zip-cli-0.8.0.tgz
2121
```
2222

2323
### Other version
@@ -206,7 +206,7 @@ Allows you to specify paths that you want to exclude. This option follows the sa
206206
> For example, providing `*.mjs` will result in the shell replacing it will all the file matching the wildcard, so as the input to the CLI, instead of `"*.mjs"` will be provided the whole list (e.g. "rollup.config.mjs", "test.runner.mjs", ...). Instead, providing `"*.mjs"` will behave as expected, providing as input to the CLI the pattern `"*.mjs"`
207207
208208
> [!NOTE]
209-
> Up to the current version (0.7.3) the list of paths to ignore which are specified with this options are applied after default ignore paths (like `.git`) BUT before any .gitignore or .zipignore file. This means that paths you specify here could be overridden by the aforementioned files.
209+
> Up to the current version (0.8.0) the list of paths to ignore which are specified with this options are applied after default ignore paths (like `.git`) BUT before any .gitignore or .zipignore file. This means that paths you specify here could be overridden by the aforementioned files.
210210
211211
###### `--allow-git`
212212

@@ -340,7 +340,7 @@ Allows you to specify paths that you want to exclude. This option follows the sa
340340
> For example, providing `*.mjs` will result in the shell replacing it will all the file matching the wildcard, so as the input to the CLI, instead of `"*.mjs"` will be provided the whole list (e.g. "rollup.config.mjs", "test.runner.mjs", ...). Instead, providing `"*.mjs"` will behave as expected, providing as input to the CLI the pattern `"*.mjs"`
341341
342342
> [!NOTE]
343-
> Up to the current version (0.7.3) the list of paths to ignore which are specified with this options are applied after default ignore paths (like `.git`) BUT before any .gitignore or .zipignore file. This means that paths you specify here could be overridden by the aforementioned files.
343+
> Up to the current version (0.8.0) the list of paths to ignore which are specified with this options are applied after default ignore paths (like `.git`) BUT before any .gitignore or .zipignore file. This means that paths you specify here could be overridden by the aforementioned files.
344344
345345
###### `--allow-git`
346346

@@ -390,7 +390,7 @@ Prints the files that will be untarred, without extracting them from the tarball
390390

391391
Allows you to list recursively the content of files and directories ignoring files specified in .zipignore and .gitignore
392392

393-
The idea of this command is to be a simple alternative to find when you want to list the directories and pipe the output to native zip/tar commands.
393+
The idea of this command is to be a simple alternative to find when you want to list the directories and pipe the output to native commands (e.g., `zip`, `tar`, `tree`, ...).
394394

395395
Example usage with `zip`
396396
```bash
@@ -402,6 +402,11 @@ Example usage with `tar`
402402
node-zip-cli find | tar --no-recursion -czf <archive> -T -
403403
```
404404

405+
Example usage with `tree`
406+
```bash
407+
node-zip-cli find | tree -U --fromfile
408+
```
409+
405410
```
406411
Usage: node-zip-cli find [options]
407412
@@ -436,7 +441,7 @@ Filter the type of entries this command will list
436441
By default, the three types are included, but you can decide to only list a subset.
437442

438443
> [!NOTE]
439-
> Up to the current version (0.7.3) symlinks are not listed by default. To list them you need to specify the `-s keep` option.
444+
> Up to the current version (0.8.0) symlinks are not listed by default. To list them you need to specify the `-s keep` option.
440445
>
441446
> This may change in future versions
442447
@@ -470,7 +475,7 @@ Allows you to specify paths that you want to exclude. This option follows the sa
470475
> For example, providing `*.mjs` will result in the shell replacing it will all the file matching the wildcard, so as the input to the CLI, instead of `"*.mjs"` will be provided the whole list (e.g. "rollup.config.mjs", "test.runner.mjs", ...). Instead, providing `"*.mjs"` will behave as expected, providing as input to the CLI the pattern `"*.mjs"`
471476
472477
> [!NOTE]
473-
> Up to the current version (0.7.3) the list of paths to ignore which are specified with this options are applied after default ignore paths (like `.git`) BUT before any .gitignore or .zipignore file. This means that paths you specify here could be overridden by the aforementioned files.
478+
> Up to the current version (0.8.0) the list of paths to ignore which are specified with this options are applied after default ignore paths (like `.git`) BUT before any .gitignore or .zipignore file. This means that paths you specify here could be overridden by the aforementioned files.
474479
475480
###### `--allow-git`
476481

@@ -491,15 +496,16 @@ Simply run this CLI providing to each command all the necessary options.
491496
This file is meant to be placed in a folder which you plan to zip/tar. It is meant to be used instead of the .gitignore, if the content of the folder is not related to git, or as an extension of the .gitignore, where you can specify additional rules related only to the zip file creation. The .zipignore file follow the same syntax and rules of the traditional .gitignore
492497

493498
> [!NOTE]
494-
> Up to the current version (0.7.3) the .zipignore builds on top of already existing .gitignore rules, so if you only want to ignore some additional files you **do not need** to copy paste the content of the .gitignore.
499+
> Up to the current version (0.8.0) the .zipignore builds on top of already existing .gitignore rules, so if you only want to ignore some additional files you **do not need** to copy paste the content of the .gitignore.
495500
496501
> [!NOTE]
497502
> Since version (0.7.0) the strategy of ignoring everythin (`*`) and then un-ignoring (!) some paths (e.g. `!test`, `!src`, ...) is supported and behaves like in the gitignore specs. Quoting from [gitignore specs](https://git-scm.com/docs/gitignore): *"It is not possible to re-include a file if a parent directory of that file is excluded. Git doesn’t list excluded directories for performance reasons, so any patterns on contained files have no effect, no matter where they are defined. "*.
498503
>
499504
> For the same performance reasons and to match git behavior, node-zip-cli doesn’t list excluded directories
500505
506+
> [!NOTE]
507+
> Since version (0.8.0) 32-bit and 64-bit zip archives are supported.
508+
501509
> [!WARNING]
502510
> *Current limitations*
503-
> Up to the current version (0.7.3) zip/tar and unzip/untar should handle files, directories and symlinks. Though, symlink support is still experimental, so it may not behave as expected. Currently on Windows symlinks are not supported
504-
>
505-
> Up to the current version (0.7.3) only 32-bit zip are supported, 64-bit zip support is not yet implemented.
511+
> Up to the current version (0.8.0) zip/tar and unzip/untar should handle files, directories and symlinks. Though, symlink support is still experimental, so it may not behave as expected. Currently on Windows symlinks are not supported

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "node-zip-cli",
3-
"version": "0.7.3",
3+
"version": "0.8.0",
44
"description": "Simple nodejs cli which allows you to create and extract zip/tar files with support for .gitignore files",
55
"main": "dist/index.mjs",
66
"bin": "dist/index.mjs",

0 commit comments

Comments
 (0)