한국어 README

UnZip for non-UTF8 encoding

Extract zip files that MBCS(multi-byte character set) encoded file names, such as ZIP files created in MS Windows, especially East Asian environment.

Major non-UTF8 encodings by languages:

• Korean: cp949, euc-kr
• Japanese: sjis (shift_jis), cp932, euc-jp
• Chinese: gbk, gb18030, gb2312, cp936, hkscs, big5, cp950

Install

npm install -g unzip-mbcs

Command-line Interface

Usage: unzip-mbcs [options] [command]


Commands:

  l <zipfile>               list files in zipfile
  x <zipfile> [targets...]  extract target files from zipfile.

Options:

  -h, --help            output usage information
  -e, --encoding <enc>  character encoding of filename in .zip

API

listSync(zipFilename, encoding='cp437')

Return the information of the files in zip archive zipFilename with character encoding

extractSync(zipFilename, encoding='cp437', [filters])

Extract files in zip archive zipFilename on current directory. Assume that the file names in zip archive are encoded as encoding. Only the files prefixed the values of filters list are extracted if filters are provided.

Motivation

The .ZIP format, PKZIP compression, have been widely used. Some valuable data are archived as .zip file. But, in non-ASCII, non-Western environment, it makes trouble due to filenames.

Since ZIP format was created too old (1993), there is no standard character encoding about the file name of zip archive entries. Most of zip file entries are encoded as legacy character encoding, local charset.

In modern UNICODE based environment or global data processing environment such as Linux, this makes inconvenience, less portability, mangled file names, fail to extract the file, and so on.

This module may mitigate the inconveniences.