README.md

Compatible 🛠📦

Tiny (has no dependencies) package to check how compatible a version of dependency is with another version. This package gets the data from Dependabot which supports many languages (JavaScript, Python, Java, ...) and package managers (npm, pip, mvn, ...).

Installation

Install latest release from npm:

$ npm install compatible

Install latest updates from source:

$ npm install ssmirr/compatible

Using Compatible

You can fetch compatibility status of a package and all the versions:

await compatible.dependency('<package name>', '<package manager>', '<calculate success rate = false>'));

, specific version of a package:

await compatible.update('<package name>', '<package manager>', '<from version>', '<to version>'));

, or updating from version a to version b of a package:

await compatible.version('<package name>', '<package manager>', '<to version>'));

Example

const compatible = require('compatible');

(async () => {
    console.log(await compatible.update('django', 'pip', '2.1.4', '2.1.5'))
    console.log(await compatible.version('got', 'npm_and_yarn', '9.5.0'))
    console.log(await compatible.dependency('got', 'npm_and_yarn', true))
})();

// results is a json object:
// [ { candidate_updates: 1,
//     successful_updates: 0,
//     previous_version: '1.10.3',
//     updated_version: '1.11.7',
//     non_breaking_if_semver: true
//     success_rate: 0.94 } ]

Note: candidate_updates is the number of pull requests Dependabot made, and successful_updates is how many were merged.