@gtkx/utils 1.0.0-rc.2 → 1.0.0-rc.4

package/src/error/format-child-process-error.ts

@@ -1,15 +1,6 @@
-import { isRecord } from "../predicate/is-record.js";
-import { readStream } from "./error-like.js";
+import { isRecord } from "../predicate/is-record.ts";
+import { readStream } from "./error-like.ts";
 
-/**
- * Combines the `stderr` and `stdout` of a failed child-process error into a single trimmed string.
- *
- * @param error - The child-process error to read output from.
- * @returns The joined output, or `undefined` when neither stream carried any text.
- *
- * @example
- * formatChildProcessError({ stderr: "boom" }); // "boom"
- */
 function formatChildProcessError(error: unknown): string | undefined {
     if (!isRecord(error)) {
         return undefined;

package/src/error/index.ts

@@ -1,3 +1,3 @@
-export { errorMessage } from "./error-message.js";
-export { formatChildProcessError } from "./format-child-process-error.js";
-export { normalizeError } from "./normalize-error.js";
+export { errorMessage } from "./error-message.ts";
+export { formatChildProcessError } from "./format-child-process-error.ts";
+export { normalizeError } from "./normalize-error.ts";

package/src/error/normalize-error.ts

@@ -1,16 +1,6 @@
-import { isErrorLike } from "./error-like.js";
-import { errorMessage } from "./error-message.js";
+import { isErrorLike } from "./error-like.ts";
+import { errorMessage } from "./error-message.ts";
 
-/**
- * Coerces an unknown thrown value into an `Error`, reusing it when it already is one and otherwise
- * wrapping its message while copying any error-like own properties.
- *
- * @param error - The caught value to normalize.
- * @returns The value itself when it is an `Error`, otherwise a new `Error` carrying its message.
- *
- * @example
- * normalizeError("boom"); // Error: boom
- */
 function normalizeError(error: unknown): Error {
     if (Error.isError(error)) {
         return error;

package/src/index.ts

@@ -1,13 +1,12 @@
-export * from "./array/index.js";
-export * from "./class/index.js";
-export * from "./error/index.js";
-export * from "./function/index.js";
-export * from "./log/index.js";
-export * from "./map/index.js";
-export * from "./object/index.js";
-export * from "./predicate/index.js";
-export * from "./process/index.js";
-export * from "./set/index.js";
-export * from "./source/index.js";
-export * from "./string/index.js";
-export * from "./util/index.js";
+export * from "./array/index.ts";
+export * from "./class/index.ts";
+export * from "./error/index.ts";
+export * from "./log/index.ts";
+export * from "./map/index.ts";
+export * from "./object/index.ts";
+export * from "./predicate/index.ts";
+export * from "./process/index.ts";
+export * from "./set/index.ts";
+export * from "./source/index.ts";
+export * from "./string/index.ts";
+export * from "./util/index.ts";

package/src/log/create-logger.ts

@@ -1,16 +1,5 @@
-import { Logger, type LoggerOptions } from "./logger.js";
+import { Logger, type LoggerOptions } from "./logger.ts";
 
-/**
- * Creates a {@link Logger} scoped to the given namespace.
- *
- * @param namespace - Namespace added to the log prefix and matched against debug configuration.
- * @param options - Further logger options, excluding the namespace.
- * @returns A new namespaced logger.
- *
- * @example
- * const log = createLogger("react");
- * log.info("mounted");
- */
 function createLogger(namespace: string, options: Omit<LoggerOptions, "namespace"> = {}): Logger {
     return new Logger({ ...options, namespace });
 }

package/src/log/default-logger.ts

@@ -1,49 +1,23 @@
-import { Logger } from "./logger.js";
+import { Logger } from "./logger.ts";
 
-/**
- * The default namespace-less {@link Logger} backing the module-level {@link info}, {@link warn},
- * {@link error}, and {@link debug} functions.
- */
 const logger: Logger = new Logger();
 
-/**
- * Writes an informational line through the shared {@link logger}.
- *
- * @param message - The message text.
- * @param rest - Extra values appended after the message, formatted for display.
- */
 function info(message: string, ...rest: unknown[]): void {
     logger.info(message, ...rest);
 }
 
-/**
- * Writes a warning line through the shared {@link logger}.
- *
- * @param message - The message text.
- * @param rest - Extra values appended after the message, formatted for display.
- */
 function warn(message: string, ...rest: unknown[]): void {
     logger.warn(message, ...rest);
 }
 
-/**
- * Writes an error line through the shared {@link logger}.
- *
- * @param message - The message text.
- * @param rest - Extra values appended after the message, formatted for display.
- */
 function error(message: string, ...rest: unknown[]): void {
     logger.error(message, ...rest);
 }
 
-/**
- * Writes a debug line through the shared {@link logger} when debug output is enabled.
- *
- * @param message - The message text.
- * @param rest - Extra values appended after the message, formatted for display.
- */
 function debug(message: string, ...rest: unknown[]): void {
     logger.debug(message, ...rest);
 }
 
-export { logger, info, warn, error, debug };
+export { logger, info, warn, error };
+/** @internal */
+export { debug };

package/src/log/index.ts

@@ -1,3 +1,5 @@
-export { createLogger } from "./create-logger.js";
-export { debug, error, info, logger, warn } from "./default-logger.js";
-export { Logger, type LoggerOptions, type OutputStream } from "./logger.js";
+export { createLogger } from "./create-logger.ts";
+export { error, info, logger, warn } from "./default-logger.ts";
+/** @internal */
+export { debug } from "./default-logger.ts";
+export { Logger, type OutputStream } from "./logger.ts";

package/src/log/logger.ts

@@ -2,25 +2,15 @@ import pc from "picocolors";
 
 type Colors = ReturnType<typeof pc.createColors>;
 
-/**
- * Minimal writable-stream shape a {@link Logger} writes formatted lines to.
- */
 type OutputStream = {
     write(chunk: string): unknown;
-    /** Whether the stream is a terminal, used to decide if colored output is emitted. */
     isTTY?: boolean | undefined;
 };
 
-/**
- * Options for constructing a {@link Logger}.
- */
 type LoggerOptions = {
-    /** Namespace appended to the log prefix and matched against debug configuration. */
     namespace?: string | undefined;
-    /** Stream to write log lines to; defaults to `process.stderr`. */
     stream?: OutputStream | undefined;
-    /** Forces debug output on or off; when omitted it is resolved from `--debug` and `GTKX_DEBUG`. */
-    debugEnabled?: boolean | undefined;
+    isDebugEnabled?: boolean | undefined;
 };
 
 const BASE_PREFIX = "[gtkx]";
@@ -69,23 +59,16 @@ function getPrefix(namespace: string | undefined): string {
     return namespace === undefined ? BASE_PREFIX : `[gtkx:${namespace}]`;
 }
 
-/**
- * Writes prefixed, optionally colored log lines to an output stream, with debug lines gated by
- * command-line and environment configuration.
- */
 class Logger {
     private stream: OutputStream;
     private prefix: string;
-    private debugEnabled: boolean;
+    private isDebugEnabled: boolean;
     private colors: Colors;
 
-    /**
-     * @param options - Namespace, target stream, and debug configuration for the logger.
-     */
     constructor(options: LoggerOptions = {}) {
         this.stream = options.stream ?? process.stderr;
         this.prefix = getPrefix(options.namespace);
-        this.debugEnabled = options.debugEnabled ?? isDebugEnabled(options.namespace, process.argv, process.env);
+        this.isDebugEnabled = options.isDebugEnabled ?? isDebugEnabled(options.namespace, process.argv, process.env);
         this.colors = getColors(this.stream);
     }
 
@@ -94,44 +77,20 @@ class Logger {
         this.stream.write(`${this.prefix} ${message}${suffix}\n`);
     }
 
-    /**
-     * Writes an informational line.
-     *
-     * @param message - The message text.
-     * @param rest - Extra values appended after the message, formatted for display.
-     */
     info(message: string, ...rest: unknown[]): void {
         this.write(message, rest);
     }
 
-    /**
-     * Writes a line marked as a warning.
-     *
-     * @param message - The message text.
-     * @param rest - Extra values appended after the message, formatted for display.
-     */
     warn(message: string, ...rest: unknown[]): void {
         this.write(`${this.colors.yellow("warn")} ${message}`, rest);
     }
 
-    /**
-     * Writes a line marked as an error.
-     *
-     * @param message - The message text.
-     * @param rest - Extra values appended after the message, formatted for display.
-     */
     error(message: string, ...rest: unknown[]): void {
         this.write(`${this.colors.red("error")} ${message}`, rest);
     }
 
-    /**
-     * Writes a line only when debug output is enabled for this logger.
-     *
-     * @param message - The message text.
-     * @param rest - Extra values appended after the message, formatted for display.
-     */
     debug(message: string, ...rest: unknown[]): void {
-        if (!this.debugEnabled) {
+        if (!this.isDebugEnabled) {
             return;
         }
 

package/src/map/get-or-insert.ts

@@ -4,21 +4,6 @@ type GetSet<K, V> = {
     has(key: K): boolean;
 };
 
-/**
- * Returns the value stored under `key`, or inserts and returns the value produced by `factory` when
- * the key is absent. Works with both `Map` and `WeakMap`, and caches a computed `undefined` value.
- *
- * @template K - The key type.
- * @template V - The value type.
- * @param map - The `Map` or `WeakMap` to read from and populate.
- * @param key - The key to look up.
- * @param factory - Produces the value to insert when `key` is absent; called at most once.
- * @returns The existing or newly-inserted value.
- *
- * @example
- * const counts = new Map<string, number[]>();
- * getOrInsert(counts, "a", () => []).push(1); // counts is Map { "a" => [1] }
- */
 function getOrInsert<K, V>(map: GetSet<K, V>, key: K, factory: (key: K) => V): V {
     if (map.has(key)) {
         return map.get(key) as V;

package/src/map/index.ts

@@ -1 +1 @@
-export { getOrInsert } from "./get-or-insert.js";
+export { getOrInsert } from "./get-or-insert.ts";

package/src/object/index.ts

@@ -1,3 +1,3 @@
-export { omit } from "./omit.js";
-export { pickBy } from "./pick-by.js";
-export { structuredClone } from "./structured-clone.js";
+export { omit } from "./omit.ts";
+export { pickBy } from "./pick-by.ts";
+export { structuredClone } from "./structured-clone.ts";

package/src/object/omit.ts

@@ -1,15 +1,3 @@
-/**
- * Creates a new object holding every entry of `obj` except the named keys.
- *
- * @template T - The type of the source object.
- * @template K - The keys to leave out.
- * @param obj - The object to copy entries from.
- * @param keys - The keys to leave out of the result.
- * @returns A new object without the named keys.
- *
- * @example
- * omit({ a: 1, b: 2 }, ["a"]); // { b: 2 }
- */
 function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K> {
     const excluded: Set<PropertyKey> = new Set(keys);
     const result: Record<string, unknown> = {};

package/src/object/pick-by.ts

@@ -1,15 +1,3 @@
-/**
- * Creates a new object of the entries of `obj` that satisfy the predicate.
- *
- * @template T - The type of the source object.
- * @param obj - The object to pick entries from.
- * @param shouldPick - Called with each value and key; return `true` to keep the entry.
- * @returns A new object holding only the entries the predicate kept.
- *
- * @example
- * pickBy({ a: 1, b: 2 }, (value) => value > 1); // { b: 2 }
- * pickBy({ a: 1, b: 2 }, (_value, key) => key !== "a"); // { b: 2 }
- */
 function pickBy<T extends Record<string, unknown>>(
     obj: T,
     shouldPick: (value: T[keyof T], key: keyof T) => boolean,

package/src/object/structured-clone.ts

@@ -1,21 +1,5 @@
-import { isPlainObject } from "../predicate/is-plain-object.js";
+import { isPlainObject } from "../predicate/is-plain-object.ts";
 
-/**
- * Recursively copies arrays and plain objects, sharing every other value by reference. The result
- * mirrors exactly the structure `isDeepEqual` traverses, so comparing a value against its earlier
- * clone detects in-place mutations of the original. Unlike the global of the same name, class
- * instances such as `Date` and `Map` are shared rather than copied, and no value is ever rejected.
- *
- * @template T - The type of the value.
- * @param value - The value to clone.
- * @returns A clone whose arrays and plain objects are fresh and whose other values are shared.
- *
- * @example
- * const source = { a: [{ b: 1 }] };
- * const copy = structuredClone(source);
- * source.a[0].b = 2;
- * copy.a[0].b; // 1
- */
 function structuredClone<T>(value: T): T {
     if (Array.isArray(value)) {
         return value.map((item: unknown) => structuredClone(item)) as T;

package/src/predicate/index.ts

@@ -1,6 +1,6 @@
-export { isDeepEqual } from "./is-deep-equal.js";
-export { isPlainObject } from "./is-plain-object.js";
-export { isRecord } from "./is-record.js";
-export { isSameArrayBy } from "./is-same-array-by.js";
-export { isSameArray } from "./is-same-array.js";
-export { isShallowEqual } from "./is-shallow-equal.js";
+export { isDeepEqual } from "./is-deep-equal.ts";
+export { isPlainObject } from "./is-plain-object.ts";
+export { isRecord } from "./is-record.ts";
+export { isSameArrayBy } from "./is-same-array-by.ts";
+export { isSameArray } from "./is-same-array.ts";
+export { isShallowEqual } from "./is-shallow-equal.ts";

package/src/predicate/is-deep-equal.ts

@@ -1,19 +1,6 @@
-import { areObjectKeysEqual } from "./are-object-keys-equal.js";
-import { isPlainObject } from "./is-plain-object.js";
+import { areObjectKeysEqual } from "./are-object-keys-equal.ts";
+import { isPlainObject } from "./is-plain-object.ts";
 
-/**
- * Checks whether two values are deeply equal: identical, arrays of the same length whose elements
- * are deeply equal in order, or plain objects with the same own enumerable keys and deeply equal
- * values. Values that are neither both arrays nor both plain objects are equal only when identical.
- *
- * @param a - The first value.
- * @param b - The second value.
- * @returns `true` when the values are deeply equal.
- *
- * @example
- * isDeepEqual({ a: [1, { b: 2 }] }, { a: [1, { b: 2 }] }); // true
- * isDeepEqual({ a: [1] }, { a: [2] }); // false
- */
 const isDeepArrayEqual = (a: unknown, b: unknown): boolean => {
     if (!Array.isArray(a) || !Array.isArray(b) || a.length !== b.length) {
         return false;

package/src/predicate/is-plain-object.ts

@@ -1,17 +1,3 @@
-/**
- * Checks whether a value is a plain object, i.e. one whose prototype is `Object.prototype` or `null`.
- *
- * Class instances, arrays, and other exotic objects return `false`.
- *
- * @param value - The value to test.
- * @returns `true` when `value` is a plain object.
- *
- * @example
- * isPlainObject({ a: 1 }); // true
- * isPlainObject(Object.create(null)); // true
- * isPlainObject([1, 2]); // false
- * isPlainObject(new Date()); // false
- */
 function isPlainObject(value: unknown): value is Record<string, unknown> {
     if (typeof value !== "object" || value === null) {
         return false;

package/src/predicate/is-record.ts

@@ -1,14 +1,3 @@
-/**
- * Checks whether a value is a non-null object (including arrays and class instances, excluding `null`).
- *
- * @param value - The value to test.
- * @returns `true` when `value` is a non-null object.
- *
- * @example
- * isRecord({ a: 1 }); // true
- * isRecord(null); // false
- * isRecord("x"); // false
- */
 function isRecord(value: unknown): value is Record<string, unknown> {
     return typeof value === "object" && value !== null;
 }

package/src/predicate/is-same-array-by.ts

@@ -1,15 +1,3 @@
-/**
- * Checks whether two arrays have the same length and elements the comparator treats as equal, in order.
- *
- * @template T - The type of the array elements.
- * @param a - The first array.
- * @param b - The second array.
- * @param isEqual - Compares elements at the same index; return `true` when they are equal.
- * @returns `true` when the arrays are element-wise equal under `isEqual`.
- *
- * @example
- * isSameArrayBy([{ id: 1 }], [{ id: 1 }], (x, y) => x.id === y.id); // true
- */
 function isSameArrayBy<T>(a: T[], b: T[], isEqual: (x: T, y: T) => boolean): boolean {
     if (a.length !== b.length) {
         return false;

package/src/predicate/is-same-array.ts

@@ -1,17 +1,5 @@
-import { isSameArrayBy } from "./is-same-array-by.js";
+import { isSameArrayBy } from "./is-same-array-by.ts";
 
-/**
- * Checks whether two arrays have the same length and strictly equal (`===`) elements in order.
- *
- * @template T - The type of the array elements.
- * @param a - The first array.
- * @param b - The second array.
- * @returns `true` when the arrays are element-wise strictly equal.
- *
- * @example
- * isSameArray([1, 2], [1, 2]); // true
- * isSameArray([1, 2], [2, 1]); // false
- */
 function isSameArray<T>(a: T[], b: T[]): boolean {
     return isSameArrayBy(a, b, (x, y) => x === y);
 }

package/src/predicate/is-shallow-equal.ts

@@ -1,20 +1,6 @@
-import { areObjectKeysEqual } from "./are-object-keys-equal.js";
-import { isPlainObject } from "./is-plain-object.js";
+import { areObjectKeysEqual } from "./are-object-keys-equal.ts";
+import { isPlainObject } from "./is-plain-object.ts";
 
-/**
- * Checks whether two values are shallowly equal: identical, or plain objects with the same own
- * enumerable keys and strictly equal (`===`) values. Values that are not both plain objects are
- * equal only when identical.
- *
- * @param a - The first value.
- * @param b - The second value.
- * @returns `true` when the values are shallowly equal.
- *
- * @example
- * isShallowEqual({ a: 1 }, { a: 1 }); // true
- * isShallowEqual({ a: 1 }, { a: 2 }); // false
- * isShallowEqual(3, 3); // true
- */
 const isStrictEqual = (a: unknown, b: unknown): boolean => a === b;
 
 function isShallowEqual(a: unknown, b: unknown): boolean {

package/src/process/exit-code-for-signal.ts

@@ -1,14 +1,3 @@
-/**
- * Maps a terminating signal to its conventional process exit code (130 for `SIGINT`, 143 otherwise),
- * or 0 when no signal is given.
- *
- * @param signal - The signal that triggered termination, or `null`.
- * @returns The conventional exit code for the signal.
- *
- * @example
- * exitCodeForSignal("SIGINT"); // 130
- * exitCodeForSignal(null); // 0
- */
 function exitCodeForSignal(signal: NodeJS.Signals | null): number {
     if (!signal) {
         return 0;

package/src/process/index.ts

@@ -1,3 +1,3 @@
-export { exitCodeForSignal } from "./exit-code-for-signal.js";
-export { installGracefulShutdown } from "./install-graceful-shutdown.js";
-export { resolveExecutable } from "./resolve-executable.js";
+export { exitCodeForSignal } from "./exit-code-for-signal.ts";
+export { installGracefulShutdown } from "./install-graceful-shutdown.ts";
+export { resolveExecutable } from "./resolve-executable.ts";

package/src/process/install-graceful-shutdown.ts

@@ -1,5 +1,5 @@
-import { error } from "../log/default-logger.js";
-import { exitCodeForSignal } from "./exit-code-for-signal.js";
+import { error } from "../log/default-logger.ts";
+import { exitCodeForSignal } from "./exit-code-for-signal.ts";
 
 type GracefulShutdownOptions = {
     onSignal: (signal: NodeJS.Signals) => void | Promise<void>;
@@ -14,8 +14,8 @@ type ShutdownState = {
     forceKillMs: number;
     coalesceWindowMs: number;
     firstSignal: NodeJS.Signals | null;
-    exited: boolean;
-    coalescing: boolean;
+    hasExited: boolean;
+    isCoalescing: boolean;
     forceTimer: NodeJS.Timeout | null;
     coalesceTimer: NodeJS.Timeout | null;
 };
@@ -37,11 +37,11 @@ const clearTimers = (state: ShutdownState): void => {
 };
 
 const finish = (state: ShutdownState, signal: NodeJS.Signals, isGraceful: boolean): void => {
-    if (state.exited) {
+    if (state.hasExited) {
         return;
     }
 
-    state.exited = true;
+    state.hasExited = true;
     clearTimers(state);
     const { exitCode } = state.options;
     const defaultCode = isGraceful ? 0 : exitCodeForSignal(signal);
@@ -62,10 +62,10 @@ const beginShutdown = (state: ShutdownState, signal: NodeJS.Signals): void => {
     state.firstSignal = signal;
 
     if (state.coalesceWindowMs > 0) {
-        state.coalescing = true;
+        state.isCoalescing = true;
 
         state.coalesceTimer = setTimeout(() => {
-            state.coalescing = false;
+            state.isCoalescing = false;
         }, state.coalesceWindowMs);
 
         state.coalesceTimer.unref();
@@ -90,7 +90,7 @@ const handle = (state: ShutdownState, signal: NodeJS.Signals): void => {
         return;
     }
 
-    if (state.coalescing) {
+    if (state.isCoalescing) {
         return;
     }
 
@@ -98,20 +98,14 @@ const handle = (state: ShutdownState, signal: NodeJS.Signals): void => {
     finish(state, signal, false);
 };
 
-/**
- * Registers handlers for `SIGINT`, `SIGTERM`, and `SIGHUP` that run the given cleanup callback once
- * and then exit, forcing exit if a repeated signal arrives or the cleanup exceeds its timeout.
- *
- * @param options - The shutdown callbacks and timing configuration.
- */
 function installGracefulShutdown(options: GracefulShutdownOptions): void {
     const state: ShutdownState = {
         options,
         forceKillMs: options.forceKillAfterMs ?? DEFAULT_FORCE_KILL_TIMEOUT_MS,
         coalesceWindowMs: options.coalesceWindowMs ?? DEFAULT_COALESCE_WINDOW_MS,
         firstSignal: null,
-        exited: false,
-        coalescing: false,
+        hasExited: false,
+        isCoalescing: false,
         forceTimer: null,
         coalesceTimer: null,
     };

package/src/process/resolve-executable.ts

@@ -25,17 +25,6 @@ const findOnPath = (command: string): string | undefined => {
     return undefined;
 };
 
-/**
- * Resolves an executable to an absolute path, searching `PATH` only for a bare command name, so
- * spawning it never re-runs a lookup against a `PATH` that may have changed.
- *
- * @param command - An executable name, or a path to one.
- * @returns The absolute path of the executable.
- * @throws When a bare command name is not found on `PATH`.
- *
- * @example
- * resolveExecutable("weston"); // "/usr/bin/weston"
- */
 function resolveExecutable(command: string): string {
     if (isAbsolute(command)) {
         return command;

package/src/set/drain.ts

@@ -1,11 +1,3 @@
-/**
- * Iterates every item currently in `set`, then clears it. Use it to drain a set of pending work
- * accumulated since the last drain.
- *
- * @template T - The set item type.
- * @param set - The set to drain and clear.
- * @param visit - Called with each item before the set is cleared.
- */
 const drain = <T>(set: Set<T>, visit: (item: T) => void): void => {
     for (const item of set) {
         visit(item);

package/src/set/index.ts

@@ -1 +1 @@
-export { drain } from "./drain.js";
+export { drain } from "./drain.ts";

package/src/source/index.ts

@@ -1,3 +1,3 @@
-export { sanitizeIdentifier } from "./sanitize-identifier.js";
-export { sourceStringLiteral } from "./source-string-literal.js";
-export { toCamelIdentifier } from "./to-camel-identifier.js";
+export { sanitizeIdentifier } from "./sanitize-identifier.ts";
+export { sourceStringLiteral } from "./source-string-literal.ts";
+export { toCamelIdentifier } from "./to-camel-identifier.ts";

package/src/source/sanitize-identifier.ts

@@ -48,17 +48,6 @@ const RESERVED: Set<string> = new Set([
     "yield",
 ]);
 
-/**
- * Returns the name unchanged, or with a trailing underscore when it collides with a reserved word,
- * so it is safe to emit as a JavaScript identifier.
- *
- * @param name - The candidate identifier.
- * @returns The name, suffixed with `_` when it is a reserved word.
- *
- * @example
- * sanitizeIdentifier("iconName"); // "iconName"
- * sanitizeIdentifier("class"); // "class_"
- */
 function sanitizeIdentifier(name: string): string {
     return RESERVED.has(name) ? `${name}_` : name;
 }