Export configuration types (#2598)

Author: davidjgoss

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
+### Added
+- Export configuration types ([#2598](https://github.com/cucumber/cucumber-js/pull/2598))
 
 ## [12.1.0] - 2025-07-19
 ### Added

docs/configuration.md

@@ -71,6 +71,12 @@ module.exports = {
 
 (If you're wondering why the configuration sits within a "default" property, that's to allow for [Profiles](./profiles.md).)
 
+### Type checking
+
+If you want to type check your configuration, we export two types that can help with that:
+- `IProfiles` represents the dictionary of profile names to configuration objects exported for CommonJS
+- `IConfiguration` represents a single configuration object exported with named exports for ESM (`Partial<IConfiguration>` will be more useful in practise)
+
 ## Options
 
 These options can be used in a configuration file (see [above](#files)) or on the [CLI](./cli.md), or both.

exports/root/report.api.md

@@ -203,6 +203,31 @@ declare namespace GherkinDocumentParser {
 // @public (undocumented)
 export const Given: IDefineStep_2;
 
+// @public
+export interface IConfiguration {
+    backtrace: boolean;
+    dryRun: boolean;
+    failFast: boolean;
+    forceExit: boolean;
+    format: Array<string | [string, string?]>;
+    formatOptions: JsonObject;
+    import: string[];
+    language: string;
+    loader: string[];
+    name: string[];
+    order: IPickleOrder;
+    parallel: number;
+    paths: string[];
+    publish: boolean;
+    require: string[];
+    requireModule: string[];
+    retry: number;
+    retryTagFilter: string;
+    strict: boolean;
+    tags: string;
+    worldParameters: JsonObject;
+}
+
 // @public (undocumented)
 export interface IContext<ParametersType = any> {
     // (undocumented)
@@ -257,6 +282,9 @@ interface IGetStepKeywordRequest {
     pickleStep: messages.PickleStep;
 }
 
+// @public
+export type IProfiles = Record<string, Partial<IConfiguration>>;
+
 // @public (undocumented)
 function isFailure(result: messages.TestStepResult, willBeRetried?: boolean): boolean;
 

src/configuration/types.ts

@@ -146,3 +146,9 @@ export interface IConfiguration {
    */
   worldParameters: JsonObject
 }
+
+/**
+ * Collection of named configuration profiles
+ * @public
+ */
+export type IProfiles = Record<string, Partial<IConfiguration>>

src/index.ts

@@ -18,6 +18,9 @@ import { version as _version } from './version'
 // type version as string to avoid tripping api-extractor every release
 export const version = _version as string
 
+// Configuration
+export { IConfiguration, IProfiles } from './configuration'
+
 // Top level
 export { default as supportCodeLibraryBuilder } from './support_code_library_builder'
 export { default as DataTable } from './models/data_table'