feat(types): export CurrentsConfig for typed config files

chore: release v1.12.1

Author: ynahmany

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": false
+}

packages/cypress-cloud/index.ts

@@ -2,6 +2,7 @@
 import "source-map-support/register.js";
 
 import { run as internalRun } from "./lib/run";
+export type { CurrentsConfig } from "./lib/config/config";
 import { CurrentsRunAPI } from "./types";
 export type { CurrentsRunAPI } from "./types";
 /**

packages/cypress-cloud/lib/config/config.ts

@@ -18,6 +18,14 @@ export type ComponentConfig = {
 type RetryConfig = {
   hardFailureMaxRetries: number;
 };
+
+/**
+ * This is the type for `currents.config.*s`. If you are not officially using TypeScript,
+ * you can still type the exported config in your IDE by adding the following as a block comment
+ * above `module.exports` / `export default`:
+ *
+ * `@type {import('cypress-cloud').CurrentsConfig}`
+ */
 export type CurrentsConfig = {
   projectId?: string;
   recordKey?: string;
@@ -43,7 +51,7 @@ const defaultConfig: CurrentsConfig = {
 
 export async function getCurrentsConfig(
   projectRoot?: string,
-  explicitConfigFilePath?: string
+  explicitConfigFilePath?: string,
 ): Promise<CurrentsConfig> {
   if (_config) {
     return _config;
@@ -70,7 +78,7 @@ export async function getCurrentsConfig(
 
   warn(
     "Failed to load config file, falling back to the default config. Attempted locations: %s",
-    configFilePath
+    configFilePath,
   );
   _config = defaultConfig;
   return _config;

packages/cypress-cloud/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-cloud",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "main": "./dist/index.js",
   "author": "Currents Software Inc",
   "homepage": "https://github.com/currents-dev/cypress-cloud",