From cd0bb16c2b6d0e3d4aa19f55e23fc2f09b3706f9 Mon Sep 17 00:00:00 2001 From: OJ Kwon <1210596+kwonoj@users.noreply.github.com> Date: Thu, 4 Jul 2024 15:37:18 +0900 Subject: [PATCH] docs(readme): update docs --- README.md | 3 ++- packages/swc-coverage-instrument/README.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0006993..7360f9c 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ jsc: { } ``` -`InstrumentationOptions` is a subset of istanbul's instrumentation options. Refer [istanbul's option](https://github.com/istanbuljs/istanbuljs/blob/master/packages/istanbul-lib-instrument/src/instrumenter.js#L16-L27=) for the same configuration flags. +`InstrumentationOptions` is a subset of istanbul's instrumentation options. Refer [istanbul's option](https://github.com/istanbuljs/istanbuljs/blob/master/packages/istanbul-lib-instrument/src/instrumenter.js#L16-L27=) for the same configuration flags. However there are few exceptions or differences, referencing [InstrumentOptions](https://github.com/kwonoj/swc-plugin-coverage-instrument/blob/4689fc9d281e11c875edd2376e8d92819472b9fe/packages/swc-coverage-instrument/src/options/instrument_options.rs#L22-L33) will list all possible options. ``` interface InstrumentationOptions { @@ -54,6 +54,7 @@ interface InstrumentationOptions { // Only effective if level sets higher than info. enableTrace: bool }, + unstableExclude?: Array } ``` diff --git a/packages/swc-coverage-instrument/README.md b/packages/swc-coverage-instrument/README.md index c129f89..2799047 100644 --- a/packages/swc-coverage-instrument/README.md +++ b/packages/swc-coverage-instrument/README.md @@ -29,6 +29,6 @@ let visitor = swc_coverage_instrument::create_coverage_instrumentation_visitor( let fold = as_folder(visitor); ``` -`InstrumentationOptions` is a subset of istanbul's instrumentation options. Refer [istanbul's option](https://github.com/istanbuljs/istanbuljs/blob/master/packages/istanbul-lib-instrument/src/instrumenter.js#L16-L27=) for the same configuration flags. However there are few exceptions or differences, referencing [InstrumentOptions](https://github.com/kwonoj/swc-plugin-coverage-instrument/blob/main/packages/swc-coverage-instrument/src/options/instrument_options.rs) will list all possible options. +`InstrumentationOptions` is a subset of istanbul's instrumentation options. Refer [istanbul's option](https://github.com/istanbuljs/istanbuljs/blob/master/packages/istanbul-lib-instrument/src/instrumenter.js#L16-L27=) for the same configuration flags. For the logging, this package does not init any subscriber by itself. Caller should setup proper `tracing-subscriber` as needed.