datreeio / node-datreeio

📕 datree.io Node.js Module to integrate with NPM

datree.io

Node.js Module to Integrate with NPM

A Node.js module to help you get useful insights when installing packages/projects with NPM.

❗ We don't currently support Windows OS ❗

Table Of Contents:

• Installation
• Features
• Configure
• Collected Data
• About Us

Installation

$ npm install -g datreeio

If you want to get insights in context with your stack, please sign up at datree.io using your Github account.

Features

Version Insight

For every project you install (npm install/i), you will get insights into your dependencies and versions:

• package.json - package version in your package.json
• Latest Version - package latest version available

Alternative Packages Insight

We continuously map the NPM ecosystem and catalog alternative packages. This way, when installing a package (npm install $packageName$), you will get insights about optional alternatives (if any), their score and whether the package is currently being used in your dev stack.

• My Usage - compared to other alternatives, the percentage of projects in your stack that use this package
• Score - packages' final score, based on quality, maintenance, community popularity and internal usage

Configure

Our package is built off of NPM's onload-script in order to provide you with continuous insight with zero effort (there is no need to actively call the package). The disadvantage of using onload-script, is that we can't support user interactions like external modules, so the custom configuration option is not currently available.

If the project is missing a feature you want or need, let us know - send a feature request:

• Open an issue with the 'feat:' prefix in the subject line
• Provide as much context as you can regarding the issue or what you would like to see in future releases
• Please provide some detail about why existing features and alternative packages won't work for you
• Our project team will prioritize the requested feature or you can contribute code

Collected Data

In order to provide a better DX (developer experience), we are collecting user environment details, specifically:

• Installation datetime
• Node.js & binaries versions
• OS platform, release & name
• Uninstall statistics

About us

datree scans, catalogs and recommends code components in the context of your stack. Our platform analyzes and factors in the code components you already use, as well as your organizational technology stack preferences to assist developers.