combine.cy.js

/// <reference types="Cypress" />
const { combineNycOptions, defaultNycOptions } = require('../../common-utils')
describe('Combine NYC options', () => {
  it('overrides defaults', () => {
    const pkgNycOptions = {
      extends: '@istanbuljs/nyc-config-typescript',
      all: true
    }
    const combined = combineNycOptions(defaultNycOptions, pkgNycOptions)
    cy.wrap(combined).should('deep.equal', {
      extends: '@istanbuljs/nyc-config-typescript',
      all: true,
      'report-dir': './coverage',
      reporter: ['lcov', 'clover', 'json', 'json-summary'],
      extension: ['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx'],
      excludeAfterRemap: false
    })
  })

  it('allows to specify reporter, but changes to array', () => {
    const pkgNycOptions = {
      reporter: 'text'
    }
    const combined = combineNycOptions(defaultNycOptions, pkgNycOptions)
    cy.wrap(combined).should('deep.equal', {
      'report-dir': './coverage',
      reporter: ['text'],
      extension: ['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx'],
      excludeAfterRemap: false
    })
  })

  it('combines multiple options', () => {
    const pkgNycOptions = {
      all: true,
      extension: '.js'
    }
    const nycrc = {
      include: ['foo.js']
    }
    const nycrcJson = {
      exclude: ['bar.js'],
      reporter: ['json']
    }
    const nycConfig = {
      'report-dir': './report'
    }
    const combined = combineNycOptions(
      defaultNycOptions,
      nycrc,
      nycrcJson,
      nycConfig,
      pkgNycOptions
    )
    cy.wrap(combined).should('deep.equal', {
      all: true,
      'report-dir': './report',
      reporter: ['json'],
      extension: ['.js'],
      excludeAfterRemap: false,
      include: ['foo.js'],
      exclude: ['bar.js']
    })
  })

  it('converts exclude to array', () => {
    // https://github.com/cypress-io/code-coverage/issues/248
    const pkgNycOptions = {
      all: true,
      extension: '.js'
    }
    const nycrc = {
      include: ['foo.js']
    }
    const nycrcJson = {
      exclude: 'bar.js',
      reporter: ['json']
    }
    const combined = combineNycOptions(
      defaultNycOptions,
      nycrc,
      nycrcJson,
      pkgNycOptions
    )
    cy.wrap(combined).should('deep.equal', {
      all: true,
      'report-dir': './coverage',
      reporter: ['json'],
      extension: ['.js'],
      excludeAfterRemap: false,
      include: ['foo.js'],
      exclude: ['bar.js']
    })
  })
})