projen 0.103.26 → 0.103.27

package/.jsii

@@ -178,7 +178,7 @@
     "projen.javascript.biome_config": {
       "locationInModule": {
         "filename": "src/javascript/index.ts",
-        "line": 18
+        "line": 19
       },
       "symbolId": "src/javascript/biome/biome-config:"
     },
@@ -47948,6 +47948,104 @@
       ],
       "symbolId": "src/javascript/jest:CoverageThreshold"
     },
+    "projen.javascript.Destination": {
+      "assembly": "projen",
+      "docs": {
+        "see": "https://nodejs.org/api/test.html#test-reporters",
+        "stability": "experimental",
+        "summary": "Where a reporter's output is written."
+      },
+      "fqn": "projen.javascript.Destination",
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/javascript/node-native-test-runner.ts",
+        "line": 101
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Write to a file at the given path."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 116
+          },
+          "name": "file",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "path of the file to write to."
+              },
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.javascript.Destination"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "Destination",
+      "namespace": "javascript",
+      "properties": [
+        {
+          "const": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Write to standard error."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 110
+          },
+          "name": "STDERR",
+          "static": true,
+          "type": {
+            "fqn": "projen.javascript.Destination"
+          }
+        },
+        {
+          "const": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Write to standard output."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 105
+          },
+          "name": "STDOUT",
+          "static": true,
+          "type": {
+            "fqn": "projen.javascript.Destination"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The underlying value: `\"stdout\"`, `\"stderr\"`, or a file path."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 124
+          },
+          "name": "value",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/javascript/node-native-test-runner:Destination"
+    },
     "projen.javascript.DevEngineDependency": {
       "assembly": "projen",
       "datatype": true,
@@ -52116,7 +52214,7 @@
         },
         "locationInModule": {
           "filename": "src/javascript/node-config-file.ts",
-          "line": 48
+          "line": 49
         },
         "parameters": [
           {
@@ -52137,7 +52235,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/javascript/node-config-file.ts",
-        "line": 27
+        "line": 28
       },
       "methods": [
         {
@@ -52147,7 +52245,7 @@
           },
           "locationInModule": {
             "filename": "src/javascript/node-config-file.ts",
-            "line": 32
+            "line": 33
           },
           "name": "of",
           "parameters": [
@@ -52178,7 +52276,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/javascript/node-config-file.ts",
-            "line": 41
+            "line": 42
           },
           "name": "config",
           "type": {
@@ -52193,7 +52291,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/javascript/node-config-file.ts",
-            "line": 46
+            "line": 47
           },
           "name": "file",
           "type": {
@@ -52218,7 +52316,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/javascript/node-config-file.ts",
-        "line": 12
+        "line": 13
       },
       "name": "NodeConfigFileOptions",
       "namespace": "javascript",
@@ -52233,7 +52331,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/javascript/node-config-file.ts",
-            "line": 18
+            "line": 19
           },
           "name": "filePath",
           "optional": true,
@@ -56387,6 +56485,526 @@
       ],
       "symbolId": "src/javascript/node-config:NodeConfigSchemaWatch"
     },
+    "projen.javascript.NodeNativeTestRunner": {
+      "assembly": "projen",
+      "base": "projen.Component",
+      "docs": {
+        "remarks": "Owns the generated Node.js configuration file, the \"test\", \"test:update\"\nand \"test:watch\" tasks, and the reporters and test match patterns they use.",
+        "stability": "experimental",
+        "summary": "Configures Node's built-in test runner (`node --test`)."
+      },
+      "fqn": "projen.javascript.NodeNativeTestRunner",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/javascript/node-native-test-runner.ts",
+          "line": 383
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.IConstruct"
+            }
+          },
+          {
+            "name": "options",
+            "optional": true,
+            "type": {
+              "fqn": "projen.javascript.NodeNativeTestRunnerOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/javascript/node-native-test-runner.ts",
+        "line": 355
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Returns the singleton NodeNativeTestRunner component of a project or undefined if there is none."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 360
+          },
+          "name": "of",
+          "parameters": [
+            {
+              "name": "project",
+              "type": {
+                "fqn": "projen.Project"
+              }
+            }
+          ],
+          "returns": {
+            "optional": true,
+            "type": {
+              "fqn": "projen.javascript.NodeNativeTestRunner"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "default": "Destination.STDOUT",
+            "stability": "experimental",
+            "summary": "Adds a reporter, or updates its destination if one with the same name is already configured."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 560
+          },
+          "name": "addReporter",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "The name/kind of the reporter, e.g. `spec`, `junit`, `lcov`."
+              },
+              "name": "name",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "docs": {
+                "summary": "Where the reporter's output is written."
+              },
+              "name": "destination",
+              "optional": true,
+              "type": {
+                "fqn": "projen.javascript.Destination"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Adds a test match pattern."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 541
+          },
+          "name": "addTestMatch",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "glob pattern to match for tests."
+              },
+              "name": "pattern",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Lists the configured reporters, in the order they were added."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 575
+          },
+          "name": "listReporters",
+          "returns": {
+            "type": {
+              "collection": {
+                "elementtype": {
+                  "fqn": "projen.javascript.NodeReporter"
+                },
+                "kind": "array"
+              }
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Removes a reporter, if configured."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 568
+          },
+          "name": "removeReporter",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "The name/kind of the reporter to remove."
+              },
+              "name": "name",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Removes a test match pattern, if configured."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 549
+          },
+          "name": "removeTestMatch",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "glob pattern to remove."
+              },
+              "name": "pattern",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "NodeNativeTestRunner",
+      "namespace": "javascript",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The generated Node.js configuration file."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 377
+          },
+          "name": "configFile",
+          "type": {
+            "fqn": "projen.javascript.NodeConfigFile"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 366
+          },
+          "name": "project",
+          "overrides": "projen.Component",
+          "type": {
+            "fqn": "projen.javascript.NodeProject"
+          }
+        }
+      ],
+      "symbolId": "src/javascript/node-native-test-runner:NodeNativeTestRunner"
+    },
+    "projen.javascript.NodeNativeTestRunnerOptions": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Options for Node.js' built-in test runner (`node --test`)."
+      },
+      "fqn": "projen.javascript.NodeNativeTestRunnerOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/javascript/node-native-test-runner.ts",
+        "line": 220
+      },
+      "name": "NodeNativeTestRunnerOptions",
+      "namespace": "javascript",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "experimental",
+            "summary": "Indicates whether the coverage information should be collected while executing the test, via `--experimental-test-coverage`."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 291
+          },
+          "name": "collectCoverage",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"node.config.json\"",
+            "stability": "experimental",
+            "summary": "Path to the JSON configuration file for the test runner."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 275
+          },
+          "name": "configFilePath",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"coverage\"",
+            "stability": "experimental",
+            "summary": "The directory where coverage files are output, if coverage collection is enabled."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 227
+          },
+          "name": "coverageDirectory",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[\"**\\/test/**\", \"**\\/__tests__/**\"]",
+            "remarks": "If a file path matches any of the\npatterns, coverage information will be skipped for it.",
+            "stability": "experimental",
+            "summary": "An array of glob patterns that are matched against all file paths before executing coverage collection."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 300
+          },
+          "name": "coveragePathIgnorePatterns",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no extra options",
+            "remarks": "Each element is passed as a single argument, exactly as given: no shell\nparses these, so a flag and its value need separate elements\n(`[\"--foo\", \"bar\"]`, not `[\"--foo bar\"]`).",
+            "stability": "experimental",
+            "summary": "Additional options to pass to the `node --test` CLI invocation."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 247
+          },
+          "name": "extraCliOptions",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- undefined",
+            "remarks": "Written as `test-global-setup` in the generated Node.js configuration\nfile.",
+            "stability": "experimental",
+            "summary": "This option allows the use of a custom global setup module which exports a function that is triggered once before all test suites."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 310
+          },
+          "name": "globalSetup",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "stability": "experimental",
+            "summary": "Enable module mocking support via `--experimental-test-module-mocks`."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 317
+          },
+          "name": "moduleMocks",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no additional node options",
+            "stability": "experimental",
+            "summary": "Additional entries for the `nodeOptions` section of the generated configuration file (e.g. `enableSourceMaps`, `disableWarning`)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 338
+          },
+          "name": "nodeOptions",
+          "optional": true,
+          "type": {
+            "fqn": "projen.javascript.NodeConfigSchemaNodeOptions"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "experimental",
+            "summary": "Preserve the default reporters (`spec`, `lcov`, `junit`) when additional reporters are added."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 255
+          },
+          "name": "preserveDefaultReporters",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no additional reporters",
+            "remarks": "These are added on top of the default reporters (`spec`, `lcov`, `junit`),\nwhich are controlled via `collectCoverage`. Use\n`NodeNativeTestRunner.addReporter`/`removeReporter`/`listReporters` to\nmanage reporters after construction.",
+            "stability": "experimental",
+            "summary": "Additional reporters to configure (e.g. `{ name: \"tap\", destination: Destination.file(\"test-reports/tap.txt\") }`)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 268
+          },
+          "name": "reporters",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.javascript.NodeReporter"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no additional options",
+            "stability": "experimental",
+            "summary": "Additional entries for the `test` section of the generated configuration file (e.g. `testConcurrency`, `testTimeout`)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 346
+          },
+          "name": "testConfig",
+          "optional": true,
+          "type": {
+            "fqn": "projen.javascript.NodeConfigSchemaTest"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- combines Node.js' own default test file discovery with Jest conventions",
+            "remarks": "By default it\ncombines Node.js' own default test file discovery with Jest conventions.",
+            "stability": "experimental",
+            "summary": "Glob patterns matching the files that contain tests."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 283
+          },
+          "name": "testMatch",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "Uses `amaro` (the TypeScript transformer used internally by Node.js) as an\nexternal loader via `--import=amaro/transform`. Adds a dependency on the\n`amaro` package and enables `--enable-source-maps` to preserve accurate\nstack traces.",
+            "see": "https://github.com/nodejs/amaro",
+            "stability": "experimental",
+            "summary": "Whether to enable transformation of TypeScript-only syntax (e.g. enums, namespaces)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 330
+          },
+          "name": "transformTypes",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- ALWAYS",
+            "stability": "experimental",
+            "summary": "Whether to update snapshots in task \"test\" (which is executed in task \"build\" and build workflows), or create a separate task \"test:update\" for updating snapshots."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 236
+          },
+          "name": "updateSnapshot",
+          "optional": true,
+          "type": {
+            "fqn": "projen.javascript.NodeTestUpdateSnapshot"
+          }
+        }
+      ],
+      "symbolId": "src/javascript/node-native-test-runner:NodeNativeTestRunnerOptions"
+    },
     "projen.javascript.NodePackage": {
       "assembly": "projen",
       "base": "projen.Component",
@@ -59724,6 +60342,92 @@
       ],
       "symbolId": "src/javascript/node-project:NodeProjectOptions"
     },
+    "projen.javascript.NodeReporter": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "see": "https://nodejs.org/api/test.html#test-reporters",
+        "stability": "experimental",
+        "summary": "A single reporter/destination pair for the Node.js native test runner."
+      },
+      "fqn": "projen.javascript.NodeReporter",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/javascript/node-native-test-runner.ts",
+        "line": 133
+      },
+      "name": "NodeReporter",
+      "namespace": "javascript",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Destination.STDOUT",
+            "see": "https://github.com/nodejs/node/blob/4215cc35e25c44f9f4fea5a4541afc862db7ef0a/test/parallel/test-runner-reporters.js#L46-L77",
+            "stability": "experimental",
+            "summary": "Where the reporter's output is written."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 144
+          },
+          "name": "destination",
+          "type": {
+            "fqn": "projen.javascript.Destination"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name/kind of the reporter."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/javascript/node-native-test-runner.ts",
+            "line": 137
+          },
+          "name": "name",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/javascript/node-native-test-runner:NodeReporter"
+    },
+    "projen.javascript.NodeTestUpdateSnapshot": {
+      "assembly": "projen",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Whether to update snapshots in task \"test\" (which is executed in task \"build\" and build workflows), or create a separate task \"test:update\" for updating snapshots."
+      },
+      "fqn": "projen.javascript.NodeTestUpdateSnapshot",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/javascript/node-native-test-runner.ts",
+        "line": 52
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Always update snapshots in \"test\" task."
+          },
+          "name": "ALWAYS"
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Never update snapshots in \"test\" task and create a separate \"test:update\" task."
+          },
+          "name": "NEVER"
+        }
+      ],
+      "name": "NodeTestUpdateSnapshot",
+      "namespace": "javascript",
+      "symbolId": "src/javascript/node-native-test-runner:NodeTestUpdateSnapshot"
+    },
     "projen.javascript.NpmAccess": {
       "assembly": "projen",
       "docs": {
@@ -104599,6 +105303,6 @@
   "usedFeatures": [
     "class-covariant-overrides"
   ],
-  "version": "0.103.26",
-  "fingerprint": "KJ6hSDF3fMt+ABOl8vvD1BoHxCWwNnTGPZ/NXUccWjc="
+  "version": "0.103.27",
+  "fingerprint": "6GpkS9XyF0OrNzwE0MwgAPXfYMbQzcMcBWAKqHEfo/k="
 }