wikibase-cli/lib/log_command_examples.js

A command-line interface to Wikibase

import { execSync } from 'node:child_process'
import { dirname } from 'node:path'
import { grey } from 'tiny-chalk'

export default (command, examples, doc, dryRun = false) => {
  if (examples && examples.length > 0) {
    console.log('\nExamples:')
    for (const example of examples) {
      let { args, comment } = example
      if (args instanceof Array) args = args.join(' ')
      if (comment) console.log(grey(`\n  # ${comment}`))
      console.log(`  wb ${command} ${args}`)
      if (dryRun && example.dryRun !== false) {
        const generatedData = execSync(`${getWbAbsolutePath()} ${command} ${args} --dry`).toString()
        console.log(grey('  # output:'))
        if (command.startsWith('sparql')) console.log(formatSparql(generatedData))
        else console.log(formatJsonInMixedOutput(generatedData))
        console.log('')
      }
    }
  }
  if (doc) console.log(`\nDocumentation: ${doc}`)
  console.log('')
}

function getWbAbsolutePath () {
  const binDirectory = dirname(process.argv[1])
  return `${binDirectory}/wb.js`
}

const indent = line => '  ' + line

const formatJsonInMixedOutput = output => {
  return output
  .split('\n')
  .filter(isValidJson)
  .map(formatJson)
  .join('\n')
}

const formatJson = json => {
  return JSON.stringify(JSON.parse(json), null, 2)
  .split('\n')
  .map(indent)
  .join('\n')
}

const formatSparql = sparql => {
  return sparql
  .split('\n')
  .map(indent)
  .join('\n')
}

const isValidJson = line => {
  try {
    JSON.parse(line)
    return true
  } catch (err) {
    if (err.name === 'SyntaxError') return false
    else throw err
  }
}