0.1.1 • Published 9 years ago

module-rank v0.1.1

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

Module rank

This is our formula to rank modules based on statistical data from module-data.

Installation

npm i module-rank

Usage

var moduleRank = require('module-rank')

var standardData = { ... }

var options = {
  licensesWhiteList: ['MIT']
}

moduleRank(standardData, [options,] callback)

Formula breakdown

We have three areas of concern and those are:

  • Security
  • Reliability
  • License

Security

The criteria of Security for public modules is:

  • noVuln - This is an array of objects that comes from snyk.

For private modules, there is no criteria to evaluate.

Reliability

The criteria of Reliability for public modules is:

  • hasTests
  • isNotOutdated
  • isNotDeprecated - If this is false, the score of this area of concern is 0.

For private modules is:

  • hasTests

License

The criteria of License for public and private modules is:

  • hasLicense
  • licenseOnWhiteList