repolinter/lib/licensee.js

Lint open source repositories

// Copyright 2018 TODO Group. All rights reserved.
// Licensed under the Apache License, Version 2.0.

const { commandExists } = require('./command_exists')
const spawnSync = require('child_process').spawnSync

class Licensee {
  /**
   * Returns the license found for the project.
   *
   * Throws 'Licensee not installed' error if command line of 'licensee' is not available.
   *
   * @param {string} targetDir The directory to run licensee on
   * @returns {Promise<string[]>} License identifiers
   * @ignore
   */
  async identifyLicense(targetDir) {
    const command = await commandExists(['licensee', 'licensee.bat'])
    if (command === null) {
      throw new Error('Licensee not installed')
    }
    const licenseeOutput = spawnSync(command, ['detect', '--json', targetDir])
      .stdout
    if (licenseeOutput == null) {
      throw new Error('Error executing licensee')
    }
    const json = licenseeOutput.toString()
    return JSON.parse(json).licenses.map(function (license) {
      return license.spdx_id
    })
  }
}

module.exports = new Licensee()