Giter VIP home page Giter VIP logo

karma-remap-coverage's Introduction

karma-remap-coverage

Karma reporter that shows coverage for original non transpiled code (TypeScript, ES6/7, etc).

Build on top of karma-coverage and remap-istanbul - consumes coverage report for raw code and maps it to original files. Transpiler should generate inline source maps in order to make everything work.

Needs no temporary files nor npm post run scripts, works in "watch" mode generating report on every change.

Example

##Installation

npm install karma-remap-coverage --save-dev

##Configuration

  1. Enable inline source maps in your transpiler/compiler config
  2. Configure karma config to use karma-coverage together with karma-remap-coverage:
    • add remap-coverage to reporters list: reporters: ['progress', 'coverage', 'remap-coverage']
    • save interim coverage report in memory: coverageReporter: { type: 'in-memory' }
    • define where to save final reports: remapCoverageReporter: { html: './coverage' }
  3. Optionally - configure remap options in karma config: remapOptions: { basePath: './dist' }

##remapCoverageReporter format Key-value pairs where key is report type and value - path to file/dir where to save it. Reporters like text-summary, text-lcov and teamcity can print out to console as well - in this case just provide any falsy value instead of path. Example:

remapCoverageReporter: {
  'text-summary': null,
  html: './coverage/html',
  cobertura: './coverage/cobertura.xml'
}

##TypeScript + webpack example Karma config with alternative usage of karma-webpack should look something like this:

karma.conf.js

module.exports = config => config.set({

  webpack: {
    //...
    ts: {
      // override compiler options for "ts-loader"
      compilerOptions: {
        sourceMap: false,
        inlineSourceMap: true
      }
    }
  },

  //...

  preprocessors: {
    './entry-module.ts': ['coverage']
  },

  // add both "karma-coverage" and "karma-remap-coverage" reporters
  reporters: ['progress', 'coverage', 'remap-coverage'],
  
  // save interim raw coverage report in memory
  coverageReporter: {
    type: 'in-memory'
  },
  
  // define where to save final remaped coverage reports
  remapCoverageReporter: {
    'text-summary': null, // to show summary in console
    html: './coverage/html',
    cobertura: './coverage/cobertura.xml'
  },
  
  // make sure both reporter plugins are loaded
  plugins: ['karma-coverage', 'karma-remap-coverage']

});

karma-remap-coverage's People

Contributors

sshev avatar isuda avatar

Watchers

 avatar Darryl Pogue avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.