You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,13 @@ Simple Node.js CLI which allows you to create and extract zip/tar files with sup
11
11
Install it locally with
12
12
13
13
```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
15
15
```
16
16
17
17
Or install it globally with
18
18
19
19
```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
21
21
```
22
22
23
23
### Other version
@@ -206,7 +206,7 @@ Allows you to specify paths that you want to exclude. This option follows the sa
206
206
> 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"`
207
207
208
208
> [!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.
210
210
211
211
###### `--allow-git`
212
212
@@ -340,7 +340,7 @@ Allows you to specify paths that you want to exclude. This option follows the sa
340
340
> 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"`
341
341
342
342
> [!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.
344
344
345
345
###### `--allow-git`
346
346
@@ -390,7 +390,7 @@ Prints the files that will be untarred, without extracting them from the tarball
390
390
391
391
Allows you to list recursively the content of files and directories ignoring files specified in .zipignore and .gitignore
392
392
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`, ...).
394
394
395
395
Example usage with `zip`
396
396
```bash
@@ -402,6 +402,11 @@ Example usage with `tar`
402
402
node-zip-cli find | tar --no-recursion -czf <archive> -T -
403
403
```
404
404
405
+
Example usage with `tree`
406
+
```bash
407
+
node-zip-cli find | tree -U --fromfile
408
+
```
409
+
405
410
```
406
411
Usage: node-zip-cli find [options]
407
412
@@ -436,7 +441,7 @@ Filter the type of entries this command will list
436
441
By default, the three types are included, but you can decide to only list a subset.
437
442
438
443
> [!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.
440
445
>
441
446
> This may change in future versions
442
447
@@ -470,7 +475,7 @@ Allows you to specify paths that you want to exclude. This option follows the sa
470
475
> 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"`
471
476
472
477
> [!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.
474
479
475
480
###### `--allow-git`
476
481
@@ -491,15 +496,16 @@ Simply run this CLI providing to each command all the necessary options.
491
496
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
492
497
493
498
> [!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.
495
500
496
501
> [!NOTE]
497
502
> 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. "*.
498
503
>
499
504
> For the same performance reasons and to match git behavior, node-zip-cli doesn’t list excluded directories
500
505
506
+
> [!NOTE]
507
+
> Since version (0.8.0) 32-bit and 64-bit zip archives are supported.
508
+
501
509
> [!WARNING]
502
510
> *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
0 commit comments