feat: starting point for passing through default-summarizer

lib/commands/report.js

@@ -37,7 +37,8 @@ exports.outputReport = async function (argv) {
     skipFull: argv.skipFull,
     excludeNodeModules: argv.excludeNodeModules,
     mergeAsync: argv.mergeAsync,
-    monocartArgv: (argv.experimentalMonocart || process.env.EXPERIMENTAL_MONOCART) ? argv : null
+    monocartArgv: (argv.experimentalMonocart || process.env.EXPERIMENTAL_MONOCART) ? argv : null,
+    defaultSummarizer: argv.defaultSummarizer
   })
   await report.run()
   if (argv.checkCoverage) await checkCoverages(argv, report)

lib/parse-args.js

@@ -76,6 +76,13 @@ function buildYargs (withCommands = false) {
       group: 'Reporting options',
       describe: 'apply exclude logic to files after they are remapped by a source-map'
     })
+    .option('default-summarizer', {
+      type: 'string',
+      default: 'pkg',
+      choices: ['pkg', 'nested', 'flat'],
+      group: 'Reporting options',
+      describe: 'for some reporters you can change the summary and hierarchy of reported files'
+    })
     .options('skip-full', {
       default: false,
       type: 'boolean',

lib/report.js

@@ -37,7 +37,8 @@ class Report {
     skipFull,
     excludeNodeModules,
     mergeAsync,
-    monocartArgv
+    monocartArgv,
+    defaultSummarizer
   }) {
     this.reporter = reporter
     this.reporterOptions = reporterOptions || {}
@@ -62,6 +63,7 @@ class Report {
     this.skipFull = skipFull
     this.mergeAsync = mergeAsync
     this.monocartArgv = monocartArgv
+    this.defaultSummarizer = defaultSummarizer
   }
 
   _getSrc (src) {
@@ -81,6 +83,7 @@ class Report {
     const context = libReport.createContext({
       dir: this.reportsDirectory,
       watermarks: this.watermarks,
+      defaultSummarizer: this.defaultSummarizer,
       coverageMap: await this.getCoverageMapFromAllCoverageFiles()
     })
 
@@ -127,7 +130,6 @@ class Report {
     function getSourceFilter () {
       return argv.sourceFilter || argv.filter || function (sourcePath) {
         if (argv.excludeAfterRemap) {
-          // console.log(sourcePath)
           return exclude.shouldInstrument(sourcePath)
         }
         return true

test/integration.js

@@ -286,6 +286,22 @@ beforeEach(function () {
         status.should.equal(1)
         output.toString('utf8').should.matchSnapshot()
       })
+
+      it('passes defaultSummarizer to report', () => {
+        spawnSync(nodePath, [
+          c8Path,
+          'report',
+          '--exclude="test/*.js"',
+          '--clean=true',
+          '--reporter=html',
+          '--default-summarizer=flat',
+          `--merge-async=${mergeAsync}`
+        ])
+        const html = readFileSync(resolve(process.cwd(), './coverage/index.html'), 'utf8')
+          // Remove timestamp added in HTML report.
+          .replace(/[0-9]+-[0-9]+-[0-9]+T[0-9]+:[0-9]+:[0-9]+.[0-9]+Z/g, '')
+        html.toString('utf8').should.matchSnapshot()
+      })
     })
 
     describe('ESM Modules', () => {
@@ -595,16 +611,6 @@ beforeEach(function () {
     })
     // see: https://github.com/bcoe/c8/issues/149
     it('cobertura report escapes special characters', () => {
-      spawnSync(nodePath, [
-        c8Path,
-        '--exclude="test/*.js"',
-        '--temp-directory=tmp/cobertura',
-        '--clean=true',
-        '--reporter=cobertura',
-        `--merge-async=${mergeAsync}`,
-        nodePath,
-        require.resolve('./fixtures/computed-method')
-      ])
       const cobertura = readFileSync(resolve(process.cwd(), './coverage/cobertura-coverage.xml'), 'utf8')
         .replace(/[0-9]{13,}/, 'nnnn')
         .replace(/<source>.*<\/source>/, '<source>/foo/file</source>')