TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-30 21:40:39 +03:00
Code Issues Projects Releases Wiki Activity
3184ca584d
Ghost/ghost/zip
History
Renovate Bot 3184ca584d Pin dependencies
2021-04-16 12:28:10 +00:00
..
lib ✨ Added dotfile support and set it on by default 2020-05-08 16:21:20 +01:00
test 2021 2021-01-25 16:20:43 +00:00
.eslintrc.js Remove trailing commas from .eslintrc.js files 2020-08-04 14:48:07 +01:00
index.js Consistent interface and response 2020-04-08 12:48:20 +01:00
LICENSE 2021 2021-01-25 16:20:43 +00:00
package.json Pin dependencies 2021-04-16 12:28:10 +00:00
README.md 2021 2021-01-25 16:20:43 +00:00

README.md

Zip

Install

npm install @tryghost/zip --save

or

yarn add @tryghost/zip

Usage

const zip = require('@tryghost/zip');

// Create a zip from a folder

let res = await zip.compress('path/to/a/folder', 'path/to/archive.zip', [options])

// Extract a zip to a folder

let res = await zip.extract('path/to/archive.zip', 'path/to/files', [options])

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

  1. git clone this repo & cd into it as usual
  2. Run yarn to install top-level dependencies.

Run

  • yarn dev

Test

  • yarn lint run just eslint
  • yarn test run lint and tests

Copyright & License

Copyright (c) 2013-2021 Ghost Foundation - Released under the MIT license.