@naturalcycles/dev-lib 20.51.1 → 20.51.3

package/cfg/vitest.config.d.ts

@@ -27,6 +27,21 @@ export function getSharedConfig(cwd?: string): InlineConfig
  */
 export function getRootReporters(): InlineConfig['reporters']
 
+/**
+ * `outputFile` for the junit/json reporters at the monorepo root config (Vitest
+ * `projects` mode), where `outputFile` is a root-only option. Pair it with
+ * getRootReporters so the junit/json report is written in the aggregate root run.
+ */
+export function getRootOutputFile(): InlineConfig['outputFile']
+
+/**
+ * `coverage` for the monorepo root config (Vitest `projects` mode), where
+ * `coverage` is a root-only option. Without it on the root config no coverage
+ * report is produced when running via `projects`. Produces a single unified
+ * report spanning all projects.
+ */
+export function getRootCoverage(): InlineConfig['coverage']
+
 export const CollectReporter: any
 
 export class SummaryReporter {}

package/cfg/vitest.config.js

@@ -93,37 +93,8 @@ export function getSharedConfig(cwd) {
     include,
     exclude,
     reporters: getReporters(junitReporterEnabled, testType),
-    // outputFile location is specified for compatibility with the previous jest config
-    outputFile: junitReporterEnabled
-      ? {
-          junit: `./tmp/jest/${testType}.xml`,
-          json: `./tmp/jest/${testType}.json`,
-        }
-      : undefined,
-    coverage: {
-      enabled: coverageEnabled,
-      reporter: ['html', 'lcov', 'json', 'json-summary', !isCI && 'text'].filter(Boolean),
-      include: ['src/**/*.{ts,tsx}'],
-      exclude: [
-        '**/__exclude/**',
-        'scripts/**',
-        'public/**',
-        'src/index.{ts,tsx}',
-        'src/test/**',
-        'src/typings/**',
-        'src/{env,environment,environments}/**',
-        'src/bin/**',
-        'src/vendor/**',
-        '**/*.test.*',
-        '**/*.script.*',
-        '**/*.module.*',
-        '**/*.mock.*',
-        '**/*.page.{ts,tsx}',
-        '**/*.component.{ts,tsx}',
-        '**/*.directive.{ts,tsx}',
-        '**/*.modal.{ts,tsx}',
-      ],
-    },
+    outputFile: getOutputFile(),
+    coverage: getCoverageConfig(),
   }
 }
 
@@ -136,13 +107,7 @@ function getReporters(junitReporterEnabled, testType) {
     'default',
     GITHUB_ACTIONS && 'github-actions',
     new SummaryReporter(),
-    junitReporterEnabled && 'json',
-    junitReporterEnabled && [
-      'junit',
-      {
-        suiteName: `${testType} tests`,
-      },
-    ],
+    ...getJunitReporters(junitReporterEnabled, testType),
   ].filter(Boolean)
 }
 
@@ -169,7 +134,132 @@ export function getRootReporters() {
   if (override) return override
 
   const { GITHUB_ACTIONS } = process.env
-  return ['default', GITHUB_ACTIONS && 'github-actions', new SummaryReporter()].filter(Boolean)
+  return [
+    'default',
+    GITHUB_ACTIONS && 'github-actions',
+    new SummaryReporter(),
+    ...getJunitReporters(junitReporterEnabled, testType),
+  ].filter(Boolean)
+}
+
+/**
+ * `outputFile` for the junit/json reporters at the monorepo root config.
+ *
+ * Like `reporters`, `outputFile` is a root-only Vitest option: per-project
+ * `outputFile` is ignored when running via `projects`. So the root config must
+ * set it (alongside getRootReporters) for the junit/json report to be written
+ * in the aggregate root run.
+ *
+ * Use it in the root vitest.config.ts:
+ *
+ * export default defineConfig({
+ *   test: {
+ *     projects: ['./packages/*'],
+ *     reporters: getRootReporters(),
+ *     outputFile: getRootOutputFile(),
+ *   },
+ * })
+ */
+export function getRootOutputFile() {
+  return getOutputFile()
+}
+
+/**
+ * `coverage` config for the monorepo root config (Vitest `projects` mode).
+ *
+ * Like `reporters` and `outputFile`, `coverage` is a root-only Vitest option:
+ * it is read from the root project only (see Vitest's `getRootProject().
+ * serializedConfig.coverage`), so the per-package `coverage` set in
+ * getSharedConfig is IGNORED when running via `projects`. Without this on the
+ * root config no coverage report is produced at all (e.g. the CI upload of
+ * ./coverage/coverage-summary.json finds nothing).
+ *
+ * The report is a single, unified one spanning all projects: Vitest tracks
+ * coverage per-project internally but emits one report under `./coverage`.
+ * Per-project coverage `include` globs are matched unanchored against absolute
+ * paths, so executed files under `packages/<pkg>/src/**` are still included.
+ *
+ * Use it in the root vitest.config.ts:
+ *
+ * export default defineConfig({
+ *   test: {
+ *     projects: ['./packages/*'],
+ *     reporters: getRootReporters(),
+ *     outputFile: getRootOutputFile(),
+ *     coverage: getRootCoverage(),
+ *   },
+ * })
+ */
+export function getRootCoverage() {
+  return getCoverageConfig()
+}
+
+/**
+ * The coverage config, shared by the per-package (getSharedConfig) and root
+ * (getRootCoverage) configs. Only enabled for CI unit-test runs.
+ */
+function getCoverageConfig() {
+  return {
+    enabled: coverageEnabled,
+    reporter: ['html', 'lcov', 'json', 'json-summary', !isCI && 'text'].filter(Boolean),
+    // `**/src/**` (not root-anchored `src/**`) so the report covers `src/` at the
+    // repo root AND in every monorepo package (`packages/<pkg>/src/**`). This
+    // matters in `projects` mode, where coverage is produced once at the root:
+    // a root-anchored glob would list only root `src/` as untested files, and
+    // package sources that no test imports would silently drop off the report.
+    // Vitest always appends `**/node_modules/**` to exclude, so `**/src/**` is
+    // safe. The exclude globs below are likewise `**/`-prefixed so they keep
+    // matching inside packages (e.g. `packages/<pkg>/src/test/**`).
+    include: ['**/src/**/*.{ts,tsx}'],
+    exclude: [
+      '**/__exclude/**',
+      '**/scripts/**',
+      '**/public/**',
+      '**/src/index.{ts,tsx}',
+      '**/src/test/**',
+      '**/src/typings/**',
+      '**/src/{env,environment,environments}/**',
+      '**/src/bin/**',
+      '**/src/vendor/**',
+      '**/*.test.*',
+      '**/*.script.*',
+      '**/*.module.*',
+      '**/*.mock.*',
+      '**/*.page.{ts,tsx}',
+      '**/*.component.{ts,tsx}',
+      '**/*.directive.{ts,tsx}',
+      '**/*.modal.{ts,tsx}',
+    ],
+  }
+}
+
+/**
+ * The junit + json reporters, enabled in CI (except for manual tests).
+ * Shared by the per-package (getReporters) and root (getRootReporters) configs.
+ */
+function getJunitReporters(junitReporterEnabled, testType) {
+  if (!junitReporterEnabled) return []
+  return [
+    'json',
+    [
+      'junit',
+      {
+        suiteName: `${testType} tests`,
+      },
+    ],
+  ]
+}
+
+/**
+ * outputFile location is specified for compatibility with the previous jest config.
+ */
+function getOutputFile() {
+  return junitReporterEnabled
+    ? {
+        junit: `./tmp/jest/${testType}.xml`,
+        json: `./tmp/jest/${testType}.json`,
+      }
+    : undefined
 }
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/dev-lib",
   "type": "module",
-  "version": "20.51.1",
+  "version": "20.51.3",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15",