app.js

#!/usr/bin/env node

/*
## todo:

* allow the user to customise the starting directory
* add a switch for a package id filter
* include PackageReference format:
    https://github.com/NuGet/Home/wiki/PackageReference-Specification
    https://docs.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files

*/

const semver = require('semver');
var packageReference = require('./packagereference.js');
var packagesConfig = require('./packages.config.js');
var projectLockJson = require('./project.lock.json.js');
var nuspec = require('./package.nupkg.js');
var packages = require('./packages.js');
var archy = require('archy');
var colours = require('colors');

var dir = process.cwd();

function hasFlag(name) {
    return !!process.argv.filter(x => x === '--' + name).length;
}

function hasValue(name){
    var index = process.argv.indexOf('--' + name);
    if (index === -1) return null;
    return process.argv[index + 1];
}
function processXmlPackages(packageList, settings, dir, fileName) {
    if (!(packageList && packageList.length)) return;
    if (settings.packageFolder) {
        packageFolder = settings.packageFolder
    } else {
        packageFolder = packages.findPackageFolder(dir);
    }

    if (!packageFolder) {
        console.log("Cannot find 'packages' directory. Have you run 'nuget restore' or 'dotnet restore'?");
        return;
    }

    if (!settings.showSystem) {
        packageList = packageList.filter(x => x.id.indexOf('System.') !== 0)
    }

    const packageDictionary = {};
    packageList.forEach(x => {
        packageDictionary[`${x.id}|${x.version}`] = x;
        x.label = x.id + " " + (settings.hideVersion ? "" : (x.version || ''));
    });

    packageList.forEach(x => {
        x.nodes = x.nodes || [];
        (nuspec.readNuspec(packageFolder, x, settings) || []).forEach(dep => {
            if (settings.observingTargets) {
                getObservingTargets(packageFolder, x, dep, settings);
            }
            var resolvedDep = packageDictionary[`${dep.id}|${dep.version}`];
            if (resolvedDep) {
                if (x.nodes.filter(y => y.id === dep.id && y.version === dep.version).length) return; // already added
                x.nodes.push(resolvedDep);
                resolvedDep.used = true;
            }/* else {
                if (settings.observingTargets) {
                    getObservingTargets(packageFolder, x, dep, settings);
                }
            }*/
        });
    });
    displayPackages(packageList, fileName);
}

function getObservingTargets(packageFolder, x, dep, settings) {
    dep.nodes = dep.nodes || [];
    (nuspec.readNuspec(packageFolder, dep, settings) || []).forEach(dep2 => {
        if (dep.nodes.filter(y => y.id === dep2.id && y.version === dep2.version).length) return;
        dep2.label = dep2.id + " " + (settings.hideVersion ? "" : (dep2.version || ''));
        dep2.used = false;
        dep.nodes.push(dep2);
        getObservingTargets(packageFolder, dep, dep2, settings);
    });
    if (x.nodes.filter(y => y.id === dep.id && y.version === dep.version).length) return;
    dep.label = dep.id + " " + (settings.hideVersion ? "" : (dep.version || ''));
    dep.used = false;
    x.nodes.push(dep);
}

if (hasFlag('?') || hasFlag('h') || hasFlag('help')){
  var fs = require('fs');
  var path = require('path');
  var version = JSON.parse(fs.readFileSync(path.join(__dirname, './package.json')).toString()).version;
  console.log(`nuget-tree version ${version}
Execute this command (nuget-tree) in the directory containing a .NET project.
packages.config, *.csproj or project.lock.json will be parsed to draw a nuget dependency tree.

Optional command line switches:
  --hideVersion         : hides the package versions
  --showSystem          : shows the System.* packages
  --onlyTopLevel        : lists only the packages at the top level of the tree (i.e. those that are not depended upon by any other package)
  --observingTargets    : lists the dependencies of dependencies (full tree)
  --flat                : lists the dependencies without the hierarchy
  --why Newtonsoft.Json : shows only dependency trees that reference the given package (Newtonsoft.Json in this case)
    `);
  return;
}

var settings = {
    hideVersion: hasFlag('hideVersion'),
    showSystem: hasFlag('showSystem'),
    onlyTopLevel: hasFlag('onlyTopLevel'),
    observingTargets: hasFlag('observingTargets'),
    flat: hasFlag('flat'),
    why:hasValue('why'),
    packageFolder:hasValue('packageFolder')
}

if (settings.why){
  console.log("Showing dependency trees containing " + settings.why);
}

var packagesFromProjectLockJson = projectLockJson.list(dir, settings);
if (packagesFromProjectLockJson && packagesFromProjectLockJson.length) displayPackages(packagesFromProjectLockJson, 'project.lock.json');

processXmlPackages(packagesConfig.list(dir), settings, dir, 'packages.config')


function findWhy(node){
  node.match = false;

  if (node.id.toLowerCase() === settings.why.toLowerCase()) {
    node.match = true;
  }

  (node.nodes || []).forEach(child => {
    node.match = findWhy(child) || node.match
  });
  return node.match;
}

function filterOnlyMatches(node){
    node.nodes = (node.nodes || []).filter(x => x.match);
    node.nodes.forEach(filterOnlyMatches)
}

function getWorkingVersion(version) {
    var curr = semver.valid(version);
    if(curr == null) {
        var alternateArray = version.split('.');
        alternateArray.pop();
        if(alternateArray.length == 0)
            return null;
        return getWorkingVersion(alternateArray.join('.'));
    }
    return curr;
}

function getMaxPackage(packages, pkgs) {
    pkgs = pkgs || {};
    packages.forEach(x => {
        var curr = getWorkingVersion(x.version);
        if(curr == null) {
            return;
        }
        if(x.id in pkgs) {
            if(pkgs[x.id] == null)
                pkgs[x.id] = curr;
            else
                if(semver.gt(curr, pkgs[x.id]))
                    pkgs[x.id] = curr;
        }
        else {
            pkgs[x.id] = curr;
        }
        getMaxPackage(x.nodes, pkgs);
    });
    return pkgs;
}

function displayPackages(packages, source) {

    if (settings.why){
      var head = {
          id :"",
          label: source,
          match: true,
          nodes: packages.filter(x => !x.used)
      };
      findWhy(head);
      filterOnlyMatches(head);
      console.log(archy(head));
    } else if (settings.onlyTopLevel) {
        packages.filter(x => !x.used).forEach(x => {
            console.log(x.label);
        });
    } else if (settings.flat) {
        var pkgs = getMaxPackage(packages, {});
        var keys = Object.keys(pkgs);
        keys.sort();
        keys.forEach(x => {
            console.log(x + " " + (settings.hideVersion ? "" : (pkgs[x] || '')));
        });
    } else {
        var head = {
            label: source,
            nodes: packages.filter(x => !x.used)
        };
        console.log(archy(head));
    }
}