/** * @typedef {import('./parse-config').WPRootConfig} WPRootConfig * @typedef {import('./parse-config').WPEnvironmentConfig} WPEnvironmentConfig */ /** * wp-env configuration. * * @typedef WPConfig * @property {string} name Name of the environment. * @property {string} configDirectoryPath Path to the .wp-env.json file. * @property {string} workDirectoryPath Path to the work directory located in ~/.wp-env. * @property {string} dockerComposeConfigPath Path to the docker-compose.yml file. * @property {boolean} detectedLocalConfig If true, wp-env detected local config and used it. * @property {Object.} lifecycleScripts Any lifecycle scripts that we might need to execute. * @property {Object.} env Specific config for different environments. * @property {boolean} debug True if debug mode is enabled. */ /** * Loads any configuration from a given directory. * * @param {string} configDirectoryPath The directory we want to load the config from. * * @return {WPConfig} The config object we've loaded. */ export default function loadConfig(configDirectoryPath: string): WPConfig; export type WPRootConfig = import("./parse-config").WPRootConfig; export type WPEnvironmentConfig = import("./parse-config").WPEnvironmentConfig; /** * wp-env configuration. */ export type WPConfig = { /** * Name of the environment. */ name: string; /** * Path to the .wp-env.json file. */ configDirectoryPath: string; /** * Path to the work directory located in ~/.wp-env. */ workDirectoryPath: string; /** * Path to the docker-compose.yml file. */ dockerComposeConfigPath: string; /** * If true, wp-env detected local config and used it. */ detectedLocalConfig: boolean; /** * Any lifecycle scripts that we might need to execute. */ lifecycleScripts: { [x: string]: string; }; /** * Specific config for different environments. */ env: { [x: string]: import("./parse-config.js").WPEnvironmentConfig; }; /** * True if debug mode is enabled. */ debug: boolean; };