@glpkg/tarball

Tarball utilities for GitLab Package Manager.

Installation

npm install @glpkg/tarball

Usage

import {
  createTarball,
  extractTarball,
  listTarball,
  cleanupTarball,
  sanitizeName,
  collectFiles
} from '@glpkg/tarball';

API

createTarball

Create a tarball from files matching glob patterns.

const result = await createTarball({
  name: '@scope/package',
  version: '1.0.0',
  files: ['dist/**/*', 'package.json'],
  exclude: ['**/*.test.js']
}, process.cwd());
// => { tarballPath, filename, size }

extractTarball

Extract a tarball to a directory.

await extractTarball('./package.tar.gz', './dest');

listTarball

List contents of a tarball.

const files = await listTarball('./package.tar.gz');
// => ['dist/index.js', 'package.json', ...]

Utilities

| Function | Description | |----------|-------------| | sanitizeName(name) | @scope/pkg → scope__pkg | | collectFiles(patterns, exclude, dir) | Collect files by glob | | cleanupTarball(path) | Delete tarball file |

License

MIT