@linterhub/registry

Registry provides an interface for obtaining information about packages from various package managers

Table of Contents

• Background
• Installation
• Usage
• Contribute
• License

Background

There are a lot of package manager with different API, which each have different methods and output. This repository contains a proposal to unified API for work with of various API.

More details in doс or at the catalog page

Installation

NPM

Requirements:

• Node.js 7.4+
• npm 4+

npm install @linterhub/registry

GitHub

All releases and the source code are available for download at GitHub Releases.

Usage

JavaScript

Get meta-information of packageName from npm and output it to console:

const registry = require('@linterhub/registry');
const manager = registry.getManager('npm');
manager.getMeta('packageName').then((data) => {
    console.log(data);
});

Supported package managers:

• npm
• gem
• pip
• composer

API

getMeta(name, [version])

Get meta-information of package

Options:

• name: string - package name by search
• version: string - package version [latest by default]

Return:

• Promise - package meta-information, which include: name, url, license and e.t.c

getDeps(name, [version])

Get dependencies for a package

Options:

• name: string - package name by search
• version: string - package version [latest by default]

Return:

• Promise - objects array, where the object is one dependency.

getVersions(name)

Get all versions by package name

Options:

• name: string - package name by search

Returns:

• Promise- versions array

Contribute

You may contribute in several ways like requesting new features, adding tests, fixing bugs, improving documentation or examples. Please check our contributing guidelines.

License

MIT