1.0.0 • Published 4 years ago

@slimio/gitlab v1.0.0

Weekly downloads
12
License
MIT
Repository
github
Last release
4 years ago

Gitlab

version Maintenance MIT dep size known vulnerabilities Build Status

Download and (optionaly) extract gitlab repository archive.

Requirements

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @slimio/gitlab
# or
$ yarn add @slimio/gitlab

Usage example

const download = require("@slimio/gitlab");

async function main() {
    const tarGZPath = await download("SlimIO.is");
    console.log(tarGZPath);
}
main().catch(console.error);

API

download(repo: String, options?): Promise< String >

Download a given "public" repository ! Return the name of the .tar.gz file (or the name of the extracted directory).

Repository should be formatted like that:

(org|username).repository_fullname

Available options are:

nametypedefaultdescription
branchstringmasterGit branch to download
deststringprocess.cwd()Tar/Directory destination
extractbooleanfalseExtract .tar.gz file
unlinkbooleantrueRemove .tar.gz file on extraction
authstringundefinedBasic Authentication for private repository

Env

To be able to work on the project, please create a root .env file with these:

GIT_TOKEN=token_here

Dependencies

NameRefactoringSecurity RiskUsage
@slimio/isMinorLowType Checker
follow-redirectsMinorLowHTTP Request with URL redirection support
tar-fs⚠️MajorHighExtract tar archive

License

MIT