Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/istanbuljs/istanbuljs

monorepo containing the various nuts and bolts that facilitate istanbul.js test instrumentation
https://github.com/istanbuljs/istanbuljs

ava code-coverage javascript jest mocha nodejs tap tape

Last synced: 3 days ago
JSON representation

monorepo containing the various nuts and bolts that facilitate istanbul.js test instrumentation

Awesome Lists containing this project

README

        

# IstanbulJS

[![Build Status](https://travis-ci.org/istanbuljs/istanbuljs.svg?branch=main)](https://travis-ci.org/istanbuljs/istanbuljs)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
[![community slack](http://devtoolscommunity.herokuapp.com/badge.svg)](http://devtoolscommunity.herokuapp.com)

_Having problems? want to contribute? join our [community slack](http://devtoolscommunity.herokuapp.com)_.

> Everyone's favorite JS code coverage tool.

## About this Repo

This [monorepo](https://github.com/babel/babel/blob/main/doc/design/monorepo.md) contains the _nuts and bolts_ utility libraries that facilitate IstanbulJS test coverage; Why a monorepo?

- it allows us to more easily test API changes across coupled modules, e.g., changes to `istanbul-lib-coverage`
potentially have an effect on `istanbul-lib-instrument`.
- it gives us a centralized repo for discussions about bugs and upcoming features.

## Where Should I Start

_You're probably actually looking for one of the following repos:_

- [nyc](https://github.com/istanbuljs/nyc): the IstanbulJS 2.0 command line interface, providing painless coverage support for [most popular testing frameworks](https://istanbul.js.org/docs/tutorials/).
- [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul): a babel plugin
for instrumenting your ES2015+ code with Istanbul compatible coverage tracking.
- [istanbul](https://github.com/gotwarlost/istanbul): the legacy 1.0 IstanbulJS interface (you should
now consider instead using nyc or babel-plugin-istanbul).

### Contributing

Contributing to the packages contained in this repo is easy:

1. after checking out, run `npm install` (this will run the lerna build).
2. to run all tests, simply run `npm test` in the root directory.
3. to run tests for a single package `cd package/:name` and run
`npm test` within the package's folder.