0.1.5 • Published 2 years ago
suzip v0.1.5
Features
- Supports zip, tar, gzip formats
- Provides command line tools and support for configuration files
Installation
npm install suzip -D
# or
yarn add suzip -D
# or
pnpm add suzip -D
Useage
Node
import { zip } from 'suzip'
zip({
cwd: '. /',
output: '. /.output/dist.zip',
ignore: ['node_modules/**', '.output/**', 'dist/**'],
dot: true,
})
Set SUZIP_DEBUG=debug
environment variable to start debug mode
Command Line
suzip [command] [option]
Commands:
suzip zip [options] Compression files or directories
suzip Compression files or directories [default]
Options:
-s, --cwd Input Sources (only one can be specified) [string]
-c, --context Working directory path, default to current directory[string]
-o, --output Output File Path
-p, --pattern Regular expression matching input source file [string]
-i, --ignore Regular expression to ignore output [array]
-I, --ignoreFile File path to ignore output [string]
--dot Include files starting with the . symbol [boolean]
--zip Zip option attribute in package.json file
--example Show examples [boolean]
--debug Debug mode, print more information, modified by
`process.env.SUZIP_DEBUG` environment variable [boolean]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
See more examples
Options
For detailed option types, refer to source
- context:
{string}
, Default is current directoryprocess.cwd()
, it affects other option parameters with relative path values - output:
{string}
, output file path, Default isdist.zip
- cwd:
{string}
, the input source, only one can be specified - pattern:
{string}
, regular expression to match the input source file, Default is**/*
- ignore:
{string | string[]}
, regular expression ignore output - ignoreFile:
{string | boolean}
, specify an ignore file, iftrue
, then use the.gitignore
file in the cwd directory - prefix:
{string}
, the output file prefix - dot:
{boolean}
, whether to include files starting with.
- globOption:
{object}
, options for the glob module, see node-readdir-glob、node-glob for more details - globEntryData:
{object}
, input parameter for glob module, see node-archiver for more details - archiverOption:
{object}
, the options for the archiver module, see node-archiver for more details - sources:
{object[]}
, input source group, each object containscwd, pattern, ignore, ignoreFile, prefix, dot, globOption, globEntryData
attributes
About suzip
suzip is based on the original arch-file
refactoring and renaming, using typescript for type management, using unbuild (rollup + esbuild) for packaging build, new command line tools, which can make the compressed file operation out of the webpack or vite compilation process, can be directly in the command line, It is also easy to integrate with the corresponding hooks.