feat: bcoe#547 add default-summary to report configurations

miyasudokoro · Oct 28, 2024 · 242323a · 242323a
1 parent ff146b4
commit 242323a
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 6 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -23,7 +23,8 @@ export declare class Report {
     src?: Array<string>,
     allowExternal?: boolean,
     skipFull?: boolean,
-    excludeNodeModules?: boolean
+    excludeNodeModules?: boolean,
+    defaultSummarizer?: string
   })
   run(): Promise<void>;
 }
diff --git a/lib/commands/report.js b/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)

diff --git a/lib/parse-args.js b/lib/parse-args.js
@@ -163,6 +163,11 @@ function buildYargs (withCommands = false) {
       type: 'boolean',
       describe: 'Use Monocart coverage reports'
     })
+    .option('default-summarizer', {
+      default: 'pkg',
+      type: 'string',
+      describe: 'organization of HTML reports; choice of `pkg`, `nested`, or `flat`'
+    })
     .pkgConf('c8')
     .demandCommand(1)
     .check((argv) => {

diff --git a/lib/report.js b/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,7 +83,8 @@ class Report {
     const context = libReport.createContext({
       dir: this.reportsDirectory,
       watermarks: this.watermarks,
-      coverageMap: await this.getCoverageMapFromAllCoverageFiles()
+      coverageMap: await this.getCoverageMapFromAllCoverageFiles(),
+      defaultSummarizer: this.defaultSummarizer
     })
 
     for (const _reporter of this.reporter) {
@@ -196,8 +199,7 @@ class Report {
 
       clean: argv.clean,
 
-      // use default value for istanbul
-      defaultSummarizer: 'pkg',
+      defaultSummarizer: this.defaultSummarizer,
 
       onEnd: (coverageResults) => {
         // for check coverage