Cucumber now creates whatever directories are necessary to make a report

CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
-
+- Formatters create sub-directory automatically instead of failing ([#2266](https://github.com/cucumber/cucumber-js/pull/2266))
 ## [9.0.1] - 2023-03-15
 ### Fixed
 - Ensure feature paths are properly deduplicated ([#2258](https://github.com/cucumber/cucumber-js/pull/2258))

docs/formatters.md

@@ -16,7 +16,7 @@ For each value you provide, `TYPE` should be one of:
 * A relative path to a local formatter implementation e.g. `./my-customer-formatter.js`
 * An absolute path to a local formatter implementation in the form of a `file://` URL
 
-If `PATH` is supplied, the formatter prints to the given file, otherwise it prints to `stdout`.
+If `PATH` is supplied, the formatter prints to the given file, otherwise it prints to `stdout`. If the path includes directories that do not yet exist they will be created.
 
 For example, this configuration would give you a progress bar as you run, plus JSON and HTML report files:
 
@@ -30,7 +30,7 @@ Some notes on specifying Formatters:
 
 ## Options
 
-Many formatters, including the built-in ones, support some configurability via options. You can provide this data as an object literal via the `formatOptions` configuration option, like this:
+Many formatters, including the built-in ones, support some configuration via options. You can provide this data as an object literal via the `formatOptions` configuration option, like this:
 
 - In a configuration file `{ formatOptions: { someOption: true } }`
 - On the CLI `$ cucumber-js --format-options '{"someOption":true}'`

features/formatter_paths.feature

@@ -33,10 +33,12 @@ Feature: Formatter Paths
       <duration-stat>
       """
 
-  Scenario: Invalid path
-    When I run cucumber-js with `-f summary:invalid/summary.txt`
-    Then it fails
-    And the error output contains the text:
+  Scenario: Created relative path
+    When I run cucumber-js with `-f summary:some/long/path/for/reports/summary.txt`
+    Then the file "some/long/path/for/reports/summary.txt" has the text:
       """
-      ENOENT
+      1 scenario (1 passed)
+      1 step (1 passed)
+      <duration-stat>
       """
+

package.json

@@ -232,6 +232,7 @@
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
     "luxon": "3.2.1",
+    "mkdirp": "^2.1.5",
     "mz": "^2.7.0",
     "progress": "^2.0.3",
     "resolve-pkg": "^2.0.0",

src/api/formatters.ts

@@ -9,6 +9,7 @@ import fs from 'mz/fs'
 import path from 'path'
 import { IRunOptionsFormats } from './types'
 import { ILogger } from '../logger'
+import { mkdirp } from 'mkdirp'
 
 export async function initializeFormatters({
   env,
@@ -70,12 +71,28 @@ export async function initializeFormatters({
     await initializeFormatter(stdout, 'stdout', configuration.stdout)
   )
 
-  for (const [target, type] of Object.entries(configuration.files)) {
-    const stream: IFormatterStream = fs.createWriteStream(null, {
-      fd: await fs.open(path.resolve(cwd, target), 'w'),
-    })
-    formatters.push(await initializeFormatter(stream, target, type))
-  }
+  const streamPromises: Promise<void>[] = []
+
+  Object.entries(configuration.files).forEach(([target, type]) => {
+    streamPromises.push(
+      (async (target, type) => {
+        const absoluteTarget = path.resolve(cwd, target)
+
+        try {
+          await mkdirp(path.dirname(absoluteTarget))
+        } catch (error) {
+          logger.warn('Failed to ensure directory for formatter target exists')
+        }
+
+        const stream: IFormatterStream = fs.createWriteStream(null, {
+          fd: await fs.open(absoluteTarget, 'w'),
+        })
+        formatters.push(await initializeFormatter(stream, target, type))
+      })(target, type)
+    )
+  })
+
+  await Promise.all(streamPromises)
 
   return async function () {
     await Promise.all(formatters.map(async (f) => await f.finished()))

src/formatter/builder.ts

@@ -102,13 +102,13 @@ const FormatterBuilder = {
     descriptor: string,
     cwd: string
   ) {
-    let normalised: URL | string = descriptor
+    let normalized: URL | string = descriptor
     if (descriptor.startsWith('.')) {
-      normalised = pathToFileURL(path.resolve(cwd, descriptor))
+      normalized = pathToFileURL(path.resolve(cwd, descriptor))
     } else if (descriptor.startsWith('file://')) {
-      normalised = new URL(descriptor)
+      normalized = new URL(descriptor)
     }
-    let CustomClass = await FormatterBuilder.loadFile(normalised)
+    let CustomClass = await FormatterBuilder.loadFile(normalized)
     CustomClass = FormatterBuilder.resolveConstructor(CustomClass)
     if (doesHaveValue(CustomClass)) {
       return CustomClass