fix: add IPublishConfig interface for use in makePublishConfig (#…

…2106)

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
+### Added
+- `IPublishConfig` interface for use in return type of `makePublishConfig` instead of explicit `any` ([#1648](https://github.com/cucumber/cucumber-js/pull/2106))
 
 ## [8.5.1] - 2022-07-28
 ### Fixed

package.json

@@ -100,6 +100,7 @@
     "Łukasz Gandecki <lgandecki@css.edu>",
     "M.P. Korstanje <mpkorstanje@users.noreply.github.com>",
     "mannyluvstacos <mannyis@typingona.computer>",
+    "Manny Pamintuan <mannyis+still@typingona.computer>",
     "Marat Dyatko <vectart@gmail.com>",
     "Marc Burton <marc.burton@first-utility.com>",
     "Marcel Hoyer <mhoyer@pixelplastic.de>",

src/api/convert_configuration.ts

@@ -3,6 +3,7 @@ import {
   isTruthyString,
   OptionSplitter,
 } from '../configuration'
+import { IPublishConfig } from '../formatter/publish'
 import { IRunConfiguration } from './types'
 
 export async function convertConfiguration(
@@ -63,7 +64,7 @@ function convertFormats(
 function makePublishConfig(
   flatConfiguration: IConfiguration,
   env: NodeJS.ProcessEnv
-): any {
+): IPublishConfig | false {
   const enabled = isPublishing(flatConfiguration, env)
   if (!enabled) {
     return false

src/api/types.ts

@@ -3,6 +3,7 @@ import { FormatOptions, IFormatterStream } from '../formatter'
 import { PickleOrder } from '../models/pickle_order'
 import { IRuntimeOptions } from '../runtime'
 import { IConfiguration } from '../configuration'
+import { IPublishConfig } from '../formatter/publish'
 
 /**
  * @public
@@ -109,12 +110,7 @@ export interface IRunOptionsRuntime extends IRuntimeOptions {
 export interface IRunOptionsFormats {
   stdout: string
   files: Record<string, string>
-  publish:
-    | {
-        url?: string
-        token?: string
-      }
-    | false
+  publish: IPublishConfig | false
   options: FormatOptions
 }
 

src/formatter/publish.ts

@@ -1,2 +1,7 @@
+export interface IPublishConfig {
+  url: string
+  token: string
+}
+
 export const DEFAULT_CUCUMBER_PUBLISH_URL =
   'https://messages.cucumber.io/api/reports'