esbuild-plugin-istanbul's Introduction

esbuild-plugin-istanbul

An esbuild loader that instruments code with istanbul/nyc.

Usage

import { esbuildPluginIstanbul } from "esbuild-plugin-istanbul";

const jsPlugin = esbuildPluginIstanbul({
  filter: /\.[cm]?js$/,
  loader: "js",
  name: "istanbul-loader-js",
});

const jsxPlugin = esbuildPluginIstanbul({
  filter: /\.jsx$/,
  loader: "jsx",
  name: "istanbul-loader-jsx",
});

const tsPlugin = esbuildPluginIstanbul({
  filter: /\.[cm]?ts$/,
  loader: "ts",
  name: "istanbul-loader-ts",
});

const tsxPlugin = esbuildPluginIstanbul({
  filter: /\.tsx$/,
  loader: "tsx",
  name: "istanbul-loader-tsx",
});

await esbuild.build({
  plugins: [jsPlugin, jsxPlugin, tsPlugin, tsxPlugin],
});

esbuild-plugin-istanbul's People

Watchers

esbuild-plugin-istanbul's Issues

Request for assistance to get `esbuild-plugin-istanbul` working

Hi @abraha2d,

Description

I've been trying to use your package in an Angular 17 app which uses vite+esbuild but haven't been successful yet.

You can view the sample app app /demos/code-coverage-with-istanbul-via-esbuild-plugin. It's part of the code-coverage-esbuild branch.

What I've done so far

Created an Angular 17 app
Used the @angular-builders/custom-esbuild to allow me to customize Angular's ESBuild configuration. This allowed me to specify files to be executed as ESBuild plugins
Added a couple of ESBuild plugin files:
- code-coverage-3.ts: this file contains a simple plugin I coded to log to the console the ESBuild plugins that are configured for this app. I was using this just for debug purposes.
- code-coverage-4.ts: this file is using your esbuild-plugin-istanbul package to instrument .ts files with Istanbul.

How to run

Clone the code-coverage-esbuild branch.
Go to /demos/code-coverage-with-istanbul-via-esbuild-plugin
Run npm i to install the npm packages.
Run npm start to run the app.

How I checked that code coverage isn't being collected

After starting the app, go to http://localhost:4200/
Check for code coverage instrumentaton by going to the dev tools and on the console executing: window.__coverage__.
Note how window.__coverage__ is undefined.

Note

If you follow the steps for the How to run and How I checked that code coverage isn't being collected for the app at /demos/code-coverage-with-istanbul-via-webpack-babel-plugin then window.__coverage__ won't be undefined.

The app at /demos/code-coverage-with-istanbul-via-webpack-babel-plugin is also an Angular 17 app but is using webpack instead of esbuild and for the instrumentation it uses the babel-plugin-istanbul npm package.