11 declarations
(raw_config: RawGroConfig): Promise<GroConfig> 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 GroConfig CreateGroConfig "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" SHA-256 hash of empty string, used for configs without build_cache_config. This ensures consistent cache behavior when no custom config is provided.
RegExp GroConfig The config that users can extend via gro.config.ts.
This is exposed to users in places like tasks and genfiles.
pluginsmap_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.
PackageJsonMapper | nulltask_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.
Array<PathId>search_filtersWhen searching the filsystem for tasks and genfiles, directories and files are included if they pass all of these filters.
Array<PathFilter>js_cliThe CLI to use that's compatible with node.
stringpm_cliThe CLI to use that's compatible with npm install and npm link. Defaults to 'npm'.
stringsvelte_config_filenamestringbuild_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.
stringGroConfigModule defaultRawGroConfig | CreateGroConfig(dir?: string): Promise<GroConfig> dirstringpaths.rootPromise<GroConfig> RawGroConfig pluginsmap_package_jsonPackageJsonMapper | nulltask_root_dirsArray<string>search_filtersPathFilter | Array<PathFilter> | nulljs_clistringpm_clistringbuild_cache_configOptional 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:
- Environment variables baked into build: {api_url: process.env.PUBLIC_API_URL}
- External data files: {data: fs.readFileSync('data.json', 'utf-8')}
- Build feature flags: {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.
| Record<string, unknown>
| (() => Record<string, unknown> | Promise<Record<string, unknown>>)RegExp 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 config_moduleanyconfig_pathstringvoid