presta/__tests__/config.ts

Hyper minimal framework for the modern web.

import tap from 'tap'
import path from 'path'

import { createConfig, removeConfigValues, getConfigFile, _clearCurrentConfig } from '../lib/config'
import { Env } from '../lib/constants'

tap.test('config - defaults', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    cli: {
      files: 'app/*.js',
      output: 'dist',
    },
  })

  t.equal(config.env, Env.PRODUCTION)
  t.ok(!!config.configFilepath)

  t.ok(path.isAbsolute(config.files[0]))

  t.ok(path.isAbsolute(config.files[0]))
  t.ok(path.isAbsolute(config.output))
  t.ok(path.isAbsolute(config.assets))

  t.ok(config.output.includes('dist'))
})

tap.test('config - no files', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    cli: {},
  })

  t.same(config.files, [])
})

tap.test('config - output', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    cli: {
      files: 'app/*.js',
      output: 'dist',
    },
  })

  t.ok(path.isAbsolute(config.output))
  t.ok(config.output.includes('dist'))
})

tap.test('config - assets', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    cli: {
      files: 'app/*.js',
      assets: 'assets',
    },
  })

  t.ok(path.isAbsolute(config.assets))
  t.ok(config.assets.includes('assets'))
})

tap.test('config - staticOutputDir', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    cli: {
      files: 'app/*.js',
      assets: 'assets',
    },
  })

  t.ok(path.isAbsolute(config.staticOutputDir))
})

tap.test('config - getConfigFile no config, no log or exit', async (t) => {
  const { getConfigFile } = require('proxyquire')('../lib/config', {
    './log': {
      error() {
        t.fail()
      },
    },
  })

  const configFile = getConfigFile()

  t.same(configFile, {})
})

tap.test('config - getConfigFile exists', async (t) => {
  t.testdir({
    'presta.config.js': `export const files = 'path/to/*.js'`,
  })

  const configFilepath = path.join(t.testdirName, './presta.config.js')
  const configFile = getConfigFile(configFilepath)

  t.ok(configFile.files)
})

tap.test('config - getConfigFile throws, syntax error', async (t) => {
  let called = false

  const { getConfigFile } = require('proxyquire')('../lib/config', {
    './log': {
      error() {
        called = true
      },
    },
  })

  t.testdir({
    'presta.config.js': `export const files = 'path/to/*.js`, // syntax error
  })

  const configFilepath = path.join(t.testdirName, './presta.config.js')
  const configFile = getConfigFile(configFilepath)

  t.same(configFile, {})
  t.ok(called)
})

tap.test('config - getConfigFile throws and exits', (t) => {
  t.testdir({
    'presta.config.js': `export const files = 'path/to/*.js`, // syntax error
  })

  const exit = process.exit

  // @ts-ignore
  process.exit = (code: int) => {
    t.equal(code, 1)
    t.pass()
    t.end()
  }

  const configFilepath = path.join(t.testdirName, './presta.config.js')
  getConfigFile(configFilepath, true)

  // @ts-ignore
  process.exit = exit
})

tap.test('config - getConfigFile throws and does not exit with no file', async (t) => {
  const configFile = getConfigFile(undefined, true)
  t.same(configFile, {})
})

tap.test('config - picks up default file if present', async (t) => {
  _clearCurrentConfig()

  const file = 'file.js'
  const output = 'output'

  t.testdir({
    'presta.config.js': `const files = '${file}'; const output = '${output}'; module.exports = { files, output }`,
  })

  const configFilepath = path.join(t.testdirName, './presta.config.js')
  const configFile = getConfigFile(configFilepath)
  const config = await createConfig({
    config: configFile,
    cli: {},
  })

  t.ok(config.files[0].includes(file))
  t.ok(config.output.includes(output))
})

tap.test('config - overriden by CLI args', async (t) => {
  _clearCurrentConfig()

  t.testdir({
    'presta.config.js': `const files = 'file.js'; const output = 'output'; module.exports = { files, output }`,
  })

  const configFilepath = path.join(t.testdirName, './presta.config.js')
  const configFile = getConfigFile(configFilepath)
  const config = await createConfig({
    config: configFile,
    cli: {
      files: 'foo.js',
      output: 'out',
    },
  })

  t.ok(config.files[0].includes('foo.js'))
  t.ok(config.output.includes('out'))
})

tap.test('config - file is merged with internal config', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    config: {
      output: 'out',
    },
  })

  t.ok(config.output.includes('out'))
})

tap.test('config - merging updates', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    config: {
      output: 'output',
    },
  })

  t.ok(config.output.includes('output'))

  const merged = await createConfig({
    config: {
      output: 'output',
      assets: 'assets',
    },
  })

  t.ok(merged.assets.includes('assets'))
})

tap.test('config - removeConfigValues', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({
    config: {
      output: 'output',
    },
  })

  t.ok(config.output.includes('output'))

  const unmerged = await removeConfigValues()

  t.ok(unmerged.output.includes('build'))
})

tap.test('config - hooks', async (t) => {
  _clearCurrentConfig()

  const config = await createConfig({})

  config.hooks.onPostBuild(() => {
    t.pass()
    t.end()
  })

  // @ts-expect-error
  config.hooks.emitPostBuild()
})

tap.test('config - plugins', async (t) => {
  _clearCurrentConfig()

  await createConfig({
    config: {
      plugins: [
        () => {
          t.pass()
          t.end()
        },
      ],
    },
  })
})

tap.test('config - plugin error', async (t) => {
  _clearCurrentConfig()

  let called = false

  const { createConfig } = require('proxyquire')('../lib/config', {
    './log': {
      error() {
        called = true
      },
    },
  })

  await createConfig({
    config: {
      plugins: [
        () => {
          throw Error()
        },
      ],
    },
  })

  t.ok(called)
})