c8 7.11.1 → 7.12.0

package/README.md

@@ -36,6 +36,7 @@ Here is a list of common options. Run `c8 --help` for the full list and document
 | `--src` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `Array<string>` | `[process.cwd()]`|
 | `-n`, `--include` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `Array<string>` | `[]` (include all files) |
 | `-x`, `--exclude` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `Array<string>` | [list](https://github.com/istanbuljs/schema/blob/master/default-exclude.js) |
+| `--exclude-after-remap` | see [section below](#exclude-after-remap) for more info | `boolean` | `false` |
 | `-e`, `--extension` | only files matching these extensions will show coverage | `string \| Array<string>` | [list](https://github.com/istanbuljs/schema/blob/master/default-extension.js) |
 | `--skip-full` | do not show files with 100% statement, branch, and function coverage | `boolean` | `false` |
 | `--check-coverage` | check whether coverage is within thresholds provided | `boolean` | `false` |
@@ -53,6 +54,24 @@ By supplying `--all` to c8, all files in directories specified with `--src` (def
 and `--exclude` flag checks, will be loaded into the report. If any of those files remain uncovered they will be factored
 into the report with a default of 0% coverage.
 
+## SourceMap Support
+
+`c8` can handle source-maps, for remapping coverage from generated code to original source files (_useful for TypeScript, JSX, etc_).
+
+### Source map files versus inline source maps
+
+Just-in-time instrumented codebases will often insert source maps inline with the `.js` code they generate at runtime (e.g, `@babel/register` can be configured to insert a source map footer).
+
+Pre-instrumented codebases, e.g., running `tsc` to generate `.js` in a build folder, may generate either inline source maps, or a separate `.map` file stored on disk.
+
+`c8` can handle loading both types of source maps.
+
+### Exclude after remap
+
+Depending on the size and configuration of your project, it may be preferable to apply exclusion logic either before or after source-maps are used to remap compiled to original source files.
+
+`--exclude-after-remap` is used to control this behaviour.
+
 ## c8 report
 
 run `c8 report` to regenerate reports after `c8` has already been run.

package/lib/report.js

@@ -74,7 +74,7 @@ class Report {
       reports.create(_reporter, {
         skipEmpty: false,
         skipFull: this.skipFull,
-        maxCols: 100
+        maxCols: process.stdout.columns || 100
       }).execute(context)
     }
   }
@@ -190,12 +190,13 @@ class Report {
         result: emptyReports
       })
       const workingDirs = this.src
+      const { extension } = this.exclude
       for (const workingDir of workingDirs) {
         this.exclude.globSync(workingDir).forEach((f) => {
           const fullPath = resolve(workingDir, f)
           if (!fileIndex.has(fullPath)) {
             const ext = extname(fullPath)
-            if (ext === '.js' || ext === '.ts' || ext === '.mjs') {
+            if (extension.includes(ext)) {
               const stat = statSync(fullPath)
               const sourceMap = getSourceMapFromFile(fullPath)
               if (sourceMap) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c8",
-  "version": "7.11.1",
+  "version": "7.12.0",
   "description": "output coverage reports using Node.js' built in coverage",
   "main": "./index.js",
   "types": "./index.d.ts",