obsidian-dev-utils 19.1.2-beta.2 → 19.1.2-beta.3

package/dist/lib/esm/Path.d.mts

@@ -1 +1,133 @@
-export * from '../cjs/Path.cjs';
+/**
+ * @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;

package/dist/lib/esm/RegExp.d.mts

@@ -1 +1,18 @@
-export * from '../cjs/RegExp.cjs';
+/**
+ * @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;

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

@@ -1 +1,70 @@
-export * from '../../cjs/ScriptUtils/CliUtils.cjs';
+/**
+ * @packageDocumentation cli
+ * Contains utility classes and functions for managing task results, including
+ * success, exit codes, and chaining multiple tasks.
+ */
+import type { MaybePromise } from '../Async.d.mts';
+/**
+ * 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>;

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

@@ -1 +1,12 @@
-export * from '../../cjs/ScriptUtils/CodeGenerator.cjs';
+/**
+ * @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>;

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

@@ -1 +1,13 @@
-export * from '../../../../cjs/ScriptUtils/ESLint/@types/@guardian__eslint-plugin-tsdoc-required.cjs';
+/**
+ * @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;
+}

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

@@ -1 +1,13 @@
-export * from '../../../../cjs/ScriptUtils/ESLint/@types/eslint-plugin-modules-newlines.cjs';
+/**
+ * @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;
+}

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

@@ -1 +1,13 @@
-export * from '../../../../cjs/ScriptUtils/ESLint/@types/eslint-plugin-verify-tsdoc.cjs';
+/**
+ * @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;
+}

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

@@ -1 +1,13 @@
-export * from '../../../cjs/ScriptUtils/ESLint/ESLint.cjs';
+/**
+ * @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>;

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

@@ -1 +1,16 @@
-export * from '../../../cjs/ScriptUtils/ESLint/eslint.config.cjs';
+/**
+ * @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[];

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

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

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

@@ -1 +1,83 @@
-export * from '../../cjs/ScriptUtils/Exec.cjs';
+/**
+ * @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>;

package/dist/lib/esm/ScriptUtils/Fs.d.mts

@@ -1 +1,72 @@
-export * from '../../cjs/ScriptUtils/Fs.cjs';
+/**
+ * @packageDocumentation Fs
+ * Contains utility functions for file system operations.
+ */
+import type { Dirent, ObjectEncodingOptions, PathLike } from './NodeModules.d.mts';
+/**
+ * Options for controlling the format of the result when returning buffers.
+ */
+export type BufferResultOptions = 'buffer' | {
+    /**
+     * Should be set to "buffer" to return buffers.
+     */
+    encoding: 'buffer';
+    /**
+     * Whether to include subdirectories when reading the directory. If not provided, defaults to `false`.
+     */
+    recursive?: boolean;
+    /**
+     * Should be set to `false` to return buffers.
+     */
+    withFileTypes?: false;
+};
+/**
+ * Options for controlling the format of the result when returning Dirent objects.
+ */
+export type DirentResultOptions = {
+    /**
+     * Whether to include subdirectories when reading the directory. If not provided, defaults to `false`.
+     */
+    recursive?: boolean;
+    /**
+     * Should be set to `true` to return Dirent objects.
+     */
+    withFileTypes: true;
+} & ObjectEncodingOptions;
+/**
+ * Options for controlling the format of the result when returning strings.
+ */
+export type StringResultOptions = {
+    /**
+     * Whether to include subdirectories when reading the directory. If not provided, defaults to `false`.
+     */
+    recursive?: boolean;
+    /**
+     * Should be set to `false` to return strings.
+     */
+    withFileTypes?: false;
+} & ObjectEncodingOptions | undefined;
+/**
+ * Reads the contents of a directory and returns an array of strings with POSIX paths.
+ *
+ * @param path - The path to the directory.
+ * @param options - Options to control the format of the result. If not provided, returns strings.
+ * @returns A promise that resolves with an array of POSIX-formatted file paths.
+ */
+export declare function readdirPosix(path: PathLike, options?: StringResultOptions): Promise<string[]>;
+/**
+ * Reads the contents of a directory and returns an array of buffers with POSIX paths.
+ *
+ * @param path - The path to the directory.
+ * @param options - Options to control the format of the result. Specify "buffer" to return buffers.
+ * @returns A promise that resolves with an array of POSIX-formatted buffers.
+ */
+export declare function readdirPosix(path: PathLike, options: BufferResultOptions): Promise<Buffer[]>;
+/**
+ * Reads the contents of a directory and returns an array of Dirent objects with POSIX paths.
+ *
+ * @param path - The path to the directory.
+ * @param options - Options to control the format of the result. Specify `withFileTypes: true` to return Dirent objects.
+ * @returns A promise that resolves with an array of POSIX-formatted Dirent objects.
+ */
+export declare function readdirPosix(path: PathLike, options: DirentResultOptions): Promise<Dirent[]>;

package/dist/lib/esm/ScriptUtils/JSON.d.mts

@@ -1 +1,64 @@
-export * from '../../cjs/ScriptUtils/JSON.cjs';
+/**
+ * @packageDocumentation JSON
+ * Contains utility functions for JSON.
+ */
+import type { MaybePromise } from '../Async.d.mts';
+/**
+ * Options for editing JSON.
+ */
+export interface EditJsonOptions {
+    /**
+     * If true, skips editing if the file does not exist.
+     */
+    shouldSkipIfMissing?: boolean;
+}
+/**
+ * Reads, edits, and writes back a JSON file using a provided edit function.
+ *
+ * @typeParam T - The type of the data to be edited.
+ * @param path - The path to the JSON file.
+ * @param editFn - The function to edit the parsed JSON data.
+ * @param options - Additional options for editing.
+ * @returns A promise that resolves when the file has been edited and written.
+ */
+export declare function editJson<T>(path: string, editFn: (data: T) => MaybePromise<void>, options?: EditJsonOptions): Promise<void>;
+/**
+ * Reads, edits, and writes back a JSON file using a provided edit function.
+ *
+ * @typeParam T - The type of the data to be edited.
+ * @param path - The path to the JSON file.
+ * @param editFn - The function to edit the parsed JSON data.
+ * @param options - Additional options for editing.
+ */
+export declare function editJsonSync<T>(path: string, editFn: (data: T) => void, options?: EditJsonOptions): void;
+/**
+ * Reads a JSON file and parses its contents into a JavaScript object of type `T`.
+ *
+ * @typeParam T - The type to which the JSON content will be parsed.
+ * @param path - The path to the JSON file.
+ * @returns A promise that resolves with the parsed JSON object of type `T`.
+ */
+export declare function readJson<T>(path: string): Promise<T>;
+/**
+ * Reads a JSON file and parses its contents into a JavaScript object of type `T`.
+ *
+ * @typeParam T - The type to which the JSON content will be parsed.
+ * @param path - The path to the JSON file.
+ * @returns The parsed JSON object of type `T`.
+ */
+export declare function readJsonSync<T>(path: string): T;
+/**
+ * Writes a JavaScript object to a JSON file.
+ *
+ * @param path - The path to the JSON file.
+ * @param data - The data to write to the JSON file.
+ * @returns A promise that resolves when the file has been written.
+ */
+export declare function writeJson(path: string, data: unknown): Promise<void>;
+/**
+ * Writes a JavaScript object to a JSON file.
+ *
+ * @param path - The path to the JSON file.
+ * @param data - The data to write to the JSON file.
+ */
+export declare function writeJsonSync(path: string, data: unknown): void;

package/dist/lib/esm/ScriptUtils/NodeModules.d.mts

@@ -1 +1,14 @@
-export * from '../../cjs/ScriptUtils/NodeModules.cjs';
+/**
+ * @packageDocumentation NodeModules
+ * Contains utility functions for Node.js modules.
+ */
+import process from 'node:process';
+export { spawn } from 'node:child_process';
+export { existsSync, readFileSync, statSync, watch, writeFileSync } from 'node:fs';
+export type { Dirent, FSWatcher, ObjectEncodingOptions, PathLike, WatchEventType } from 'node:fs';
+export { process };
+export { cp, mkdir, readdir, readFile, rename, rm, stat, writeFile } from 'node:fs/promises';
+export { builtinModules, createRequire, Module } from 'node:module';
+export { arch, endianness } from 'node:os';
+export { createInterface } from 'node:readline/promises';
+export { fileURLToPath } from 'node:url';