pnpm/src/reportError.ts

import chalk = require('chalk')
import {Log} from 'pnpm-logger'
import commonTags = require('common-tags')
import os = require('os')
import observatory = require('observatory')

const stripIndent = commonTags.stripIndent
const EOL = os.EOL
const highlight = chalk.yellow
const colorPath = chalk.gray

export default function reportError (logObj: Log) {
  if (logObj['err']) {
    const err = <Error & { code: string }>logObj['err']
    switch (err.code) {
      case 'UNEXPECTED_STORE':
        reportUnexpectedStore(err, logObj['message'])
        return
      case 'STORE_BREAKING_CHANGE':
        reportStoreBreakingChange(err, logObj['message'])
        return
      case 'MODULES_BREAKING_CHANGE':
        reportModulesBreakingChange(err, logObj['message'])
        return
      case 'MODIFIED_DEPENDENCY':
        reportModifiedDependency(err, logObj['message'])
        return
      case 'SHRINKWRAP_BREAKING_CHANGE':
        reportShrinkwrapBreakingChange(err, logObj['message'])
        return
      default:
        observatory.add(formatErrorSummary(err.message || logObj['message']))
        return
    }
  }
  observatory.add(formatErrorSummary(logObj['message']))
}

function reportUnexpectedStore (err: Error, msg: Object) {
  observatory.add(stripIndent`
    ${formatErrorSummary(err.message)}

    expected: ${highlight(msg['expectedStorePath'])}
    actual: ${highlight(msg['actualStorePath'])}

    If you want to use the new store, run the same command with the ${highlight('--force')} parameter.
  `)
}

function reportStoreBreakingChange (err: Error, msg: Object) {
  let output = stripIndent`
    ${formatErrorSummary(`The store used for the current node_modules is incomatible with the current version of pnpm`)}
    Store path: ${colorPath(msg['storePath'])}

    Try running the same command with the ${highlight('--force')} parameter.
  `

  if (msg['additionalInformation']) {
    output += EOL + EOL + msg['additionalInformation']
  }

  output += formatRelatedSources(msg)
  observatory.add(output)
}

function reportModulesBreakingChange (err: Error, msg: Object) {
  let output = stripIndent`
    ${formatErrorSummary(`The current version of pnpm is not compatible with the available node_modules structure`)}
    node_modules path: ${colorPath(msg['modulesPath'])}

    Try running the same command with the ${highlight('--force')} parameter.
  `

  if (msg['additionalInformation']) {
    output += EOL + EOL + msg['additionalInformation']
  }

  output += formatRelatedSources(msg)
  observatory.add(output)
}

function formatRelatedSources (msg: Object) {
  let output = ''

  if (!msg['relatedIssue'] && !msg['relatedPR']) return output

  output += EOL

  if (msg['relatedIssue']) {
    output += EOL + `Related issue: ${colorPath(`https://github.com/pnpm/pnpm/issues/${msg['relatedIssue']}`)}`
  }

  if (msg['relatedPR']) {
    output += EOL + `Related PR: ${colorPath(`https://github.com/pnpm/pnpm/pull/${msg['relatedPR']}`)}`
  }

  return output
}

function formatErrorSummary (message: string) {
  return `${chalk.red('ERROR')} ${message}`
}

function reportModifiedDependency (err: Error, msg: Object) {
  observatory.add(stripIndent`
    ${formatErrorSummary('Packages in the store have been mutated')}

    These packages are modified:
    ${msg['modified'].map((pkgPath: string) => colorPath(pkgPath)).join(EOL)}

    You can run ${highlight('pnpm install')} to refetch the modified packages
  `)
}

function reportShrinkwrapBreakingChange (err: Error, msg: Object) {
  observatory.add(stripIndent`
    ${formatErrorSummary(err.message)}

    Run with the ${highlight('--force')} parameter to recreate the shrinkwrap file.
  `)
}