obsidian-dev-utils 19.0.0 → 19.0.1

package/dist/lib/Object.d.mts

@@ -1,211 +1 @@
-/**
- * @packageDocumentation Object
- * Contains utility functions for Objects.
- */
-import type { UndefinedOnPartialDeep } from 'type-fest';
-/**
- * Specifies how functions should be handled in the JSON output.
- */
-export declare enum FunctionHandlingMode {
-    /**
-     * Excludes functions from the JSON output.
-     */
-    Exclude = "exclude",
-    /**
-     * Includes the full function definition in the JSON output.
-     */
-    Full = "full",
-    /**
-     * Includes only the function name in the JSON output.
-     */
-    NameOnly = "nameOnly"
-}
-/**
- * Represents a constructor type for a given class `T` with arguments `Args`.
- *
- * @typeParam Type - The type of the instance being constructed.
- * @typeParam Args - The types of arguments the constructor accepts.
- */
-export type Constructor<Type, Args extends unknown[] = []> = new (...args: Args) => Type;
-/**
- * Extracts the keys of a given type `Type` that match a specific value type `Value`.
- *
- * @typeParam Type - The type from which to extract the keys.
- * @typeParam Value - The value type to match against.
- */
-export type KeysMatching<Type, Value> = {
-    [Key in keyof Type]-?: Type[Key] extends Value ? Key : never;
-}[keyof Type];
-/**
- * Options for converting an object to JSON.
- */
-export interface ToJsonOptions {
-    /**
-     * Specifies how functions should be handled in the JSON output (default: `exclude`).
-     */
-    functionHandlingMode: FunctionHandlingMode;
-    /**
-     * Specifies the maximum depth of nested objects to include in the JSON output.
-     * Use `-1` for no limit.
-     * Defaults to `-1`.
-     */
-    maxDepth: number;
-    /**
-     * Specifies whether to catch errors in `toJSON()` and replace them with a placeholder.
-     * Defaults to `false`.
-     */
-    shouldCatchToJSONErrors: boolean;
-    /**
-     * Specifies whether to handle circular references in the JSON output.
-     * Defaults to `false`.
-     */
-    shouldHandleCircularReferences: boolean;
-    /**
-     * Specifies whether to handle errors in the JSON output.
-     * Defaults to `false`.
-     */
-    shouldHandleErrors: boolean;
-    /**
-     * Specifies whether to handle undefined values in the JSON output.
-     * Defaults to `false`.
-     */
-    shouldHandleUndefined: boolean;
-    /**
-     * Specifies whether to sort the keys of the JSON output.
-     * Defaults to `false`.
-     */
-    shouldSortKeys: boolean;
-    /**
-     * Specifies the indentation of the JSON output. This can be a number of spaces or a string. Defaults to `2`.
-     */
-    space: number | string;
-    /**
-     * Specifies the substitutions to use in the JSON output.
-     */
-    tokenSubstitutions: Partial<TokenSubstitutions>;
-}
-interface TokenSubstitutions {
-    circularReference: string;
-    maxDepthLimitReached: string;
-    toJSONFailed: string;
-}
-/**
- * Assigns properties from one or more source objects to a target object, including non-enumerable properties.
- *
- * @param target - The target object to assign properties to.
- * @param source - The source object to assign properties from.
- * @returns The target object with the assigned properties.
- */
-export declare function assignWithNonEnumerableProperties<T extends object, U>(target: T, source: U): T & U;
-/**
- * @param target - The target object to assign properties to.
- * @param source1 - The first source object to assign properties from.
- * @param source2 - The second source object to assign properties from.
- * @returns The target object with the assigned properties.
- */
-export declare function assignWithNonEnumerableProperties<T extends object, U, V>(target: T, source1: U, source2: V): T & U & V;
-/**
- * Assigns properties from one or more source objects to a target object, including non-enumerable properties.
- *
- * @param target - The target object to assign properties to.
- * @param source1 - The first source object to assign properties from.
- * @param source2 - The second source object to assign properties from.
- * @param source3 - The third source object to assign properties from.
- * @returns The target object with the assigned properties.
- */
-export declare function assignWithNonEnumerableProperties<T extends object, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
-/**
- * Clones an object, including non-enumerable properties.
- *
- * @param obj - The object to clone.
- * @returns A new object with the same properties as the original object, including non-enumerable properties.
- */
-export declare function cloneWithNonEnumerableProperties<T extends object>(obj: T): T;
-/**
- * Compares two values to determine if they are deeply equal.
- *
- * @param a - The first value to compare.
- * @param b - The second value to compare.
- * @returns `true` if the values are deeply equal, otherwise `false`.
- */
-export declare function deepEqual(a: unknown, b: unknown): boolean;
-/**
- * Deletes multiple properties from an object.
- *
- * @typeParam T - The type of the object.
- * @param obj - The object to delete the properties from.
- * @param propertyNames - The names of the properties to delete.
- * @returns `true` if any of the properties were present, otherwise `false`.
- */
-export declare function deleteProperties<T extends object>(obj: T, propertyNames: (keyof T)[]): boolean;
-/**
- * Deletes a property from an object.
- *
- * @typeParam T - The type of the object.
- * @param obj - The object to delete the property from.
- * @param propertyName - The name of the property to delete.
- * @returns `true` if the property was present, otherwise `false`.
- */
-export declare function deleteProperty<T extends object>(obj: T, propertyName: keyof T): boolean;
-/**
- * Gets the value of a nested property from an object.
- *
- * @param obj - The object to get the nested property value from.
- * @param path - The path to the nested property.
- * @returns The value of the nested property.
- */
-export declare function getNestedPropertyValue(obj: Record<string, unknown>, path: string): unknown;
-/**
- * Gets the prototype of the specified object.
- *
- * @typeParam T - The type of the object.
- * @param instance - The object instance to retrieve the prototype of.
- * @returns The prototype of the object.
- */
-export declare function getPrototypeOf<T>(instance: T): T;
-/**
- * Retrieves the name of a property of a given type `T`.
- *
- * @typeParam T - The type of the object containing the property.
- * @param name - The name of the property as a string.
- * @returns The name of the property.
- */
-export declare function nameof<T>(name: Extract<keyof T, string>): string;
-/**
- * Normalizes optional properties to allow `undefined` assignment in strict mode.
- *
- * This utility provides a workaround for the `exactOptionalPropertyTypes` TypeScript flag,
- * which prohibits directly assigning `undefined` to optional properties when the type
- * explicitly omits `undefined`.
- *
- * Example:
- * ```typescript
- * // With `exactOptionalPropertyTypes: true`
- * const x: { prop?: string } = { prop: undefined }; // Compiler error
- *
- * // Using this utility:
- * const y: { prop?: string } = normalizeOptionalProperties<{ prop?: string }>({ prop: undefined }); // Works
- * ```
- *
- * @typeParam T - The target type with optional properties to normalize.
- * @param obj - The object to normalize, allowing explicit `undefined` for optional properties.
- * @returns The normalized object, compatible with `exactOptionalPropertyTypes`.
- */
-export declare function normalizeOptionalProperties<T>(obj: UndefinedOnPartialDeep<T>): T;
-/**
- * Sets the value of a nested property in an object.
- *
- * @param obj - The object to set the nested property value in.
- * @param path - The path to the nested property.
- * @param value - The value to set.
- */
-export declare function setNestedPropertyValue(obj: Record<string, unknown>, path: string, value: unknown): void;
-/**
- * Converts a given value to a JSON string.
- *
- * @param value - The value to be converted to JSON. This can be of any type.
- * @param options - Options for customizing the JSON conversion process.
- * @returns The JSON string representation of the input value.
- */
-export declare function toJson(value: unknown, options?: Partial<ToJsonOptions>): string;
-export {};
+export * from './Object.cjs';

package/dist/lib/Path.d.mts

@@ -1,133 +1 @@
-/**
- * @packageDocumentation Path
- * Contains utility functions for handling paths.
- */
-import pathBrowserify from 'path-browserify';
-/**
- * Provides methods for handling POSIX paths.
- */
-export declare const posix: pathBrowserify.Path;
-/**
- * The POSIX path delimiter.
- */
-export declare const delimiter: string;
-/**
- * The POSIX segment separator.
- */
-export declare const sep: string;
-/**
- * Returns the base name of a file, optionally removing the file extension.
- *
- * @param path - The path to get the base name from.
- * @param ext - An optional extension to remove from the base name.
- * @returns The base name of the file.
- */
-export declare const basename: (this: void, path: string, ext?: string) => string;
-/**
- * Returns the directory name of a path.
- *
- * @param path - The path to get the directory name from.
- * @returns The directory name of the path.
- */
-export declare const dirname: (this: void, path: string) => string;
-/**
- * Returns the file extension of a path.
- *
- * @param path - The path to get the extension from.
- * @returns The file extension of the path.
- */
-export declare const extname: (this: void, path: string) => string;
-/**
- * Formats a path object into a path string.
- *
- * @param pathObject - The path object to format.
- * @returns The formatted path string.
- */
-export declare const format: (this: void, pathObject: Partial<pathBrowserify.PathObject>) => string;
-/**
- * Determines if a path is absolute.
- *
- * @param path - The path to check.
- * @returns `true` if the path is absolute, `false` otherwise.
- */
-export declare function isAbsolute(path: string): boolean;
-/**
- * Joins multiple path segments into a single path.
- *
- * @param paths - The path segments to join.
- * @returns The joined path.
- */
-export declare const join: (this: void, ...paths: string[]) => string;
-/**
- * Normalizes a path, resolving '..' and '.' segments.
- *
- * @param path - The path to normalize.
- * @returns The normalized path.
- */
-export declare const normalize: (this: void, path: string) => string;
-/**
- * Parses a path string into a path object.
- *
- * @param path - The path string to parse.
- * @returns The parsed path object.
- */
-export declare const parse: (this: void, path: string) => pathBrowserify.PathObject;
-/**
- * Returns the relative path from one path to another.
- *
- * @param from - The starting path.
- * @param to - The destination path.
- * @returns The relative path from `from` to `to`.
- */
-export declare const relative: (this: void, from: string, to: string) => string;
-/**
- * Gets the directory name from the `import(dot)meta(dot)url`, converting it to a POSIX-style path.
- *
- * @param importMetaUrl - The `import(dot)meta(dot)url` from which to extract the directory name.
- * @returns The POSIX-style directory name.
- */
-export declare function getDirname(importMetaUrl: string): string;
-/**
- * Gets the filename from the `import(dot)meta(dot)url`, converting it to a POSIX-style path.
- *
- * @param importMetaUrl - The `import(dot)meta(dot)url` from which to extract the filename.
- * @returns The POSIX-style filename.
- */
-export declare function getFilename(importMetaUrl: string): string;
-/**
- * Makes a filename by appending an extension to a given filename.
- * If the extension is empty, the filename is returned as is.
- *
- * @param fileName - The filename to append the extension to.
- * @param extension - The extension to append to the filename.
- * @returns The filename with the extension appended.
- */
-export declare function makeFileName(fileName: string, extension: string): string;
-/**
- * Normalizes a given path by ensuring it is relative, adding "./" if necessary.
- *
- * @param path - The path to normalize.
- * @returns The normalized path, starting with "./" if it was relative.
- */
-export declare function normalizeIfRelative(path: string): string;
-/**
- * Resolves a sequence of paths or path segments into an absolute path.
- *
- * @param pathSegments - The sequence of path segments to resolve.
- * @returns The resolved absolute path.
- */
-export declare function resolve(...pathSegments: string[]): string;
-/**
- * Converts a buffer containing a path to a POSIX-style buffer by replacing backslashes with forward slashes.
- *
- * @param buffer - The buffer to convert.
- * @returns A new buffer containing the POSIX-style path.
- */
-export declare function toPosixBuffer(buffer: Buffer): Buffer;
-/**
- * Converts a given path to a POSIX-style path by replacing backslashes with forward slashes.
- *
- * @param path - The path to convert.
- * @returns The POSIX-style path.
- */
-export declare function toPosixPath(path: string): string;
+export * from './Path.cjs';

package/dist/lib/RegExp.d.mts

@@ -1,18 +1 @@
-/**
- * @packageDocumentation RegExp
- * Contains utility functions for regular expressions.
- */
-/**
- * Escapes special characters in a string to safely use it within a regular expression.
- *
- * @param str - The string to escape.
- * @returns The escaped string with special characters prefixed with a backslash.
- */
-export declare function escapeRegExp(str: string): string;
-/**
- * Checks if a string is a valid regular expression.
- *
- * @param str - The string to check.
- * @returns `true` if the string is a valid regular expression, `false` otherwise.
- */
-export declare function isValidRegExp(str: string): boolean;
+export * from './RegExp.cjs';

package/dist/lib/ScriptUtils/CliUtils.d.mts

@@ -1,70 +1 @@
-/**
- * @packageDocumentation cli
- * Contains utility classes and functions for managing task results, including
- * success, exit codes, and chaining multiple tasks.
- */
-import type { MaybePromise } from '../Async.mjs';
-/**
- * Abstract class representing the result of a task. Includes methods for handling success,
- * exit codes, and chaining tasks.
- */
-export declare abstract class CliTaskResult {
-    /**
-     * Chains multiple tasks together, executing them sequentially until one fails.
-     *
-     * @param tasks - An array of task functions that return a `TaskResult` or `void`.
-     * @returns A promise that resolves with the first failed `TaskResult` or a success result.
-     */
-    static chain(tasks: (() => MaybePromise<CliTaskResult | void>)[]): Promise<CliTaskResult>;
-    /**
-     * Creates a `TaskResult` that does not exit the process.
-     *
-     * @returns A `TaskResult` that does not exit the process.
-     */
-    static DoNotExit(): CliTaskResult;
-    /**
-     * Represents a failure result of a CLI task.
-     *
-     * @returns The failure result.
-     */
-    static Failure(): CliTaskResult;
-    /**
-     * Creates a `TaskResult` based on an exit code.
-     *
-     * @param exitCode - The exit code to represent.
-     * @returns A `TaskResult` representing the exit code.
-     */
-    static FromExitCode(exitCode: number): CliTaskResult;
-    /**
-     * Creates a CliTaskResult representing a successful task result.
-     *
-     * @param isSuccess - A boolean indicating whether the task was successful. Default is true.
-     * @returns A CliTaskResult object representing a successful task result.
-     */
-    static Success(isSuccess?: boolean): CliTaskResult;
-    /**
-     * Exits the process based on the task result.
-     */
-    abstract exit(): void;
-    /**
-     * Determines if the task was successful.
-     *
-     * @returns `true` if the task was successful, otherwise `false`.
-     */
-    protected abstract isSuccessful(): boolean;
-}
-/**
- * Converts an array of command-line arguments into a single command-line string.
- * Handles escaping of special characters such as spaces, quotes, and newlines.
- *
- * @param args - The array of command-line arguments to convert.
- * @returns A string representing the command-line invocation.
- */
-export declare function toCommandLine(args: string[]): string;
-/**
- * Wraps a CLI task function to ensure it runs safely and handles its `TaskResult`.
- *
- * @param taskFn - The task function to execute, which may return a `TaskResult` or void.
- * @returns A promise that resolves when the task is completed and exits with the appropriate status.
- */
-export declare function wrapCliTask(taskFn: () => MaybePromise<CliTaskResult | void>): Promise<void>;
+export * from './CliUtils.cjs';

package/dist/lib/ScriptUtils/CodeGenerator.d.mts

@@ -1,12 +1 @@
-/**
- * @packageDocumentation CodeGenerator
- * Contains utility functions for code generation.
- */
-/**
- * Generates a file at the specified path with the provided lines of code.
- *
- * @param path - The path where the file will be generated.
- * @param lines - An array of strings representing the lines of code to be written in the file.
- * @returns A promise that resolves when the file generation is complete.
- */
-export declare function generate(path: string, lines: string[]): Promise<void>;
+export * from './CodeGenerator.cjs';

package/dist/lib/ScriptUtils/ESLint/@types/@guardian__eslint-plugin-tsdoc-required.d.mts

@@ -1,13 +1 @@
-/**
- * @packageDocumentation \@guardian/eslint-plugin-tsdoc-required
- * @see {@link https://www.npmjs.com/package/@guardian/eslint-plugin-tsdoc-required} for more information.
- */
-
-declare module '@guardian/eslint-plugin-tsdoc-required' {
-  import type { ESLint } from 'eslint';
-
-  const plugin: ESLint.Plugin;
-
-  // eslint-disable-next-line import-x/no-default-export
-  export default plugin;
-}
+export * from './@guardian__eslint-plugin-tsdoc-required.cjs';

package/dist/lib/ScriptUtils/ESLint/@types/eslint-plugin-modules-newlines.d.mts

@@ -1,13 +1 @@
-/**
- * @packageDocumentation eslint-plugin-modules-newlines
- * @see {@link https://www.npmjs.com/package/eslint-plugin-modules-newlines} for more information.
- */
-
-declare module 'eslint-plugin-modules-newlines' {
-  import type { ESLint } from 'eslint';
-
-  const plugin: ESLint.Plugin;
-
-  // eslint-disable-next-line import-x/no-default-export
-  export default plugin;
-}
+export * from './eslint-plugin-modules-newlines.cjs';

package/dist/lib/ScriptUtils/ESLint/@types/eslint-plugin-verify-tsdoc.d.mts

@@ -1,13 +1 @@
-/**
- * @packageDocumentation eslint-plugin-verify-tsdoc
- * @see {@link https://www.npmjs.com/package/eslint-plugin-verify-tsdoc} for more information.
- */
-
-declare module 'eslint-plugin-verify-tsdoc' {
-  import type { ESLint } from 'eslint';
-
-  const plugin: ESLint.Plugin;
-
-  // eslint-disable-next-line import-x/no-default-export
-  export default plugin;
-}
+export * from './eslint-plugin-verify-tsdoc.cjs';

package/dist/lib/ScriptUtils/ESLint/ESLint.d.mts

@@ -1,13 +1 @@
-/**
- * @packageDocumentation ESLint
- * Linting utility for ESLint configuration with support for automatic fixing.
- *
- * This module provides a function to lint files based on the ESLint configuration defined in `eslint.config.ts`.
- * It can automatically fix linting issues if specified, and logs results to the console.
- */
-/**
- * Lint the project with ESLint.
- *
- * @param shouldFix - Whether to fix linting issues automatically.
- */
-export declare function lint(shouldFix?: boolean): Promise<void>;
+export * from './ESLint.cjs';

package/dist/lib/ScriptUtils/ESLint/eslint.config.d.mts

@@ -1,16 +1 @@
-/**
- * @packageDocumentation eslint.config
- * ESLint configuration for TypeScript projects with various plugins.
- *
- * This module exports ESLint configurations for TypeScript projects, integrating multiple ESLint plugins
- * such as `@typescript-eslint/parser`, `@typescript-eslint/eslint-plugin`,
- * `eslint-plugin-modules-newlines`, `@stylistic/eslint-plugin`.
- * It sets up parsers, plugins, and rules for maintaining code quality and consistency.
- *
- * @packageDocumentation eslint-config
- */
-import type { Linter } from 'eslint';
-/**
- * The ESLint configurations for TypeScript projects.
- */
-export declare const configs: Linter.Config[];
+export * from './eslint.config.cjs';

package/dist/lib/ScriptUtils/ESLint/index.d.mts

@@ -1,2 +1 @@
-export * as eslint_config from './eslint.config.mjs';
-export * as ESLint from './ESLint.mjs';
+export * from './index.cjs';

package/dist/lib/ScriptUtils/Exec.d.mts

@@ -1,83 +1 @@
-/**
- * @packageDocumentation Exec
- * Contains utility functions for executing commands.
- */
-/**
- * Options for executing a command.
- */
-export interface ExecOption {
-    /**
-     * The current working directory for the command execution.
-     */
-    cwd?: string;
-    /**
-     * If true, suppresses the output of the command.
-     */
-    isQuiet?: boolean;
-    /**
-     * If true, throws an error if the command fails.
-     */
-    shouldFailIfCalledFromOutsideRoot?: boolean;
-    /**
-     * If true, ignores the exit code of the command.
-     */
-    shouldIgnoreExitCode?: boolean;
-    /**
-     * If false, only returns the output of the command.
-     */
-    shouldIncludeDetails?: boolean;
-    /**
-     * The input to be passed to the command.
-     */
-    stdin?: string;
-}
-/**
- * Represents the result of executing a command.
- */
-export interface ExecResult {
-    /**
-     * The exit code of the command. A value of `null` indicates that the process did not exit normally.
-     */
-    exitCode: null | number;
-    /**
-     * The signal that caused the process to be terminated. A value of `null` indicates that no signal was received.
-     */
-    exitSignal: NodeJS.Signals | null;
-    /**
-     * The standard error output from the command.
-     */
-    stderr: string;
-    /**
-     * The standard output from the command.
-     */
-    stdout: string;
-}
-/**
- * Executes a command.
- *
- * @param command - The command to execute. It can be a string or an array of strings.
- * @param options - The options for the execution.
- * @returns A Promise that resolves with the output of the command.
- * @throws If the command fails with a non-zero exit code and ignoreExitCode is false.
- *         The error message includes the exit code and stderr.
- *         If an error occurs during the execution and ignoreExitCode is true,
- *         the error is resolved with the stdout and stderr.
- */
-export declare function exec(command: string | string[], options?: {
-    withDetails?: false;
-} & ExecOption): Promise<string>;
-/**
- * Executes a command.
- *
- * @param command - The command to execute. It can be a string or an array of strings.
- * @param options - The options for the execution.
- * @returns A Promise that resolves with ExecResult object.
- *          The ExecResult object contains the exit code, exit signal, stderr, and stdout.
- * @throws If the command fails with a non-zero exit code and ignoreExitCode is false.
- *         The error message includes the exit code and stderr.
- *         If an error occurs during the execution and ignoreExitCode is true,
- *         the error is resolved with the stdout and stderr.
- */
-export declare function exec(command: string | string[], options: {
-    withDetails: true;
-} & ExecOption): Promise<ExecResult>;
+export * from './Exec.cjs';