@ryanatkn/gro 0.176.0 → 0.177.0

package/src/lib/filer.ts

@@ -1,20 +1,20 @@
 import {EMPTY_OBJECT} from '@ryanatkn/belt/object.js';
 import {readFileSync, statSync} from 'node:fs';
 import {dirname, resolve} from 'node:path';
-import type {Omit_Strict} from '@ryanatkn/belt/types.js';
+import type {OmitStrict} from '@ryanatkn/belt/types.js';
 import {isBuiltin} from 'node:module';
 import {fileURLToPath, pathToFileURL} from 'node:url';
-import {Unreachable_Error} from '@ryanatkn/belt/error.js';
+import {UnreachableError} from '@ryanatkn/belt/error.js';
 import type {Logger} from '@ryanatkn/belt/log.js';
-import type {Package_Json} from '@ryanatkn/belt/package_json.js';
-import type {File_Filter, Path_Id} from '@ryanatkn/belt/path.js';
+import type {PackageJson} from '@ryanatkn/belt/package_json.js';
+import type {FileFilter, PathId} from '@ryanatkn/belt/path.js';
 
 import {
 	watch_dir,
-	type Watch_Node_Fs,
-	type Watcher_Change,
-	type Watch_Dir_Options,
-	type Watcher_Change_Callback,
+	type WatchNodeFs,
+	type WatcherChange,
+	type WatchDirOptions,
+	type WatcherChangeCallback,
 } from './watch_dir.ts';
 import {paths} from './paths.ts';
 import {parse_imports} from './parse_imports.ts';
@@ -26,32 +26,32 @@ import type {Disknode} from './disknode.ts';
 
 const aliases = Object.entries(default_svelte_config.alias);
 
-export type On_Filer_Change = (change: Watcher_Change, disknode: Disknode) => void;
+export type OnFilerChange = (change: WatcherChange, disknode: Disknode) => void;
 
-export interface Filer_Options {
+export interface FilerOptions {
 	watch_dir?: typeof watch_dir;
-	watch_dir_options?: Partial<Omit_Strict<Watch_Dir_Options, 'on_change'>>;
-	package_json_cache?: Record<string, Package_Json>;
+	watch_dir_options?: Partial<OmitStrict<WatchDirOptions, 'on_change'>>;
+	package_json_cache?: Record<string, PackageJson>;
 	log?: Logger;
 }
 
 export class Filer {
-	readonly root_dir: Path_Id;
+	readonly root_dir: PathId;
 
 	// TODO rename everything to `disknode`
-	readonly files: Map<Path_Id, Disknode> = new Map();
+	readonly files: Map<PathId, Disknode> = new Map();
 
 	#watch_dir: typeof watch_dir;
-	#watch_dir_options: Partial<Watch_Dir_Options>;
+	#watch_dir_options: Partial<WatchDirOptions>;
 
 	#log?: Logger;
 
-	#listeners: Set<On_Filer_Change> = new Set();
-	#watching: Watch_Node_Fs | undefined;
+	#listeners: Set<OnFilerChange> = new Set();
+	#watching: WatchNodeFs | undefined;
 	#initing: Promise<void> | undefined;
 	#closing: Promise<void> | undefined;
 
-	constructor(options: Filer_Options = EMPTY_OBJECT) {
+	constructor(options: FilerOptions = EMPTY_OBJECT) {
 		this.#watch_dir = options.watch_dir ?? watch_dir;
 		this.#watch_dir_options = options.watch_dir_options ?? EMPTY_OBJECT;
 		this.root_dir = resolve(options.watch_dir_options?.dir ?? paths.source);
@@ -65,11 +65,11 @@ export class Filer {
 		return this.#watching !== undefined;
 	}
 
-	get_by_id = (id: Path_Id): Disknode | undefined => {
+	get_by_id = (id: PathId): Disknode | undefined => {
 		return this.files.get(id);
 	};
 
-	get_or_create = (id: Path_Id): Disknode => {
+	get_or_create = (id: PathId): Disknode => {
 		const existing = this.get_by_id(id);
 		if (existing) return existing;
 		const file: Disknode = {
@@ -155,7 +155,7 @@ export class Filer {
 		}
 	}
 
-	async watch(listener: On_Filer_Change): Promise<() => void> {
+	async watch(listener: OnFilerChange): Promise<() => void> {
 		await this.#add_listener(listener);
 		return () => {
 			this.#remove_listener(listener);
@@ -214,7 +214,7 @@ export class Filer {
 		this.#cleanup();
 	}
 
-	#update(id: Path_Id): Disknode | null {
+	#update(id: PathId): Disknode | null {
 		const file = this.get_or_create(id);
 
 		let stats: ReturnType<typeof statSync> | null = null;
@@ -284,7 +284,7 @@ export class Filer {
 		return file;
 	}
 
-	#remove(id: Path_Id): Disknode | null {
+	#remove(id: PathId): Disknode | null {
 		const file = this.get_by_id(id);
 		if (!file) return null; // this is safe because the object would exist if any other file referenced it as a dependency or dependent
 
@@ -300,7 +300,7 @@ export class Filer {
 		return file;
 	}
 
-	#sync_listener_with_files(listener: On_Filer_Change): void {
+	#sync_listener_with_files(listener: OnFilerChange): void {
 		for (const disknode of this.files.values()) {
 			try {
 				listener({type: 'add', path: disknode.id, is_directory: false}, disknode);
@@ -310,7 +310,7 @@ export class Filer {
 		}
 	}
 
-	#notify_change(change: Watcher_Change, disknode: Disknode): void {
+	#notify_change(change: WatcherChange, disknode: Disknode): void {
 		for (const listener of this.#listeners) {
 			try {
 				listener(change, disknode);
@@ -320,7 +320,7 @@ export class Filer {
 		}
 	}
 
-	async #add_listener(listener: On_Filer_Change): Promise<void> {
+	async #add_listener(listener: OnFilerChange): Promise<void> {
 		this.#listeners.add(listener);
 
 		// ensure initialized
@@ -330,12 +330,12 @@ export class Filer {
 		this.#sync_listener_with_files(listener);
 	}
 
-	#remove_listener(listener: On_Filer_Change): void {
+	#remove_listener(listener: OnFilerChange): void {
 		this.#listeners.delete(listener);
 		// keep watching active even with no listeners, only close() tears down
 	}
 
-	#on_change: Watcher_Change_Callback = (change) => {
+	#on_change: WatcherChangeCallback = (change) => {
 		if (this.#closing) return; // ignore changes during close
 		if (change.is_directory) return; // TODO manage directories?
 		let disknode: Disknode | null;
@@ -350,14 +350,14 @@ export class Filer {
 				break;
 			}
 			default:
-				throw new Unreachable_Error(change.type);
+				throw new UnreachableError(change.type);
 		}
 		if (disknode && this.#listeners.size > 0) {
 			this.#notify_change(change, disknode);
 		}
 	};
 
-	#is_external(id: Path_Id): boolean {
+	#is_external(id: PathId): boolean {
 		const {filter} = this.#watch_dir_options;
 		return !id.startsWith(this.root_dir + '/') || (!!filter && !filter(id, false));
 	}
@@ -366,12 +366,12 @@ export class Filer {
 // TODO maybe `Disknode` class?
 export const filter_dependents = (
 	disknode: Disknode,
-	get_by_id: (id: Path_Id) => Disknode | undefined,
-	filter?: File_Filter,
-	results: Set<Path_Id> = new Set(),
-	searched: Set<Path_Id> = new Set(),
+	get_by_id: (id: PathId) => Disknode | undefined,
+	filter?: FileFilter,
+	results: Set<PathId> = new Set(),
+	searched: Set<PathId> = new Set(),
 	log?: Logger,
-): Set<Path_Id> => {
+): Set<PathId> => {
 	const {dependents} = disknode;
 	for (const dependent_id of dependents.keys()) {
 		if (searched.has(dependent_id)) continue;

package/src/lib/format.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 {format_directory} from './format_directory.ts';
 import {paths} from './paths.ts';
 
@@ -31,7 +31,7 @@ export const task: Task<Args> = {
 			config.pm_cli,
 		);
 		if (!format_result.ok) {
-			throw new Task_Error(
+			throw new TaskError(
 				`Failed ${check ? 'formatting check' : 'to format'}. ${print_spawn_result(format_result)}`,
 			);
 		}

package/src/lib/format_directory.ts

@@ -1,4 +1,4 @@
-import type {Spawn_Result} from '@ryanatkn/belt/process.js';
+import type {SpawnResult} from '@ryanatkn/belt/process.js';
 import type {Logger} from '@ryanatkn/belt/log.js';
 
 import {paths} from './paths.ts';
@@ -39,7 +39,7 @@ export const format_directory = async (
 	root_paths = ROOT_PATHS_DEFAULT,
 	prettier_cli: string | Cli = PRETTIER_CLI_DEFAULT,
 	pm_cli: string = PM_CLI_DEFAULT,
-): Promise<Spawn_Result> => {
+): Promise<SpawnResult> => {
 	const forwarded_args = to_forwarded_args(to_cli_name(prettier_cli));
 	forwarded_args[check ? 'check' : 'write'] = true;
 	const serialized_args = serialize_args(forwarded_args);

package/src/lib/gen.task.ts

@@ -3,9 +3,9 @@ import {print_ms, print_error} from '@ryanatkn/belt/print.js';
 import {plural} from '@ryanatkn/belt/string.js';
 import {z} from 'zod';
 
-import {Task_Error, type Task} from './task.ts';
+import {TaskError, type Task} from './task.ts';
 import {run_gen} from './run_gen.ts';
-import {Raw_Input_Path, to_input_paths} from './input_path.ts';
+import {RawInputPath, to_input_paths} from './input_path.ts';
 import {format_file} from './format_file.ts';
 import {print_path} from './paths.ts';
 import {log_error_reasons} from './task_logging.ts';
@@ -14,20 +14,20 @@ import {
 	analyze_gen_results,
 	find_genfiles,
 	load_genfiles,
-	type Analyzed_Gen_Result,
-	type Gen_Results,
+	type AnalyzedGenResult,
+	type GenResults,
 } from './gen.ts';
 import {SOURCE_DIRNAME} from './constants.ts';
 
 /** @nodocs */
 export const Args = z.strictObject({
 	_: z
-		.array(Raw_Input_Path)
+		.array(RawInputPath)
 		.meta({description: 'input paths to generate'})
 		.default([SOURCE_DIRNAME]),
 	root_dirs: z
 		.array(z.string())
-		.meta({description: 'root directories to resolve input paths against'}) // TODO `Path_Id` schema
+		.meta({description: 'root directories to resolve input paths against'}) // TODO `PathId` schema
 		.default([process.cwd()]),
 	check: z
 		.boolean()
@@ -54,7 +54,7 @@ export const task: Task<Args> = {
 				return;
 			} else {
 				log_error_reasons(log, found.reasons);
-				throw new Task_Error('Failed to find gen modules.');
+				throw new TaskError('Failed to find gen modules.');
 			}
 		}
 		const found_genfiles = found.value;
@@ -65,7 +65,7 @@ export const task: Task<Args> = {
 		const loaded = await load_genfiles(found_genfiles, timings);
 		if (!loaded.ok) {
 			log_error_reasons(log, loaded.reasons);
-			throw new Task_Error('Failed to load gen modules.');
+			throw new TaskError('Failed to load gen modules.');
 		}
 		const loaded_genfiles = loaded.value;
 
@@ -106,7 +106,7 @@ export const task: Task<Args> = {
 					);
 				}
 				if (has_unexpected_changes) {
-					throw new Task_Error(
+					throw new TaskError(
 						'Failed gen check. Some generated files have unexpectedly changed.' +
 							' Run `gro gen` and try again.',
 					);
@@ -135,26 +135,26 @@ export const task: Task<Args> = {
 			for (const result of gen_results.failures) {
 				log.error(result.reason, '\n', print_error(result.error));
 			}
-			throw new Task_Error(`Failed to generate ${fail_count} file${plural(fail_count)}.`);
+			throw new TaskError(`Failed to generate ${fail_count} file${plural(fail_count)}.`);
 		}
 	},
 };
 
-interface Gen_Status {
+interface GenStatus {
 	symbol: string;
 	color: Parameters<typeof st>[0];
 	text: string;
 }
 
-const format_gen_status = (analyzed: Analyzed_Gen_Result | undefined): Gen_Status => {
+const format_gen_status = (analyzed: AnalyzedGenResult | undefined): GenStatus => {
 	if (!analyzed) return {symbol: '?', color: 'gray', text: 'unknown'};
 	if (analyzed.is_new) return {symbol: '●', color: 'green', text: 'new'};
 	if (analyzed.has_changed) return {symbol: '◐', color: 'cyan', text: 'changed'};
 	return {symbol: '○', color: 'gray', text: 'unchanged'};
 };
 
-interface Output_Line {
-	status: Gen_Status;
+interface OutputLine {
+	status: GenStatus;
 	elapsed: string;
 	source: string;
 	target: string;
@@ -162,10 +162,10 @@ interface Output_Line {
 }
 
 const collect_output_lines = (
-	gen_results: Gen_Results,
-	analyzed_gen_results: Array<Analyzed_Gen_Result>,
-): Array<Output_Line> => {
-	const output_lines: Array<Output_Line> = [];
+	gen_results: GenResults,
+	analyzed_gen_results: Array<AnalyzedGenResult>,
+): Array<OutputLine> => {
+	const output_lines: Array<OutputLine> = [];
 
 	for (const result of gen_results.results) {
 		if (result.ok) {
@@ -193,7 +193,7 @@ const collect_output_lines = (
 	return output_lines;
 };
 
-const format_gen_output = (output_lines: Array<Output_Line>): string => {
+const format_gen_output = (output_lines: Array<OutputLine>): string => {
 	// calculate column widths for alignment
 	const max_elapsed_length = Math.max(...output_lines.map((l) => l.elapsed.length));
 	const max_source_length = Math.max(...output_lines.map((l) => l.source.length));