Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
swc-plugin-coverage-instrument
Advanced tools
SWC coverage instrumentation plugin
Weekly downloads
Readme
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.
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.
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.
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
},
}
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);
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.FAQs
SWC coverage instrumentation plugin
The npm package swc-plugin-coverage-instrument receives a total of 13,674 weekly downloads. As such, swc-plugin-coverage-instrument popularity was classified as popular.
We found that swc-plugin-coverage-instrument demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.