Skip to content

Commit 27a87ee

Browse files
authored
Merge pull request #239 from kwonoj/update-readme
docs(readme): update docs
2 parents 4689fc9 + cd0bb16 commit 27a87ee

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jsc: {
3737
}
3838
```
3939

40-
`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.
40+
`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.
4141

4242
```
4343
interface InstrumentationOptions {
@@ -54,6 +54,7 @@ interface InstrumentationOptions {
5454
// Only effective if level sets higher than info.
5555
enableTrace: bool
5656
},
57+
unstableExclude?: Array<String>
5758
}
5859
```
5960

packages/swc-coverage-instrument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ let visitor = swc_coverage_instrument::create_coverage_instrumentation_visitor(
2929
let fold = as_folder(visitor);
3030
```
3131

32-
`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.
32+
`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.
3333

3434
For the logging, this package does not init any subscriber by itself. Caller should setup proper `tracing-subscriber` as needed.

0 commit comments

Comments
 (0)