massarg/test/help.test.ts

import { defaultHelpConfig } from '../src/help'
import { massarg } from '../src/index'

const opts = {
  name: 'test',
  description: 'test',
}

test('default value', () => {
  const command = massarg(opts)
  expect(command.helpConfig).toEqual(defaultHelpConfig)
})

test('init', () => {
  const command = massarg(opts).help({
    bindOption: true,
    optionOptions: {
      namePrefix: '__',
    },
  })
  expect(command.help).toBeInstanceOf(Function)
  expect(command.helpConfig).toHaveProperty('bindOption', true)
  expect(command.helpConfig).toHaveProperty('optionOptions.namePrefix', '__')
  expect(command.helpConfig).toHaveProperty('optionOptions.aliasPrefix', '-')
  expect(command.helpConfig).toHaveProperty('optionOptions.nameStyle.color', 'yellow')
})

test('binds command', () => {
  const command = massarg(opts).help({
    bindCommand: true,
  })
  expect(command.help).toBeInstanceOf(Function)
  expect(command.helpConfig).toHaveProperty('bindCommand', true)
  expect(command.commands.find((o) => o.name === 'help')).toBeTruthy()
})

test('prints help from command', () => {
  const command = massarg(opts).help({
    bindCommand: true,
  })
  const log = jest.spyOn(console, 'log').mockImplementation(() => { })
  const error = jest.spyOn(console, 'error').mockImplementation(() => { })
  command.parse(['help'])
  expect(log).toHaveBeenCalled()
  log.mockRestore()
  error.mockRestore()
})

test('binds option', () => {
  const command = massarg(opts).help({
    bindOption: true,
  })
  expect(command.help).toBeInstanceOf(Function)
  expect(command.helpConfig).toHaveProperty('bindOption', true)
  expect(command.options.find((o) => o.name === 'help')).toBeTruthy()
})

test('overrides required options', () => {
  const command = massarg(opts)
    .option({
      name: 'required',
      aliases: ['r'],
      description: 'required',
      required: true,
    })
    .help({
      bindOption: true,
    })
  expect(() => command.getArgs(['--help'])).not.toThrow()
})

describe('prints help from option', () => {
  test('when no main command', () => {
    const command = massarg(opts).help({
      bindOption: true,
    })
    const log = jest.spyOn(console, 'log').mockImplementation(() => { })
    command.parse(['--help'])
    expect(log).toHaveBeenCalled()
  })

  test('when main command', () => {
    const mainCmd = jest.fn()
    const command2 = massarg(opts)
      .help({
        bindOption: true,
      })
      .main(mainCmd)
    command2.parse(['--help'])
    expect(mainCmd).not.toHaveBeenCalled()
  })

  test('when default option exists', () => {
    const command = massarg(opts)
      .option({
        name: 'test',
        aliases: ['t'],
        description: 'test',
        isDefault: true,
      })
      .help({
        bindOption: true,
      })
    const log = jest.spyOn(console, 'log').mockImplementation(() => { })
    command.parse(['--help'])
    expect(log).toHaveBeenCalled()
  })
})

test('help string', () => {
  const command = massarg(opts)
  expect(command.helpString()).toContain(`Usage:`)
})

test('print help', () => {
  const log = jest.spyOn(console, 'log').mockImplementation(() => { })
  const command = massarg(opts)
  command.printHelp()
  expect(log).toHaveBeenCalled()
})