@ryanatkn/gro 0.176.0 → 0.177.0

package/src/lib/task_logging.ts

@@ -4,11 +4,11 @@ import {plural} from '@ryanatkn/belt/string.js';
 import {print_value} from '@ryanatkn/belt/print.js';
 import {z} from 'zod';
 
-import type {Arg_Schema} from './args.ts';
-import type {Loaded_Tasks, Task_Module_Meta} from './task.ts';
+import type {ArgSchema} from './args.ts';
+import type {LoadedTasks, TaskModuleMeta} from './task.ts';
 import {print_path} from './paths.ts';
 
-export const log_tasks = (log: Logger, loaded_tasks: Loaded_Tasks, log_intro = true): void => {
+export const log_tasks = (log: Logger, loaded_tasks: LoadedTasks, log_intro = true): void => {
 	const {modules, found_tasks} = loaded_tasks;
 	const {resolved_input_files_by_root_dir} = found_tasks;
 
@@ -52,7 +52,7 @@ export const log_error_reasons = (log: Logger, reasons: Array<string>): void =>
 
 const ARGS_PROPERTY_NAME = '[...args]';
 
-export const log_task_help = (log: Logger, meta: Task_Module_Meta): void => {
+export const log_task_help = (log: Logger, meta: TaskModuleMeta): void => {
 	const {
 		name,
 		mod: {task},
@@ -92,17 +92,17 @@ export const log_task_help = (log: Logger, meta: Task_Module_Meta): void => {
 // The following Zod helpers only need to support single-depth schemas for CLI args,
 // but there's generic recursion to handle things like `ZodOptional` and `ZodDefault`.
 
-interface Arg_Schema_Property {
+interface ArgSchemaProperty {
 	name: string;
-	schema: Arg_Schema;
+	schema: ArgSchema;
 }
 
 // TODO this blocks many usecases like unions, and it's only implemented for CLI arg types, need better support for arbitrary schemas
 const to_arg_properties = (
 	schema: z.ZodType,
-	meta: Task_Module_Meta,
+	meta: TaskModuleMeta,
 	log: Logger,
-): Array<Arg_Schema_Property> => {
+): Array<ArgSchemaProperty> => {
 	const {def} = schema;
 
 	// TODO overly restrictive, support optional objects and/or unions?
@@ -112,11 +112,11 @@ const to_arg_properties = (
 	}
 	const shape = (def as z.core.$ZodObjectDef).shape;
 
-	const properties: Array<Arg_Schema_Property> = [];
+	const properties: Array<ArgSchemaProperty> = [];
 	for (const name in shape) {
 		if ('no-' + name in shape) continue;
 		const s = shape[name] as z.ZodType;
-		const schema: Arg_Schema = {
+		const schema: ArgSchema = {
 			type: to_args_schema_type(s),
 			description: to_args_schema_description(s) || '',
 			default: to_args_schema_default(s),
@@ -129,7 +129,7 @@ const to_arg_properties = (
 const to_max_length = <T>(items: Array<T>, toString: (item: T) => string) =>
 	items.reduce((max, m) => Math.max(toString(m).length, max), 0);
 
-const to_args_schema_type = (schema: z.ZodType): Arg_Schema['type'] => {
+const to_args_schema_type = (schema: z.ZodType): ArgSchema['type'] => {
 	const {def} = schema._zod;
 	switch (def.type) {
 		case 'string':

package/src/lib/test.task.ts

@@ -1,7 +1,7 @@
 import {z} from 'zod';
 import {spawn_cli} from '@ryanatkn/gro/cli.js';
 
-import {Task_Error, type Task} from './task.ts';
+import {TaskError, type Task} from './task.ts';
 import {find_cli} from './cli.ts';
 import {has_dep} from './package_json.ts';
 import {serialize_args, to_implicit_forwarded_args} from './args.ts';
@@ -31,11 +31,11 @@ export const task: Task<Args> = {
 		const {_: patterns, dir, fail_without_tests, t} = args;
 
 		if (!has_dep(VITEST_CLI)) {
-			throw new Task_Error('no test runner found, install vitest');
+			throw new TaskError('no test runner found, install vitest');
 		}
 
 		if (!find_cli(VITEST_CLI)) {
-			throw new Task_Error('vitest is a dependency but not installed; run `npm i`?');
+			throw new TaskError('vitest is a dependency but not installed; run `npm i`?');
 		}
 
 		const vitest_args = ['run', ...patterns];
@@ -52,7 +52,7 @@ export const task: Task<Args> = {
 
 		const spawned = await spawn_cli(VITEST_CLI, vitest_args);
 		if (!spawned?.ok) {
-			throw new Task_Error(`vitest failed with exit code ${spawned?.code}`);
+			throw new TaskError(`vitest failed with exit code ${spawned?.code}`);
 		}
 	},
 };

package/src/lib/typecheck.task.ts

@@ -1,7 +1,7 @@
 import {print_spawn_result} from '@ryanatkn/belt/process.js';
 import {z} from 'zod';
 
-import {Task_Error, type Task} from './task.ts';
+import {TaskError, type Task} from './task.ts';
 import {serialize_args, to_forwarded_args} from './args.ts';
 import {find_cli, spawn_cli, spawn_cli_process} from './cli.ts';
 import {sveltekit_sync_if_available} from './sveltekit_helpers.ts';
@@ -53,7 +53,7 @@ export const task: Task<Args> = {
 				const svelte_check_result = await spawned.closed;
 
 				if (!svelte_check_result.ok) {
-					throw new Task_Error(`Failed to typecheck. ${print_spawn_result(svelte_check_result)}`);
+					throw new TaskError(`Failed to typecheck. ${print_spawn_result(svelte_check_result)}`);
 				}
 			}
 
@@ -68,12 +68,12 @@ export const task: Task<Args> = {
 			const serialized = serialize_args(forwarded);
 			const svelte_check_result = await spawn_cli(found_typescript_cli, serialized, log);
 			if (!svelte_check_result?.ok) {
-				throw new Task_Error(`Failed to typecheck. ${print_spawn_result(svelte_check_result!)}`);
+				throw new TaskError(`Failed to typecheck. ${print_spawn_result(svelte_check_result!)}`);
 			}
 			return;
 		}
 
-		throw new Task_Error(
+		throw new TaskError(
 			`Failed to typecheck because neither \`${svelte_check_cli}\` nor \`${typescript_cli}\` was found`,
 		);
 	},

package/src/lib/upgrade.task.ts

@@ -1,10 +1,10 @@
 import {spawn} from '@ryanatkn/belt/process.js';
 import {z} from 'zod';
 import {rmSync} from 'node:fs';
-import {Git_Origin, git_pull} from '@ryanatkn/belt/git.js';
+import {GitOrigin, git_pull} from '@ryanatkn/belt/git.js';
 
-import {Task_Error, type Task} from './task.ts';
-import {extract_deps, load_package_json, type Package_Json_Dep} from './package_json.ts';
+import {TaskError, type Task} from './task.ts';
+import {extract_deps, load_package_json, 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';
@@ -22,7 +22,7 @@ export const Args = z.strictObject({
 		})
 		.default([])
 		.transform((v) => (Array.isArray(v) ? v : [v])),
-	origin: Git_Origin.describe('git origin to deploy to').default('origin'),
+	origin: GitOrigin.describe('git origin to deploy to').default('origin'),
 	force: z.boolean().meta({description: 'if true, print out the planned upgrades'}).default(false),
 	pull: z.boolean().meta({description: 'dual of no-pull'}).default(true),
 	'no-pull': z.boolean().meta({description: 'opt out of git pull'}).default(false),
@@ -65,7 +65,7 @@ export const task: Task<Args> = {
 		} = args;
 
 		if (_.length && only.length) {
-			throw new Task_Error('Cannot call `gro upgrade` with both rest args and --only.');
+			throw new TaskError('Cannot call `gro upgrade` with both rest args and --only.');
 		}
 
 		// TODO maybe a different task that pulls and does other things, like `gro ready`
@@ -92,7 +92,7 @@ export const task: Task<Args> = {
 			: all_deps.filter((d) => !_.includes(d.name));
 
 		if (only.length && only.length !== deps.length) {
-			throw new Task_Error(
+			throw new TaskError(
 				`Some deps to upgrade were not found: ${only.filter((o) => !deps.find((d) => d.name === o)).join(', ')}`,
 			);
 		}
@@ -130,7 +130,7 @@ const CUSTOM_TAG_MATCHER = /^[\^~><=]*.+-(.+)/;
 
 // TODO hacky and limited
 // TODO probably want to pass through exact deps as well, e.g. @foo/bar@1
-const to_upgrade_items = (deps: Array<Package_Json_Dep>): Array<string> =>
+const to_upgrade_items = (deps: Array<PackageJsonDep>): Array<string> =>
 	deps.map((dep) => {
 		if (EXACT_VERSION_MATCHER.test(dep.name)) {
 			return dep.name;

package/src/lib/watch_dir.ts

@@ -2,30 +2,30 @@ import {watch, type ChokidarOptions, type FSWatcher, type Matcher} from 'chokida
 import {relative} from 'node:path';
 import {statSync} from 'node:fs';
 import {create_deferred, type Deferred} from '@ryanatkn/belt/async.js';
-import type {Path_Filter} from '@ryanatkn/belt/path.js';
+import type {PathFilter} from '@ryanatkn/belt/path.js';
 import {EMPTY_OBJECT} from '@ryanatkn/belt/object.js';
 
 const TMP_FILE_PATTERN = /\.tmp\./;
 
 // TODO pretty hacky
 
-export interface Watch_Node_Fs {
+export interface WatchNodeFs {
 	init: () => Promise<void>;
 	close: () => Promise<void>;
 }
 
-export interface Watcher_Change {
-	type: Watcher_Change_Type;
+export interface WatcherChange {
+	type: WatcherChangeType;
 	path: string;
 	is_directory: boolean;
 }
-export type Watcher_Change_Type = 'add' | 'update' | 'delete';
-export type Watcher_Change_Callback = (change: Watcher_Change) => void;
+export type WatcherChangeType = 'add' | 'update' | 'delete';
+export type WatcherChangeCallback = (change: WatcherChange) => void;
 
-export interface Watch_Dir_Options {
+export interface WatchDirOptions {
 	dir: string;
-	on_change: Watcher_Change_Callback;
-	filter?: Path_Filter | null | undefined;
+	on_change: WatcherChangeCallback;
+	filter?: PathFilter | null | undefined;
 	chokidar?: ChokidarOptions;
 	/**
 	 * When `false`, returns the `path` relative to `dir`.
@@ -51,7 +51,7 @@ export const watch_dir = ({
 	absolute = true,
 	chokidar,
 	ignored = TMP_FILE_PATTERN,
-}: Watch_Dir_Options): Watch_Node_Fs => {
+}: WatchDirOptions): WatchNodeFs => {
 	let watcher: FSWatcher | undefined;
 	let initing: Deferred<void> | undefined;