npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

swc-plugin-coverage-instrument

v0.0.25

Published

SWC coverage instrumentation plugin

Downloads

153,243

Readme

SWC-coverage-instrument

swc-coverage-instrument is a set of packages to support istanbuljs compatible coverage instrumentation in SWC's transform passes. Instrumentation transform can be performed either via SWC's wasm-based plugin, or using custom passes in rust side transform chains.

What does compatible exactly means?

This instrumentation will generate a data struct mimics istanbuljs's FileCoverage object conforms fixture test suite from istanbuljs itself.

However, this doesn't mean instrumentation supports exact same interfaces surrounding coverage object as well as supporting exact same options. There are some fundamental differences between runtime, and ast visitor architecture between different compilers does not allow identical behavior. This package will try best attempt as possible.

NOTE: Package can have breaking changes without major semver bump

Given SWC's plugin interface itself is under experimental stage does not gaurantee semver-based major bump yet, this package also does not gaurantee semver compliant breaking changes yet. Please refer changelogs if you're encountering unexpected breaking behavior across versions.

Usage

Using SWC's wasm-based experimental plugin

First, install package via npm:

npm install --save-dev swc-plugin-coverage-instrument

Then add plugin into swc's configuration:

const pluginOptions: InstrumentationOptions = {...}

jsc: {
  ...
  experimental: {
    plugins: [
      ["swc-plugin-coverage-instrument", pluginOptions]
    ]
  }
}

InstrumentationOptions is a subset of istanbul's instrumentation options. Refer istanbul's option for the same configuration flags. However there are few exceptions or differences, referencing InstrumentOptions will list all possible options.

interface InstrumentationOptions {
  coverageVariable?: String,
  compact?: bool,
  reportLogic?: bool,
  ignoreClassMethods?: Array<String>,
  inputSourceMap?: object,
  instrumentLog: {
    // Currently there aren't logs other than spans.
    // Enabling >= info can display span traces.
    level: 'trace' | 'warn' | 'error' | 'info'
    // Emits spans along with any logs
    // Only effective if level sets higher than info.
    enableTrace: bool
  },
  unstableExclude?: Array<String>
}

Using custom transform pass in rust

There is a single interface exposed to create a visitor for the transform, which you can pass into before_custom_pass.

let visitor = swc_coverage_instrument::create_coverage_instrumentation_visitor(
    source_map: std::sync::Arc<SourceMapper>,
    comments: C,
    instrument_options: InstrumentOptions,
    filename: String,
);

let fold = as_folder(visitor);

Building / Testing

This package runs istanbuljs' fixture tests against SWC with its wasm plugin & custom transform both. spec contains set of the fixtures & unit test to run it, as well as supplimental packages to interop between instrumentation visitor to node.js runtime. swc-coverage-instrument-wasm exposes FileCoverageInterop allows to consume FileCoverage struct inside of js, and swc-coverage-custom-transform is an example implementation to run before_custom_pass with swc-coverage-instrument visitor.

Few npm scripts are supported for wrapping those setups.

  • build:all: Build all relative packages as debug build.
  • test: Runs unit test for wasm plugin & custom transform.
  • test:debug: Runs unit test, but only for debug-test.yaml fixture. This is mainly for local dev debugging for individual test fixture behavior.