@ryanatkn/gro 0.182.0 → 0.184.0

package/src/lib/package_json.ts

@@ -24,9 +24,9 @@ export type PackageJsonMapper = (
 	package_json: PackageJson,
 ) => PackageJson | null | Promise<PackageJson | null>;
 
-export const EMPTY_PACKAGE_JSON: PackageJson = {name: '', version: ''};
+export const PACKAGE_JSON_EMPTY: PackageJson = {name: '', version: ''};
 
-export const load_package_json = async (
+export const package_json_load = async (
 	dir = IS_THIS_GRO ? gro_paths.root : paths.root,
 	cache?: Record<string, PackageJson>,
 	parse = true, // TODO pass `false` here in more places, especially anything perf-sensitive like work on startup
@@ -37,10 +37,10 @@ export const load_package_json = async (
 		return cache[dir]!;
 	}
 	try {
-		package_json = JSON.parse(await load_package_json_contents(dir));
+		package_json = JSON.parse(await package_json_load_contents(dir));
 	} catch (error) {
 		log?.error(st('yellow', `Failed to load package.json in ${dir}`), error);
-		return EMPTY_PACKAGE_JSON;
+		return PACKAGE_JSON_EMPTY;
 	}
 	if (parse) {
 		package_json = parse_package_json(PackageJson, package_json);
@@ -51,7 +51,7 @@ export const load_package_json = async (
 	return package_json;
 };
 
-export const sync_package_json = async (
+export const package_json_sync = async (
 	map_package_json: PackageJsonMapper,
 	log: Logger,
 	write = true,
@@ -60,10 +60,10 @@ export const sync_package_json = async (
 ): Promise<{package_json: PackageJson | null; changed: boolean}> => {
 	const exported_files = await fs_search(exports_dir);
 	const exported_paths = exported_files.map((f) => f.path);
-	const updated = await update_package_json(
+	const updated = await package_json_update(
 		async (package_json) => {
 			if ((await has_sveltekit_library(package_json)).ok) {
-				package_json.exports = to_package_exports(exported_paths);
+				package_json.exports = package_json_to_exports(exported_paths);
 			}
 			const mapped = await map_package_json(package_json);
 			return mapped ? parse_package_json(PackageJson, mapped) : mapped;
@@ -85,43 +85,44 @@ export const sync_package_json = async (
 	return updated;
 };
 
-export const load_gro_package_json = (): Promise<PackageJson> => load_package_json(gro_paths.root);
+export const package_json_load_for_gro = (): Promise<PackageJson> =>
+	package_json_load(gro_paths.root);
 
 // TODO probably make this nullable and make callers handle failures
-const load_package_json_contents = (dir: string): Promise<string> =>
+const package_json_load_contents = (dir: string): Promise<string> =>
 	readFile(join(dir, PACKAGE_JSON_FILENAME), 'utf8');
 
-export const write_package_json = (serialized_package_json: string): Promise<void> =>
+export const package_json_write = (serialized_package_json: string): Promise<void> =>
 	writeFile(join(paths.root, PACKAGE_JSON_FILENAME), serialized_package_json);
 
-export const serialize_package_json = (package_json: PackageJson): string =>
+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.
  */
-export const update_package_json = async (
+export const package_json_update = async (
 	update: (package_json: PackageJson) => PackageJson | null | Promise<PackageJson | null>,
 	dir = paths.root,
 	write = true,
 ): Promise<{package_json: PackageJson | null; changed: boolean}> => {
-	const original_contents = await load_package_json_contents(dir);
+	const original_contents = await package_json_load_contents(dir);
 	const original = JSON.parse(original_contents);
 	const updated = await update(original);
 	if (updated === null) {
 		return {package_json: original, changed: false};
 	}
-	const updated_contents = serialize_package_json(updated);
+	const updated_contents = package_json_serialize(updated);
 	if (updated_contents === original_contents) {
 		return {package_json: original, changed: false};
 	}
-	if (write) await write_package_json(updated_contents);
+	if (write) await package_json_write(updated_contents);
 	return {package_json: updated, changed: true};
 };
 
 const is_index = (path: string): boolean => path === 'index.ts' || path === 'index.js';
 
-export const to_package_exports = (paths: Array<string>): PackageJsonExports => {
+export const package_json_to_exports = (paths: Array<string>): PackageJsonExports => {
 	const has_index = paths.some(is_index);
 	const has_js = paths.some((p) => TS_MATCHER.test(p) || JS_MATCHER.test(p));
 	const has_svelte = paths.some((p) => SVELTE_MATCHER.test(p));
@@ -176,7 +177,7 @@ export const to_package_exports = (paths: Array<string>): PackageJsonExports =>
 
 const IMPORT_PREFIX = './' + SVELTEKIT_DIST_DIRNAME + '/';
 
-export const parse_repo_url = (
+export const package_json_parse_repo_url = (
 	package_json: PackageJson,
 ): {owner: string; repo: string} | undefined => {
 	const {repository} = package_json;
@@ -224,7 +225,7 @@ const parse_or_throw_formatted_error = <T extends z.ZodType>(
 	return parsed.data;
 };
 
-export const has_dep = (dep_name: string, package_json: PackageJson): boolean =>
+export const package_json_has_dependency = (dep_name: string, package_json: PackageJson): boolean =>
 	!!package_json.devDependencies?.[dep_name] ||
 	!!package_json.dependencies?.[dep_name] ||
 	!!package_json.peerDependencies?.[dep_name];
@@ -234,7 +235,9 @@ export interface PackageJsonDep {
 	version: string;
 }
 
-export const extract_deps = (package_json: PackageJson): Array<PackageJsonDep> => {
+export const package_json_extract_dependencies = (
+	package_json: PackageJson,
+): Array<PackageJsonDep> => {
 	const deps_by_name: Map<string, PackageJsonDep> = new Map();
 	// Earlier versions override later ones, so peer deps goes last.
 	const add_deps = (deps: Record<string, string> | undefined) => {

package/src/lib/plugin.ts

@@ -11,7 +11,7 @@ export interface Plugin<TPluginContext extends PluginContext = PluginContext> {
 	teardown?: (ctx: TPluginContext) => void | Promise<void>;
 }
 
-export type CreateConfigPlugins<TPluginContext extends PluginContext = PluginContext> = (
+export type PluginsCreateConfig<TPluginContext extends PluginContext = PluginContext> = (
 	ctx: TPluginContext,
 ) => Array<Plugin<TPluginContext>> | Promise<Array<Plugin<TPluginContext>>>;
 
@@ -88,12 +88,12 @@ export class Plugins<TPluginContext extends PluginContext> {
 /**
  * Replaces a plugin by name in `plugins` without mutating the param.
  * Throws if the plugin name cannot be found.
- * @param plugins - accepts the same types as the return value of `CreateConfigPlugins`
+ * @param plugins - accepts the same types as the return value of `PluginsCreateConfig`
  * @param new_plugin
  * @param name - @default new_plugin.name
  * @returns `plugins` with `new_plugin` at the index of the plugin with `name`
  */
-export const replace_plugin = (
+export const plugin_replace = (
 	plugins: Array<Plugin>,
 	new_plugin: Plugin,
 	name = new_plugin.name,

package/src/lib/publish.task.ts

@@ -12,7 +12,7 @@ import {
 } from '@fuzdev/fuz_util/git.js';
 
 import {TaskError, type Task} from './task.ts';
-import {load_package_json, parse_repo_url} from './package_json.ts';
+import {package_json_load, package_json_parse_repo_url} from './package_json.ts';
 import {find_cli, spawn_cli} from './cli.ts';
 import {has_sveltekit_library} from './sveltekit_helpers.ts';
 import {update_changelog} from './changelog.ts';
@@ -85,7 +85,7 @@ export const task: Task<Args> = {
 			log.info(st('green', 'dry run!'));
 		}
 
-		const package_json = await load_package_json();
+		const package_json = await package_json_load();
 
 		const has_sveltekit_library_result = await has_sveltekit_library(package_json);
 		if (!has_sveltekit_library_result.ok) {
@@ -140,7 +140,7 @@ export const task: Task<Args> = {
 			if (typeof package_json.version !== 'string') {
 				throw new TaskError('Failed to find package.json version');
 			}
-			const parsed_repo_url = parse_repo_url(package_json);
+			const parsed_repo_url = package_json_parse_repo_url(package_json);
 			if (!parsed_repo_url) {
 				throw new TaskError(
 					'package.json `repository` must contain a repo url (and GitHub only for now, sorry),' +
@@ -178,7 +178,7 @@ export const task: Task<Args> = {
 			// The check above ensures gen is updated.
 			await invoke_task('gen');
 
-			const package_json_after_versioning = await load_package_json();
+			const package_json_after_versioning = await package_json_load();
 			version = package_json_after_versioning.version!;
 			if (package_json.version === version) {
 				// The version didn't change.

package/src/lib/release.task.ts

@@ -2,7 +2,7 @@ import {z} from 'zod';
 
 import type {Task} from './task.ts';
 import {has_sveltekit_library, has_sveltekit_app} from './sveltekit_helpers.ts';
-import {load_package_json} from './package_json.ts';
+import {package_json_load} from './package_json.ts';
 
 /** @nodocs */
 export const Args = z.strictObject({});
@@ -13,7 +13,7 @@ export const task: Task<Args> = {
 	summary: 'publish and deploy',
 	Args,
 	run: async ({invoke_task}) => {
-		const package_json = await load_package_json();
+		const package_json = await package_json_load();
 
 		const publish = (await has_sveltekit_library(package_json)).ok;
 		if (publish) {

package/src/lib/source_json.ts

@@ -22,15 +22,10 @@ export const source_json_create = async (
 	SourceJson.parse({
 		name: package_json.name,
 		version: package_json.version,
-		modules: await source_modules_create(package_json.exports, lib_path, log),
+		modules: await source_json_modules_create(package_json.exports, lib_path, log),
 	});
 
-export const source_json_serialize = (source_json: SourceJson): string => {
-	const parsed = SourceJson.parse(source_json);
-	return JSON.stringify(parsed, null, 2) + '\n';
-};
-
-export const source_modules_create = async (
+export const source_json_modules_create = async (
 	exports: PackageJsonExports | undefined,
 	lib_path = paths.lib,
 	log?: Logger,

package/src/lib/sveltekit_helpers.ts

@@ -4,7 +4,7 @@ import {join} from 'node:path';
 import type {PackageJson} from '@fuzdev/fuz_util/package_json.js';
 import {fs_exists} from '@fuzdev/fuz_util/fs.js';
 
-import {has_dep} from './package_json.ts';
+import {package_json_has_dependency} from './package_json.ts';
 import {default_svelte_config, type ParsedSvelteConfig} from './svelte_config.ts';
 import {
 	SVELTE_CONFIG_FILENAME,
@@ -41,7 +41,7 @@ export const has_sveltekit_library = async (
 		return {ok: false, message: `no SvelteKit lib directory found at ${svelte_config.lib_path}`};
 	}
 
-	if (!has_dep(dep_name, package_json)) {
+	if (!package_json_has_dependency(dep_name, package_json)) {
 		return {
 			ok: false,
 			message: `no dependency found in package.json for ${dep_name}`,

package/src/lib/sync.task.ts

@@ -2,7 +2,7 @@ import {z} from 'zod';
 import {spawn} from '@fuzdev/fuz_util/process.js';
 
 import {TaskError, type Task} from './task.ts';
-import {sync_package_json} from './package_json.ts';
+import {package_json_sync} from './package_json.ts';
 import {sveltekit_sync} from './sveltekit_helpers.ts';
 
 /** @nodocs */
@@ -37,7 +37,7 @@ export const task: Task<Args> = {
 		}
 
 		if (package_json && config.map_package_json) {
-			await sync_package_json(config.map_package_json, log);
+			await package_json_sync(config.map_package_json, log);
 		}
 
 		if (gen) {

package/src/lib/test.task.ts

@@ -3,7 +3,7 @@ import {spawn_cli} from '@ryanatkn/gro/cli.js';
 
 import {TaskError, type Task} from './task.ts';
 import {find_cli} from './cli.ts';
-import {has_dep, load_package_json} from './package_json.ts';
+import {package_json_has_dependency, package_json_load} from './package_json.ts';
 import {serialize_args, to_implicit_forwarded_args} from './args.ts';
 import {VITEST_CLI} from './constants.ts';
 import {paths} from './paths.ts';
@@ -30,8 +30,8 @@ export const task: Task<Args> = {
 	run: async ({args}): Promise<void> => {
 		const {_: patterns, dir, fail_without_tests, t} = args;
 
-		const package_json = await load_package_json();
-		if (!has_dep(VITEST_CLI, package_json)) {
+		const package_json = await package_json_load();
+		if (!package_json_has_dependency(VITEST_CLI, package_json)) {
 			throw new TaskError('no test runner found, install vitest');
 		}
 

package/src/lib/upgrade.task.ts

@@ -4,7 +4,11 @@ import {rm} from 'node:fs/promises';
 import {GitOrigin, git_pull} from '@fuzdev/fuz_util/git.js';
 
 import {TaskError, type Task} from './task.ts';
-import {extract_deps, load_package_json, type PackageJsonDep} from './package_json.ts';
+import {
+	package_json_extract_dependencies,
+	package_json_load,
+	type PackageJsonDep,
+} from './package_json.ts';
 import {spawn_cli} from './cli.ts';
 import {serialize_args, to_forwarded_args} from './args.ts';
 import {NODE_MODULES_DIRNAME} from './constants.ts';
@@ -83,9 +87,9 @@ export const task: Task<Args> = {
 			await rm(lockfile_path, {force: true});
 		}
 
-		const package_json = await load_package_json();
+		const package_json = await package_json_load();
 
-		const all_deps = extract_deps(package_json);
+		const all_deps = package_json_extract_dependencies(package_json);
 
 		const deps = only.length
 			? all_deps.filter((d) => only.includes(d.name))