import { ConfigurationFiles } from "@cli-forge/parser";

//#region src/lib/configuration-providers.d.ts
/**
 * A collection of built-in configuration provider factories. These should be invoked and passed to
 * {@link CLI.config} to load configuration from various sources. For custom configuration providers, see
 * https://craigory.dev/cli-forge/api/parser/namespaces/ConfigurationFiles/type-aliases/ConfigurationProvider
 *
 * @example
 * ```typescript
 * import { cli, ConfigurationProviders } from 'cli-forge';
 *
 * cli(...).config(ConfigurationProviders.PackageJson('myConfig'));
 * ```
 */
declare const ConfigurationProviders: {
  /**
   * Load configuration from a package.json file.
   *
   * @param key The key in the package.json file to load as configuration.
   */
  PackageJson<T>(key: string): ConfigurationFiles.ConfigurationProvider<T>;
  /**
   * Load configuration from a JSON file (or files).
   *
   * @param filename The filename (or array of possible filenames) of the JSON file to load.
   *   When an array is provided, each filename gets its own provider wrapped in an aggregate.
   * @param key The key in the JSON file to load as configuration. By default, the entire JSON object is loaded.
   */
  JsonFile<T>(filename: string | string[], key?: string): ConfigurationFiles.AnyConfigProvider<T>;
};
//#endregion
export { ConfigurationProviders };
//# sourceMappingURL=configuration-providers.d.mts.map