dd-trace 6.16.0 → 6.18.0

package/ci/diagnose.js

@@ -434,7 +434,6 @@ function checkDdTraceDependency (results, manifests, options = {}) {
  * Checks whether static diagnosis parsed the repository root package manifest.
  *
  * @param {Array<object>} manifests parsed package manifests
- * @returns {boolean} true when the root package.json was parsed
  */
 function hasParsedRootManifest (manifests) {
   return manifests.some(manifest => manifest.relativePath === 'package.json')
@@ -1233,7 +1232,6 @@ function getEligibleCommandMatch (framework) {
  *
  * @param {string} frameworkId framework id
  * @param {object} script package script
- * @returns {number} lower is preferred
  */
 function getFrameworkCommandPreference (frameworkId, script) {
   let score = 0
@@ -1294,7 +1292,6 @@ function getIdentityTokens (value) {
  * @param {object} left first command or dependency entry
  * @param {object} right second command or dependency entry
  * @param {Map<string, number>|undefined} scores package preference scores
- * @returns {number} sort order
  */
 function compareProjectPreference (left, right, scores) {
   return compareProjectScope(left, right, scores) ||
@@ -1307,7 +1304,6 @@ function compareProjectPreference (left, right, scores) {
  * @param {object} left first command or dependency entry
  * @param {object} right second command or dependency entry
  * @param {Map<string, number>|undefined} scores package preference scores
- * @returns {number} sort order before stable path tie-breaking
  */
 function compareProjectScope (left, right, scores) {
   const scoreDifference = (scores?.get(right.relativePath) || 0) - (scores?.get(left.relativePath) || 0)
@@ -1321,7 +1317,6 @@ function compareProjectScope (left, right, scores) {
  *
  * @param {string} frameworkId framework id
  * @param {string} command package script command
- * @returns {boolean} whether the command is ineligible
  */
 function isIneligibleFrameworkCommand (frameworkId, command) {
   if (frameworkId === 'cucumber' && !isCucumberRunnerCommand(command)) return true
@@ -1335,7 +1330,6 @@ function isIneligibleFrameworkCommand (frameworkId, command) {
  * Checks whether a package command invokes the Cucumber runner instead of merely naming a Cucumber config file.
  *
  * @param {string} command package script command
- * @returns {boolean} whether the command invokes Cucumber
  */
 function isCucumberRunnerCommand (command) {
   return CUCUMBER_RUNNER_COMMAND_RE.test(String(command || ''))
@@ -1724,7 +1718,6 @@ function getScanExclusions (root, excludePaths) {
  *
  * @param {string} relativePath repository-relative path
  * @param {Set<string>} exclusions normalized exclusions
- * @returns {boolean} whether the path must be skipped
  */
 function isScanPathExcluded (relativePath, exclusions) {
   const normalizedPath = normalizeRelativePath(relativePath)
@@ -1824,7 +1817,6 @@ function getSafeScannedFile (root, physicalRoot, relativePath) {
  *
  * @param {string} root allowed root
  * @param {string} filename candidate path
- * @returns {boolean} whether the candidate is inside the root
  */
 function isPathInside (root, filename) {
   const relative = path.relative(root, filename)
@@ -1835,7 +1827,6 @@ function isPathInside (root, filename) {
  * Checks whether a filename should be scanned as text.
  *
  * @param {string} name filename
- * @returns {boolean} true if the file is text-like
  */
 function isTextFileName (name) {
   return TEXT_FILE_NAMES.has(name) || TEXT_EXTENSIONS.has(path.extname(name))
@@ -1845,7 +1836,6 @@ function isTextFileName (name) {
  * Checks whether a file is a common CI workflow file.
  *
  * @param {string} relativePath relative path
- * @returns {boolean} true if the path is a workflow file
  */
 function isWorkflowFile (relativePath) {
   return relativePath.startsWith('.github/workflows/') ||
@@ -1867,7 +1857,6 @@ function isWorkflowFile (relativePath) {
  * Checks whether a scanned file is likely to configure test process initialization.
  *
  * @param {object} file scanned text file
- * @returns {boolean} true when plain dd-trace init should be treated as test setup evidence
  */
 function isTestSetupOrCiFile (file) {
   const relativePath = file.relativePath
@@ -1891,7 +1880,6 @@ function isTestSetupOrCiFile (file) {
  * @param {string} root repository root
  * @param {string|undefined} gitExecutable trusted git executable
  * @param {typeof process.env} env credential-free git environment
- * @returns {boolean} true if git runs
  */
 function canRunGit (execFile, root, gitExecutable, env) {
   if (!gitExecutable) return false
@@ -1912,7 +1900,6 @@ function canRunGit (execFile, root, gitExecutable, env) {
  * @param {string} gitExecutable trusted git executable
  * @param {typeof process.env} env credential-free git environment
  * @param {string[]} args git arguments
- * @returns {string} command output
  */
 function runGit (execFile, root, gitExecutable, env, args) {
   try {
@@ -2024,7 +2011,6 @@ function coerceVersion (rawVersion) {
  * Checks whether a manifest dependency range cannot be represented by one comparable version.
  *
  * @param {string} rawVersion package manifest version/range
- * @returns {boolean} true when static diagnosis should ask the user to verify the range
  */
 function isAmbiguousRange (rawVersion) {
   const version = String(rawVersion || '').trim()
@@ -2038,7 +2024,6 @@ function isAmbiguousRange (rawVersion) {
  *
  * @param {Array<object>} frameworks detected frameworks
  * @param {string} id framework id
- * @returns {boolean} true if present
  */
 function hasFramework (frameworks, id) {
   return frameworks.some(framework => framework.id === id)
@@ -2048,7 +2033,6 @@ function hasFramework (frameworks, id) {
  * Checks whether NODE_OPTIONS preloads dd-trace/ci/init.
  *
  * @param {string|undefined} nodeOptions NODE_OPTIONS value
- * @returns {boolean} true if dd-trace/ci/init is present
  */
 function hasCiInitInNodeOptions (nodeOptions) {
   return !!nodeOptions && INIT_PRELOAD_RE.test(nodeOptions)
@@ -2058,7 +2042,6 @@ function hasCiInitInNodeOptions (nodeOptions) {
  * Checks whether NODE_OPTIONS preloads dd-trace/register.js.
  *
  * @param {string|undefined} nodeOptions NODE_OPTIONS value
- * @returns {boolean} true if dd-trace/register.js is present
  */
 function hasRegisterInNodeOptions (nodeOptions) {
   return !!nodeOptions && REGISTER_PRELOAD_RE.test(nodeOptions)
@@ -2068,7 +2051,6 @@ function hasRegisterInNodeOptions (nodeOptions) {
  * Checks whether environment contains branch or tag metadata.
  *
  * @param {typeof process.env} env environment
- * @returns {boolean} true if branch metadata exists
  */
 function hasBranchMetadata (env) {
   return !!(
@@ -2092,7 +2074,6 @@ function hasBranchMetadata (env) {
  * Checks whether environment contains commit SHA metadata.
  *
  * @param {typeof process.env} env environment
- * @returns {boolean} true if SHA metadata exists
  */
 function hasShaMetadata (env) {
   return !!(
@@ -2113,7 +2094,6 @@ function hasShaMetadata (env) {
  * Checks truthy string env values.
  *
  * @param {string|undefined} value value to inspect
- * @returns {boolean} true if value is true-like
  */
 function isTrueLike (value) {
   return /^(?:1|true)$/i.test(String(value || ''))
@@ -2123,7 +2103,6 @@ function isTrueLike (value) {
  * Checks false-like string env values.
  *
  * @param {string|undefined} value value to inspect
- * @returns {boolean} true if value is false-like
  */
 function isFalseLike (value) {
   return /^(?:0|false)$/i.test(String(value || ''))
@@ -2133,7 +2112,6 @@ function isFalseLike (value) {
  * Formats a list of locations for text output.
  *
  * @param {string[]} locations relative paths
- * @returns {string} formatted locations
  */
 function formatLocations (locations) {
   const uniqueLocations = unique(locations).slice(0, 5)
@@ -2231,7 +2209,6 @@ function uniqueVersionDetections (detections) {
  * Normalizes relative paths to POSIX separators for stable output.
  *
  * @param {string} relativePath relative path
- * @returns {string} normalized path
  */
 function normalizeRelativePath (relativePath) {
   return relativePath.split(path.sep).join('/')

package/ci/test-optimization-validation/approval-artifacts.js

@@ -56,7 +56,6 @@ function writeApprovalArtifacts (input) {
  *
  * @param {Array<{path: string, sha256: string}>|undefined} expected preflight project files
  * @param {Array<{path: string, sha256: string}>} actual approval project files
- * @returns {void}
  */
 function assertExpectedProjectFiles (expected, actual) {
   if (!expected) return
@@ -109,7 +108,6 @@ function loadApprovedPlan (approvalPath, expectedDigest) {
  *
  * @param {object} material parsed approval material
  * @param {string} approvalPath approved JSON path
- * @returns {void}
  */
 function validateApprovedPlanShape (material, approvalPath) {
   const manifestPath = material?.manifest?.path
@@ -145,7 +143,6 @@ function validateApprovedPlanShape (material, approvalPath) {
  * Creates a standard SHA-256 checksum list for independently checking covered files.
  *
  * @param {object} material approval material
- * @returns {string} checksum manifest
  */
 function getCoveredFilesManifest (material) {
   const files = new Map([[material.manifest.path, material.manifest.sha256]])

package/ci/test-optimization-validation/approval.js

@@ -27,7 +27,6 @@ const PACKAGE_SNAPSHOT_EXCLUDED_NAMES = new Set(['.git', '.nyc_output', 'node_mo
  * @param {string} input.offlineFixtureNonce random fixture-root nonce shown in the execution plan
  * @param {boolean} [input.keepTempFiles] whether generated files are retained
  * @param {boolean} [input.verbose] whether command progress is printed
- * @returns {string} SHA-256 approval digest
  */
 function getApprovalDigest ({
   manifest,
@@ -185,7 +184,6 @@ function getApprovalProjectSnapshot (manifest, { includeLocal = true } = {}) {
  * Serializes approval material using stable formatting suitable for independent SHA-256 tools.
  *
  * @param {object} input approval inputs
- * @returns {string} UTF-8 JSON text ending in one newline
  */
 function serializeApprovalMaterial (input) {
   return `${JSON.stringify(getApprovalMaterial(input), null, 2)}\n`
@@ -299,7 +297,6 @@ function getSelectedGeneratedPaths (strategy, requestedScenario) {
  * Hashes one covered regular file.
  *
  * @param {string} filename absolute filename
- * @returns {string} lowercase SHA-256 digest
  */
 function getFileDigest (filename) {
   return crypto.createHash('sha256').update(fs.readFileSync(filename)).digest('hex')
@@ -329,7 +326,6 @@ function collectPackageFiles (directory, excludedPaths, files) {
  *
  * @param {string} filename package path
  * @param {string[]} excludedPaths generated paths omitted from the package snapshot
- * @returns {boolean} whether the path is excluded
  */
 function isExcludedPackagePath (filename, excludedPaths) {
   return excludedPaths.some(excluded => filename === excluded || filename.startsWith(`${excluded}${path.sep}`))
@@ -339,7 +335,6 @@ function isExcludedPackagePath (filename, excludedPaths) {
  * Resolves an existing path or its nearest existing ancestor through filesystem aliases.
  *
  * @param {string} filename path that may not exist yet
- * @returns {string} physical path
  */
 function resolvePhysicalPath (filename) {
   const missingSegments = []
@@ -358,7 +353,6 @@ function resolvePhysicalPath (filename) {
  *
  * @param {string} digest supplied approval digest
  * @param {object} input approval inputs
- * @returns {void}
  */
 function assertApprovalDigest (digest, input) {
   if (!APPROVAL_DIGEST_PATTERN.test(String(digest || ''))) {

package/ci/test-optimization-validation/artifact-id.js

@@ -8,7 +8,6 @@ const MAX_PREFIX_LENGTH = 72
  * Maps an arbitrary manifest identifier to a bounded, portable, collision-resistant path segment.
  *
  * @param {string} value original identifier
- * @returns {string} artifact path segment
  */
 function getArtifactId (value) {
   const source = String(value)

package/ci/test-optimization-validation/bounded-json.js

@@ -35,7 +35,6 @@ function parseBoundedJson (source, options = {}) {
  *
  * @param {Buffer} buffer JSON bytes
  * @param {object} limits parser limits
- * @returns {number} aggregate collection entries
  */
 function scanJson (buffer, limits) {
   const containerTypes = new Uint8Array(limits.maxNestingDepth)

package/ci/test-optimization-validation/cli.js

@@ -388,7 +388,6 @@ async function validateFramework ({ framework, manifest, options, out, packageCh
  * Creates a manifest scaffold and prints the bounded next step.
  *
  * @param {object} options CLI options
- * @returns {void}
  */
 function initializeManifest (options) {
   const manifestPath = path.resolve(options.manifest)
@@ -423,7 +422,6 @@ function initializeManifest (options) {
  *
  * @param {object} manifest loaded manifest
  * @param {object} options CLI options
- * @returns {void}
  */
 function printPlan (manifest, options) {
   const out = validateOutputPath(manifest, options.out)
@@ -560,7 +558,6 @@ function getInstalledPackageCheckError (packageCheck) {
  * Restores approved execution options from approval.json.
  *
  * @param {object} options parsed options
- * @returns {void}
  */
 function applyApprovedPlanOptions (options) {
   if (!options.approvedArtifactSha256) throw new Error('--run-approved-plan requires --sha256.')
@@ -619,7 +616,6 @@ function getApprovalManifest (manifest, targets) {
  * @param {object} framework framework entry
  * @param {Set<string>} scenarios selected scenarios
  * @param {object} blocker blocking result
- * @returns {void}
  */
 function addAdvancedNotReached (results, framework, scenarios, blocker) {
   for (const scenario of getAdvancedScenarios(scenarios)) {
@@ -648,7 +644,6 @@ function addAdvancedNotReached (results, framework, scenarios, blocker) {
  * @param {Set<string>} scenarios selected scenarios
  * @param {string} reasonCode blocker id
  * @param {string} [blockerCategoryOverride] blocker category supplied by a runtime result
- * @returns {void}
  */
 function addNotReachedLocalResults (results, framework, scenarios, reasonCode, blockerCategoryOverride) {
   const blockerCategory = blockerCategoryOverride || framework.blockerCategory || (
@@ -675,7 +670,6 @@ function addNotReachedLocalResults (results, framework, scenarios, reasonCode, b
  * @param {object[]} results result list
  * @param {object[]} frameworks selected frameworks
  * @param {Set<string>} scenarios selected scenarios
- * @returns {void}
  */
 function addMissingResults (results, frameworks, scenarios) {
   for (const framework of frameworks) {
@@ -728,7 +722,6 @@ function normalizeScenarioSelection (scenario) {
  * Normalizes a framework target.
  *
  * @param {string} target target value
- * @returns {string} normalized target
  */
 function normalizeFrameworkTarget (target) {
   const normalized = String(target).trim().replace(/(?<!:):+$/, '')
@@ -741,7 +734,6 @@ function normalizeFrameworkTarget (target) {
  *
  * @param {object} manifest loaded manifest
  * @param {string} outputPath output path
- * @returns {string} absolute output path
  */
 function validateOutputPath (manifest, outputPath) {
   const root = path.resolve(manifest.repository.root)
@@ -757,7 +749,6 @@ function validateOutputPath (manifest, outputPath) {
  * Prevents incompatible CLI modes.
  *
  * @param {object} options parsed options
- * @returns {void}
  */
 function assertCompatibleModes (options) {
   if (!options.runApprovedPlan) return
@@ -772,7 +763,6 @@ function assertCompatibleModes (options) {
  * @param {string[]} argv arguments
  * @param {number} index value index
  * @param {string} flag flag name
- * @returns {string} flag value
  */
 function requireValue (argv, index, flag) {
   if (!argv[index]) throw new Error(`${flag} requires a value.`)
@@ -782,7 +772,6 @@ function requireValue (argv, index, flag) {
 /**
  * Prints CLI help.
  *
- * @returns {void}
  */
 function printHelp () {
   console.log(`Usage: node ci/validate-test-optimization.js [options]
@@ -805,7 +794,6 @@ function printHelp () {
  * @param {object} framework framework entry
  * @param {string} phase phase name
  * @param {string} status status
- * @returns {void}
  */
 function logPhase (framework, phase, status) {
   console.log(sanitizeConsoleText(`[test-optimization-validator] ${framework.id}: ${phase}: ${status}`))

package/ci/test-optimization-validation/command-output-policy.js

@@ -162,7 +162,6 @@ function assertSafeOutputPath ({ outputPath, repositoryRoot, artifactRoot, comma
  *
  * @param {string} outputPath absolute output path
  * @param {string} repositoryRoot absolute repository root
- * @returns {void}
  */
 function assertPhysicalOutputPathInsideRepository (outputPath, repositoryRoot) {
   const physicalRoot = fs.realpathSync(repositoryRoot)

package/ci/test-optimization-validation/command-runner.js

@@ -346,7 +346,6 @@ function runCommand (command, options = {}) {
  *
  * @param {object} result command result
  * @param {object[]} outputStates prepared command output state
- * @returns {void}
  */
 function finishCommandOutputCleanup (result, outputStates) {
   result.commandOutputPaths = cleanupCommandOutputs(outputStates)
@@ -608,7 +607,6 @@ function serializeCommand (command) {
  * Renders the command that will actually execute without trusting display-only manifest fields.
  *
  * @param {object} command command to render
- * @returns {string} unambiguous customer-facing command
  */
 function serializeApprovalCommand (command) {
   return command.argv.map(formatApprovalArgument).join(' ')
@@ -618,7 +616,6 @@ function serializeApprovalCommand (command) {
  * Quotes arguments whose boundaries would otherwise be ambiguous in an approval plan.
  *
  * @param {string} value argument value
- * @returns {string} visible argument
  */
 function formatApprovalArgument (value) {
   const argument = String(value)

package/ci/test-optimization-validation/environment.js

@@ -6,7 +6,6 @@
  * @param {string} left first variable name
  * @param {string} right second variable name
  * @param {string} [platform] target platform
- * @returns {boolean} whether the names are equivalent
  */
 function environmentNamesEqual (left, right, platform = process.platform) {
   return platform === 'win32' ? left.toUpperCase() === right.toUpperCase() : left === right
@@ -45,7 +44,6 @@ function getEnvironmentValue (environment, name, platform = process.platform) {
  * @param {string} name canonical variable name
  * @param {string|undefined} value environment value
  * @param {string} [platform] target platform
- * @returns {void}
  */
 function setEnvironmentValue (environment, name, value, platform = process.platform) {
   for (const candidate of Object.keys(environment)) {
@@ -60,7 +58,6 @@ function setEnvironmentValue (environment, name, value, platform = process.platf
  * @param {Record<string, string|undefined>} target destination environment
  * @param {Record<string, string|undefined>} source overriding entries
  * @param {string} [platform] target platform
- * @returns {void}
  */
 function mergeEnvironment (target, source, platform = process.platform) {
   if (source) {
@@ -75,7 +72,6 @@ function mergeEnvironment (target, source, platform = process.platform) {
  *
  * @param {string} name variable name
  * @param {string} [platform] target platform
- * @returns {boolean} whether this is a Datadog variable
  */
 function isDatadogEnvironmentName (name, platform = process.platform) {
   const normalized = platform === 'win32' ? name.toUpperCase() : name

package/ci/test-optimization-validation/executable-approval.js

@@ -7,7 +7,6 @@ const APPROVED_EXECUTABLE = Symbol('approvedValidationExecutable')
  *
  * @param {object} command command to bind
  * @param {object} identity approved executable identity
- * @returns {void}
  */
 function bindApprovedExecutable (command, identity) {
   Object.defineProperty(command, APPROVED_EXECUTABLE, {

package/ci/test-optimization-validation/executable.js

@@ -113,7 +113,6 @@ function getCommandExecutableIdentity (command, repositoryRoot) {
  *
  * @param {object} current current identity
  * @param {object} approved approved identity
- * @returns {boolean} exact identity match
  */
 function areExecutableIdentitiesEqual (current, approved) {
   return current.argv0 === approved.argv0 &&
@@ -176,7 +175,6 @@ function splitNodeOptions (source) {
  *
  * @param {string} value candidate value
  * @param {string} [platform] target platform
- * @returns {boolean} whether the value includes explicit path syntax
  */
 function isExplicitExecutablePath (value, platform = process.platform) {
   if (typeof value !== 'string') return false
@@ -188,7 +186,6 @@ function isExplicitExecutablePath (value, platform = process.platform) {
  * Returns whether a command has the only executable shape the validator supports.
  *
  * @param {object} command command candidate
- * @returns {boolean} whether it is a direct runner
  */
 function isDirectRunnerCommand (command) {
   return command?.usesShell === false &&
@@ -218,7 +215,6 @@ function getFileIdentity (filename) {
  * Returns whether a path resolves to a regular file.
  *
  * @param {string} filename candidate path
- * @returns {boolean} whether the file is available
  */
 function isRegularFile (filename) {
   try {
@@ -233,7 +229,6 @@ function isRegularFile (filename) {
  *
  * @param {string} root root path
  * @param {string} filename candidate path
- * @returns {boolean} whether the path is contained
  */
 function isPathInside (root, filename) {
   const relative = path.relative(path.resolve(root), path.resolve(filename))

package/ci/test-optimization-validation/framework-adapters/cucumber.js

@@ -86,7 +86,6 @@ const JAVASCRIPT_STRING_ESCAPES = Object.freeze({
  * directory would alter project test semantics, so those versions remain a validator limitation.
  *
  * @param {string|null|undefined} version installed Cucumber version
- * @returns {boolean} whether validator-owned config isolation is supported
  */
 function supportsConfigIsolation (version) {
   const match = /^[v=]?(\d+)(?:\.|$)/.exec(String(version || ''))
@@ -97,7 +96,6 @@ function supportsConfigIsolation (version) {
  * Reports whether a file follows the Cucumber feature convention.
  *
  * @param {string} filename candidate filename
- * @returns {boolean} whether the candidate can be selected by Cucumber
  */
 function isTestFile (filename) {
   return filename.endsWith('.feature')
@@ -107,7 +105,6 @@ function isTestFile (filename) {
  * Counts statically declared Cucumber scenarios in a feature.
  *
  * @param {string} source feature source
- * @returns {number} declared scenario count
  */
 function getScenarioCount (source) {
   return [...source.matchAll(/^[ \t]*(?:Example|Scenario(?: Outline| Template)?):[ \t]*\S/gm)].length
@@ -118,7 +115,6 @@ function getScenarioCount (source) {
  *
  * @param {object} input generated source input
  * @param {string} input.testName generated scenario name
- * @returns {string} canonical generated feature source
  */
 function getGeneratedTestContent ({ testName }) {
   return [
@@ -132,7 +128,6 @@ function getGeneratedTestContent ({ testName }) {
 /**
  * Returns the validator-owned Cucumber step definitions shared by generated scenarios.
  *
- * @returns {string} canonical generated step-definition source
  */
 function getGeneratedStepsContent () {
   return [
@@ -154,7 +149,6 @@ function getGeneratedStepsContent () {
  * Returns the generated Cucumber step-definition path for a feature directory.
  *
  * @param {string} testDirectory generated feature directory
- * @returns {string} generated step-definition path
  */
 function getGeneratedStepsPath (testDirectory) {
   return path.join(testDirectory, GENERATED_STEPS_FILENAME)

package/ci/test-optimization-validation/framework-adapters/cypress.js

@@ -11,7 +11,6 @@ const TEST_FILE_PATTERN = /(?:\.cy\.[cm]?[jt]sx?|\.(?:spec|test)\.[cm]?[jt]sx?)$
  * @param {string} filename candidate filename
  * @param {string} directory candidate parent directory
  * @param {string} projectRoot detected project root
- * @returns {boolean} whether the candidate can be selected by Cypress
  */
 function isTestFile (filename, directory, projectRoot) {
   if (/\.cy\.[cm]?[jt]sx?$/.test(filename)) return true
@@ -25,7 +24,6 @@ function isTestFile (filename, directory, projectRoot) {
  * Returns the complete suffix that a generated Cypress spec must preserve.
  *
  * @param {string} filename representative Cypress spec
- * @returns {string} generated spec suffix
  */
 function getTestExtension (filename) {
   return TEST_FILE_PATTERN.exec(path.basename(filename))?.[0] || '.cy.js'
@@ -37,7 +35,6 @@ function getTestExtension (filename) {
  * @param {object} input generated source input
  * @param {string} input.scenarioId generated scenario id
  * @param {string} input.testName generated test name
- * @returns {string} canonical generated Cypress source
  */
 function getGeneratedTestContent ({ scenarioId, testName }) {
   let content = ''

package/ci/test-optimization-validation/framework-adapters/playwright.js

@@ -14,7 +14,6 @@ const PLAYWRIGHT_PACKAGE = '@playwright/test'
  * @param {string} filename candidate filename
  * @param {string} directory candidate parent directory
  * @param {string} projectRoot detected project root
- * @returns {boolean} whether the candidate can be selected by Playwright Test
  */
 function isTestFile (filename, directory, projectRoot) {
   if (!TEST_FILE_PATTERN.test(filename)) return false
@@ -26,7 +25,6 @@ function isTestFile (filename, directory, projectRoot) {
  * Returns the complete suffix that a generated Playwright spec must preserve.
  *
  * @param {string} filename representative Playwright spec
- * @returns {string} generated spec suffix
  */
 function getTestExtension (filename) {
   return TEST_FILE_PATTERN.exec(path.basename(filename))?.[0] || '.spec.js'
@@ -39,7 +37,6 @@ function getTestExtension (filename) {
  * @param {string} input.moduleSystem generated module system
  * @param {string} input.scenarioId generated scenario id
  * @param {string} input.testName generated test name
- * @returns {string} canonical generated Playwright source
  */
 function getGeneratedTestContent ({ moduleSystem, scenarioId, testName }) {
   const assertion = scenarioId === 'atr-fail-once'
@@ -60,7 +57,6 @@ function getGeneratedTestContent ({ moduleSystem, scenarioId, testName }) {
 /**
  * Returns the isolated Playwright config shared by generated validation tests.
  *
- * @returns {string} canonical generated Playwright config
  */
 function getGeneratedConfigContent () {
   return [
@@ -81,7 +77,6 @@ function getGeneratedConfigContent () {
  * Returns the generated Playwright config path for a test directory.
  *
  * @param {string} testDirectory generated test directory
- * @returns {string} generated config path
  */
 function getGeneratedConfigPath (testDirectory) {
   return path.join(testDirectory, GENERATED_CONFIG_FILENAME)
@@ -125,7 +120,6 @@ function getGeneratedTestArgs (filename, configFile) {
  * Returns the validator-owned Playwright output directory for a selected spec.
  *
  * @param {string} filename selected or generated Playwright spec
- * @returns {string} absolute output directory
  */
 function getOutputPath (filename) {
   return path.join(path.dirname(filename), VALIDATION_OUTPUT_DIRECTORY)

package/ci/test-optimization-validation/framework-adapters/vitest.js

@@ -208,7 +208,6 @@ function getProjectObject (source, nameIndex, workspaceConfig) {
  *
  * @param {string} source Vitest configuration source
  * @param {{end: number, start: number}} range candidate object range
- * @returns {boolean} whether the object is a standalone project
  */
 function isStandaloneProjectObject (source, range) {
   const before = maskJavaScriptNonCode(source.slice(0, range.start))
@@ -222,7 +221,6 @@ function isStandaloneProjectObject (source, range) {
  * @param {string} source Vitest configuration source
  * @param {{end: number, start: number}} range candidate object range
  * @param {{end: number, start: number}[]} objectRanges source object ranges
- * @returns {boolean} whether the object is a bounded project entry
  */
 function isTestProjectsEntry (source, range, objectRanges) {
   const projectsArray = getDirectContainingArray(source, range)
@@ -253,7 +251,6 @@ function isTestProjectsEntry (source, range, objectRanges) {
  *
  * @param {string} source Vitest configuration source
  * @param {{end: number, start: number}} range candidate config object range
- * @returns {boolean} whether the object belongs to the exported configuration
  */
 function isExportedConfigObject (source, range) {
   const before = maskJavaScriptNonCode(source.slice(0, range.start))
@@ -267,7 +264,6 @@ function isExportedConfigObject (source, range) {
  *
  * @param {string} source Vitest workspace configuration source
  * @param {{end: number, start: number}} range candidate object range
- * @returns {boolean} whether the object is a bounded workspace project entry
  */
 function isWorkspaceProjectEntry (source, range) {
   const workspaceArray = getDirectContainingArray(source, range)

package/ci/test-optimization-validation/generated-test-contract.js

@@ -32,7 +32,6 @@ const GENERATED_SCENARIOS = {
  *
  * @param {string} framework test framework
  * @param {string} filename generated ATR test file
- * @returns {string} retry-state path
  */
 function getGeneratedRetryStatePath (framework, filename) {
   const namespace = `dd-test-optimization-validation-${framework}-`
@@ -52,7 +51,6 @@ function getGeneratedRetryStatePath (framework, filename) {
  * @param {string} input.moduleSystem generated module system
  * @param {string} input.scenarioId generated scenario id
  * @param {string} [input.stateFile] persistent ATR state file
- * @returns {string} canonical generated source
  */
 function getGeneratedTestContent ({ framework, moduleSystem, scenarioId, stateFile }) {
   const scenario = GENERATED_SCENARIOS[scenarioId]
@@ -232,7 +230,6 @@ function getGeneratedTestContractError (framework) {
  * Describes adapter-specific files in generated-contract errors.
  *
  * @param {string} framework framework name
- * @returns {string} additional file description
  */
 function getAdditionalGeneratedFileDescription (framework) {
   if (framework === 'cucumber') return ' plus isolated Cucumber step definitions'
@@ -245,7 +242,6 @@ function getAdditionalGeneratedFileDescription (framework) {
  *
  * @param {string} root project root
  * @param {string} filename generated path
- * @returns {boolean} whether the path is contained
  */
 function isPathInside (root, filename) {
   const relative = path.relative(path.resolve(root), path.resolve(filename))
@@ -259,7 +255,6 @@ function isPathInside (root, filename) {
  * @param {string} input.moduleSystem generated module system
  * @param {string} input.assertion passing assertion
  * @param {string} input.stateFile persistent ATR state file
- * @returns {string} retry test body
  */
 function getAtrBody ({ moduleSystem, assertion, stateFile }) {
   if (typeof stateFile !== 'string' || !path.isAbsolute(stateFile)) {

package/ci/test-optimization-validation/generated-verifier.js

@@ -227,7 +227,6 @@ function getGeneratedRuntimeFileStatus (strategy) {
  * Formats a parsed test count for a customer-facing diagnosis.
  *
  * @param {number|null} count observed test count
- * @returns {string} formatted count
  */
 function formatObservedCount (count) {
   return count === null ? 'an unknown test count' : `${count} observed tests`