update doc comments

Author: ryanatkn

src/lib/build_cache.ts

@@ -54,7 +54,7 @@ export type BuildCacheMetadata = z.infer<typeof BuildCacheMetadata>;
  * Computes the cache key components for a build.
  * This determines whether a cached build can be reused.
  *
- * @param config - Gro config (build_cache_config_hash is already computed during config load)
+ * @param config - Gro config (`build_cache_config_hash` is already computed during config load)
  * @param log - Logger
  * @param git_commit - optional pre-computed git commit hash (optimization to avoid re-reading)
  */

src/lib/format_file.ts

@@ -9,7 +9,7 @@ let cached_base_options: prettier.Options | undefined;
  * Formats a file with Prettier.
  * @param content
  * @param options
- * @param base_options - defaults to the the cwd's package.json `prettier` value
+ * @param base_options - defaults to the cwd's `package.json` `prettier` value
  */
 export const format_file = async (
 	content: string,

src/lib/gro_config.ts

@@ -22,7 +22,7 @@ import type {ParsedSvelteConfig} from './svelte_config.ts';
 import type {FilerOptions} from './filer.ts';
 
 /**
- * BLAKE3 hash of empty string, used for configs without build_cache_config.
+ * BLAKE3 hash of empty string, used for configs without `build_cache_config`.
  * This ensures consistent cache behavior when no custom config is provided.
  */
 export const EMPTY_BUILD_CACHE_CONFIG_HASH =
@@ -62,18 +62,18 @@ export interface GroConfig extends RawGroConfig {
 	 * The CLI to use that's compatible with `npm install` and `npm link`. Defaults to `'npm'`.
 	 */
 	pm_cli: string;
-	/** @default SVELTE_CONFIG_FILENAME */
+	/** @default `SVELTE_CONFIG_FILENAME` */
 	svelte_config_filename?: string;
 	/**
 	 * SHA-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.
-	 * @see RawGroConfig.build_cache_config
+	 * @see `RawGroConfig.build_cache_config`
 	 */
 	build_cache_config_hash: string;
 	/**
 	 * Options passed to the `Filer` for file watching and import resolution.
-	 * @see FilerOptions
+	 * @see `FilerOptions`
 	 */
 	filer_options: Partial<FilerOptions> | null;
 }
@@ -110,7 +110,7 @@ export interface RawGroConfig {
 		| (() => Record<string, unknown> | Promise<Record<string, unknown>>);
 	/**
 	 * Options passed to the `Filer` for file watching and import resolution.
-	 * @see FilerOptions
+	 * @see `FilerOptions`
 	 */
 	filer_options?: Partial<FilerOptions> | null;
 }

src/lib/gro_plugin_deno_compile.ts

@@ -4,12 +4,12 @@
  * Runs during the `adapt` phase (production build only).
  * Optionally generates a SHA-256 hash file for verification.
  *
- * To avoid bundling all npm devDependencies from package.json, we:
+ * To avoid bundling all npm devDependencies from `package.json`, we:
  * 1. Extract just the "imports" from root deno.json
  * 2. Rebase relative paths (e.g. `../fuz_app/` → `../../fuz_app/`) since
  *    compilation runs from the output subdirectory
  * 3. Write a minimal deno.json to the output directory
- * 4. Compile from that directory (which has no package.json)
+ * 4. Compile from that directory (which has no `package.json`)
  *
  * @module
  */

src/lib/gro_plugin_deno_server.ts

@@ -44,7 +44,7 @@ export interface GroPluginDenoServerOptions {
 	/**
 	 * Whether to watch for file changes and restart.
 	 * Uses Deno's built-in --watch flag.
-	 * @default true in dev
+	 * @default true in `dev`
 	 */
 	watch?: boolean;
 

src/lib/gro_plugin_server.ts

@@ -67,7 +67,7 @@ export interface GroPluginServerOptions {
 	target?: string;
 	/**
 	 * Optionally map the esbuild options.
-	 * @default identity
+	 * @default `identity`
 	 */
 	esbuild_build_options?: (base_options: esbuild.BuildOptions) => esbuild.BuildOptions;
 	/**
@@ -84,7 +84,7 @@ export interface GroPluginServerOptions {
 	cli_command?: string;
 	/**
 	 * Whether to run the server or not after building.
-	 * @default dev
+	 * @default `dev`
 	 */
 	run?: boolean;
 }

src/lib/package_json.ts

@@ -99,7 +99,7 @@ export const package_json_serialize = (package_json: PackageJson): string =>
 	JSON.stringify(parse_package_json(PackageJson, package_json), null, 2) + '\n';
 
 /**
- * Updates package.json. Writes to the filesystem only when contents change.
+ * Updates `package.json`. Writes to the filesystem only when contents change.
  */
 export const package_json_update = async (
 	update: (package_json: PackageJson) => PackageJson | null | Promise<PackageJson | null>,

src/lib/paths.ts

@@ -85,7 +85,7 @@ export const replace_extension = (path: string, new_extension: string): string =
 };
 
 /**
- * Paths for the user repo.
+ * `Paths` for the user repo.
  */
 export const paths = create_paths(process.cwd());
 
@@ -104,7 +104,7 @@ const gro_package_dir_path = join(
 );
 export const IS_THIS_GRO = gro_package_dir_path === paths.root;
 /**
- * Paths for the Gro package being used by the user repo.
+ * `Paths` for the Gro package being used by the user repo.
  */
 export const gro_paths = IS_THIS_GRO ? paths : create_paths(gro_package_dir_path);
 /** @trailing_slash */

src/lib/plugin.ts

@@ -90,7 +90,7 @@ export class Plugins<TPluginContext extends PluginContext> {
  * Throws if the plugin name cannot be found.
  * @param plugins - accepts the same types as the return value of `PluginsCreateConfig`
  * @param new_plugin
- * @param name - @default new_plugin.name
+ * @param name - @default `new_plugin.name`
  * @returns `plugins` with `new_plugin` at the index of the plugin with `name`
  */
 export const plugin_replace = (

src/lib/sveltekit_helpers.ts

@@ -121,7 +121,7 @@ export interface SveltePackageOptions {
 	i?: string;
 	/**
 	 * The output directory where the processed files are written to.
-	 * Your package.json's exports should point to files inside there,
+	 * Your `package.json`'s exports should point to files inside there,
 	 * and the files array should include that folder.
 	 * Defaults to dist
 	 */