This repository contains the source code used to create the "NPM-MINER" dataset submitted at the Data Showcase Track of the "Mining Software Repositories (MSR)" conference.
The dataset contains the analysis results of 5 open source software quality tools eslint, escomplex, nsp, jsinspect and sonarjs for 2000 popular (in terms of stars and downloads) npm packages.
The preprint.
In order to use msr-2018-dataset follow the next steps:
- Clone the repository
AuthEceSoftEng/msr-2018-npm-minerusing the following command:
$ git clone https://github.com/AuthEceSoftEng/msr-2018-npm-miner.git- Move to the
AuthEceSoftEng/msr-2018-npm-minerroot directory and install the dependencies using the command:
$ npm install- Install
jssalocally following the instructions found at jssa documentation:
In order to reproduce the NPM-MINER dataset follow the steps:
- Set the results storing directory by modifying the
properties.jsfile:
getStoringFolder: function (){
return "path_to_storing_folder"; // Place the path to your storing folder
}- Run the analysis, which supports two modes:
sequentialandparallel
- sequential mode
/**
* @param {String} DB_URL - The URL through which the couchDB is accessible.
* @param {String} DB_name - The name of the database.
* @param {String} platform - "WINDOWS"/"LINUX".
* @param {Number} from_index - The starting index of the projects to analyze.
* @param {Number} to_index - The ending index of the projects to analyze.
*/
let analysis_results = [];
sequential_execution(DB_URL, DB_name, platform, from_index, to_index).then( val =>{
console.log(analysis_results)
});Example
// Analyze the projects from index 101-110
let analysis_results = [];
sequential_execution(DB_URL, DB_name, "WINDOWS", 101, 110).then( val =>{
console.log(analysis_results)
});- parallel mode
/**
* @param {String} DB_URL - The URL through which the couchDB is accessible.
* @param {String} DB_name - The name of the database.
* @param {String} platform - "WINDOWS"/"LINUX".
* @param {Number} num_projects - The number of projects to analyze.
* @param {Number} skip - The number of projects to skip.
*/
run_full_analysis(DB_URL, DB_name, platform, num_projects, skip)Example
// Analyze the projects from index 101-110
run_full_analysis(DB_URL, DB_name, "WINDOWS", 10, 100)