10 declarations
(raw_config: RawGroConfig): Promise<GroConfig> import {cook_gro_config} from '@fuzdev/gro/gro_config.js'; Transforms a RawGroConfig to the more strict GroConfig.
This allows users to provide a more relaxed config.
Hashes the build_cache_config and deletes the raw value for security.
raw_configPromise<GroConfig>
(): GroConfig import {create_empty_gro_config} from '@fuzdev/gro/gro_config.js'; GroConfig CreateGroConfig import type {CreateGroConfig} from '@fuzdev/gro/gro_config.js'; (call)type (base_config: GroConfig): RawGroConfig | Promise<RawGroConfig>
base_configRawGroConfig | Promise<RawGroConfig>"af1349b9f5f9a1a6a0404dea36dcc9499bcb25c9adc112b7cc9a93cae41f3262" import {EMPTY_BUILD_CACHE_CONFIG_HASH} from '@fuzdev/gro/gro_config.js'; BLAKE3 hash of empty string, used for configs without build_cache_config.
This ensures consistent cache behavior when no custom config is provided.
GroConfig import type {GroConfig} from '@fuzdev/gro/gro_config.js'; The config that users can extend via gro.config.ts.
This is exposed to users in places like tasks and genfiles.
pluginstype (ctx: PluginContext<object>): Plugin<PluginContext<object>>[] | Promise<Plugin<PluginContext<object>>[]>
ctxPluginContext<object>Plugin<PluginContext<object>>[] | Promise<Plugin<PluginContext<object>>[]>see also
map_package_jsonMaps the project's package.json before writing it to the filesystem.
The package_json argument may be mutated, but the return value is what's used by the caller.
Returning null is a no-op for the caller.
type (PackageJsonMapper) | null
task_root_dirsThe root directories to search for tasks given implicit relative input paths.
Defaults to ./src/lib, then the cwd, then the Gro package dist.
type PathId[]
search_filtersWhen searching the filesystem for tasks and genfiles, directories and files are included if they pass all of these filters.
type PathFilter[]
js_cliThe CLI to use that's compatible with node.
type string
pm_cliThe CLI to use that's compatible with npm install and npm link. Defaults to 'npm'.
type string
build_cache_config_hashSHA-256 hash of the user's build_cache_config from gro.config.ts.
This is computed during config normalization and the raw value is immediately deleted.
If no build_cache_config was provided, this is the hash of an empty string.
type string
see also
``RawGroConfig.build_cache_config``
filer_optionsOptions passed to the Filer for file watching and import resolution.
type Partial<FilerOptions> | null
see also
``FilerOptions``
GroConfigModule import type {GroConfigModule} from '@fuzdev/gro/gro_config.js'; defaulttype (CreateGroConfig) | RawGroConfig
(dir?: string): Promise<GroConfig> import {load_gro_config} from '@fuzdev/gro/gro_config.js'; dirstringpaths.rootPromise<GroConfig>
RawGroConfig import type {RawGroConfig} from '@fuzdev/gro/gro_config.js'; plugins?type (ctx: PluginContext<object>): Plugin<PluginContext<object>>[] | Promise<Plugin<PluginContext<object>>[]>
ctxPluginContext<object>Plugin<PluginContext<object>>[] | Promise<Plugin<PluginContext<object>>[]>map_package_json?type (PackageJsonMapper) | null
task_root_dirs?type string[]
search_filters?type (PathFilter) | (PathFilter)[] | null
js_cli?type string
pm_cli?type string
build_cache_config?Optional object defining custom build inputs for cache invalidation. This value is hashed during config normalization and used to detect when builds need to be regenerated due to non-source changes.
Use cases:
{api_url: process.env.PUBLIC_API_URL}{data: fs.readFileSync('data.json', 'utf-8')}{enable_analytics: true}Can be a static object or an async function that returns an object.
IMPORTANT: It's safe to include secrets here because they are hashed and deleted
during config normalization. The raw value is never logged or persisted.
type Record<string, unknown> | (() => Record<string, unknown> | Promise<Record<string, unknown>>)
filer_options?Options passed to the Filer for file watching and import resolution.
type Partial<FilerOptions> | null
see also
``FilerOptions``
RegExp import {SEARCH_EXCLUDER_DEFAULT} from '@fuzdev/gro/gro_config.js'; The regexp used by default to exclude directories and files
when searching the filesystem for tasks and genfiles.
Customize via search_filters in the GroConfig.
See the test cases for the exact behavior.
(config_module: any, config_path: string): asserts config_module is GroConfigModule import {validate_gro_config_module} from '@fuzdev/gro/gro_config.js'; config_moduleanyconfig_pathstringvoid