Merge pull request #239 from kwonoj/update-readme

docs(readme): update docs
kwonoj · Jul 4, 2024 · 27a87ee · 27a87ee
2 parents 4689fc9 + cd0bb16
commit 27a87ee
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git 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<String>
 }
 ```
 

diff --git 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.