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

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

@@ -1 +1,151 @@
-export * from '../../cjs/ScriptUtils/Npm.cjs';
+/**
+ * @packageDocumentation Npm
+ * Contains utility functions for NPM package.json.
+ */
+import type { PackageJson } from 'type-fest';
+import type { MaybePromise } from '../Async.d.mts';
+/**
+ * Options for editing a package.json file.
+ */
+export interface EditPackageJsonOptions {
+    /**
+     * The current working directory where `package.json` is located.
+     */
+    cwd?: string;
+    /**
+     * If true, skips editing if the file does not exist.
+     */
+    shouldSkipIfMissing?: boolean;
+}
+/**
+ * The type of the `package.json` file.
+ */
+export type { PackageJson };
+/**
+ * The type of the `package-lock.json` file.
+ */
+export interface PackageLockJson extends Partial<PackageJson> {
+    /**
+     * The packages in the `package-lock.json` file.
+     */
+    packages?: Record<string, PackageJson>;
+}
+/**
+ * Reads, edits, and writes back the `package-lock.json` file using the provided edit function.
+ *
+ * @param editFn - The function to edit the parsed `PackageJson` object.
+ * @param options - Additional options for editing.
+ * @returns A promise that resolves when the file has been edited and written.
+ */
+export declare function editNpmShrinkWrapJson(editFn: (packageLockJson: PackageLockJson) => MaybePromise<void>, options?: EditPackageJsonOptions): Promise<void>;
+/**
+ * Reads, edits, and writes back the `package.json` file using the provided edit function.
+ *
+ * @param editFn - The function to edit the parsed `PackageJson` object.
+ * @param options - Additional options for editing.
+ * @returns A promise that resolves when the file has been edited and written.
+ */
+export declare function editPackageJson(editFn: (packageJson: PackageJson) => MaybePromise<void>, options?: EditPackageJsonOptions): Promise<void>;
+/**
+ * Reads, edits, and writes back the `package.json` file using the provided edit function.
+ *
+ * @param editFn - The function to edit the parsed `PackageJson` object.
+ * @param options - Additional options for editing.
+ * @returns A promise that resolves when the file has been edited and written.
+ */
+export declare function editPackageJsonSync(editFn: (packageJson: PackageJson) => void, options?: EditPackageJsonOptions): void;
+/**
+ * Reads, edits, and writes back the `package-lock.json` file using the provided edit function.
+ *
+ * @param editFn - The function to edit the parsed `PackageJson` object.
+ * @param options - Additional options for editing.
+ * @returns A promise that resolves when the file has been edited and written.
+ */
+export declare function editPackageLockJson(editFn: (packageLockJson: PackageLockJson) => MaybePromise<void>, options?: EditPackageJsonOptions): Promise<void>;
+/**
+ * Reads, edits, and writes back the `package-lock.json` file using the provided edit function.
+ *
+ * @param editFn - The function to edit the parsed `PackageLockJson` object.
+ * @param options - Additional options for editing.
+ * @returns A promise that resolves when the file has been edited and written.
+ */
+export declare function editPackageLockJsonSync(editFn: (packageLockJson: PackageLockJson) => void, options?: EditPackageJsonOptions): void;
+/**
+ * Resolves the path to the `npm-shrinkwrap.json` file in the specified directory or in the root if no directory is specified.
+ *
+ * @param cwd - The current working directory where `npm-shrinkwrap.json` is located.
+ * @returns The resolved path to the `npm-shrinkwrap.json` file.
+ */
+export declare function getNpmShrinkWrapJsonPath(cwd?: string): string;
+/**
+ * Resolves the path to the `package.json` file in the specified directory or in the root if no directory is specified.
+ *
+ * @param cwd - The current working directory where `package.json` is located.
+ * @returns The resolved path to the `package.json` file.
+ */
+export declare function getPackageJsonPath(cwd?: string): string;
+/**
+ * Resolves the path to the `package-lock.json` file in the specified directory or in the root if no directory is specified.
+ *
+ * @param cwd - The current working directory where `package-lock.json` is located.
+ * @returns The resolved path to the `package-lock.json` file.
+ */
+export declare function getPackageLockJsonPath(cwd?: string): string;
+/**
+ * Reads the `package.json` file from the specified directory or from the root if no directory is specified.
+ *
+ * @param cwd - The current working directory where `package.json` is located.
+ * @returns A promise that resolves with the parsed `PackageJson` object.
+ */
+export declare function readPackageJson(cwd?: string): Promise<PackageJson>;
+/**
+ * Reads the `package.json` file from the specified directory or from the root if no directory is specified.
+ *
+ * @param cwd - The current working directory where `package.json` is located.
+ * @returns The parsed `PackageJson` object.
+ */
+export declare function readPackageJsonSync(cwd?: string): PackageJson;
+/**
+ * Reads the `package-lock.json` file from the specified directory or from the root if no directory is specified.
+ *
+ * @param cwd - The current working directory where `package-lock.json` is located.
+ * @returns A promise that resolves with the parsed `PackageJson` object.
+ */
+export declare function readPackageLockJson(cwd?: string): Promise<PackageLockJson>;
+/**
+ * Reads the `package-lock.json` file from the specified directory or from the root if no directory is specified.
+ *
+ * @param cwd - The current working directory where `package-lock.json` is located.
+ * @returns The parsed `PackageLockJson` object.
+ */
+export declare function readPackageLockJsonSync(cwd?: string): PackageLockJson;
+/**
+ * Writes the provided `PackageJson` object to the `package.json` file in the specified directory or in the root.
+ *
+ * @param packageJson - The `PackageJson` object to write.
+ * @param cwd - The current working directory where `package.json` is located.
+ * @returns A promise that resolves when the file has been written.
+ */
+export declare function writePackageJson(packageJson: PackageJson, cwd?: string): Promise<void>;
+/**
+ * Writes the provided `PackageJson` object to the `package.json` file in the specified directory or in the root.
+ *
+ * @param packageJson - The `PackageJson` object to write.
+ * @param cwd - The current working directory where `package.json` is located.
+ */
+export declare function writePackageJsonSync(packageJson: PackageJson, cwd?: string): void;
+/**
+ * Writes the provided `PackageJson` object to the `package-lock.json` file in the specified directory or in the root.
+ *
+ * @param packageLockJson - The `PackageLockJson` object to write.
+ * @param cwd - The current working directory where `package-lock.json` is located.
+ * @returns A promise that resolves when the file has been written.
+ */
+export declare function writePackageLockJson(packageLockJson: PackageLockJson, cwd?: string): Promise<void>;
+/**
+ * Writes the provided `PackageLockJson` object to the `package-lock.json` file in the specified directory or in the root.
+ *
+ * @param packageLockJson - The `PackageLockJson` object to write.
+ * @param cwd - The current working directory where `package-lock.json` is located.
+ */
+export declare function writePackageLockJsonSync(packageLockJson: PackageLockJson, cwd?: string): void;

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

@@ -1 +1,9 @@
-export * from '../../cjs/ScriptUtils/NpmPublish.cjs';
+/**
+ * @packageDocumentation NpmPublish
+ * Contains utility functions for NPM publish.
+ */
+/**
+ * Publish to NPM.
+ * @param isBeta - Whether to publish to the beta NPM registry.
+ */
+export declare function publish(isBeta?: boolean): Promise<void>;

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

@@ -1 +1,106 @@
-export * from '../../cjs/ScriptUtils/ObsidianDevUtilsRepoPaths.cjs';
+/**
+ * @packageDocumentation ObsidianDevUtilsRepoPaths
+ * This module defines an enumeration of common file paths and patterns used in the Obsidian development utilities repository.
+ * These paths are used throughout the build process and other utilities, ensuring consistency and reducing the likelihood
+ * of errors due to hardcoded strings.
+ */
+export declare enum ObsidianDevUtilsRepoPaths {
+    /** Matches any file or directory (`*`). */
+    Any = "*",
+    /** Matches any `.cjs` file (`*.cjs`). */
+    AnyCjs = "*.cjs",
+    /** Matches any `.d.cts` file (`*.d.cts`). */
+    AnyDcts = "*.d.cts",
+    /** Matches any `.d.mts` file (`*.d.mts`). */
+    AnyDmts = "*.d.mts",
+    /** Matches any TypeScript declaration file (`*.d.ts`). */
+    AnyDts = "*.d.ts",
+    /** Matches any `.js` file (`*.js`). */
+    AnyJs = "*.js",
+    /** Matches any `.mjs` file (`*.mjs`). */
+    AnyMjs = "*.mjs",
+    /** Matches any path recursively (`**`). */
+    AnyPath = "**",
+    /** Matches any TypeScript file (`*.ts`). */
+    AnyTs = "*.ts",
+    /** The path to the `CHANGELOG.md` file. */
+    ChangelogMd = "CHANGELOG.md",
+    /** The path to the `cjs` directory. */
+    Cjs = "cjs",
+    /** The `.cjs` file extension. */
+    CjsExtension = ".cjs",
+    /** The path to the current directory. */
+    CurrentDir = ".",
+    /** The path to the `src/obsidian/@types/Dataview` files. */
+    DataviewTypes = "src/obsidian/@types/Dataview/**",
+    /** The `.d.cts` file extension. */
+    DctsExtension = ".d.cts",
+    /** The path to the distribution (`dist`) directory. */
+    Dist = "dist",
+    /** The path to the `lib` directory within the `dist` directory. */
+    DistLib = "dist/lib",
+    /** The path to the `_dependencies.cjs` file within the `lib` directory in the `dist` directory. */
+    DistLibDependenciesCjs = "./dist/lib/_dependencies.cjs",
+    /** The `.d.js` file extension. */
+    DjsExtension = ".d.js",
+    /** The `.d.mts` file extension. */
+    DmtsExtension = ".d.mts",
+    /** The path to the `dprint.json` file. */
+    DprintJson = "dprint.json",
+    /** The `.d.ts` file extension. */
+    DtsExtension = ".d.ts",
+    /** The path to the `esm` directory. */
+    Esm = "esm",
+    /** The path to the `index.cjs` file. */
+    IndexCjs = "index.cjs",
+    /** The path to the `index.d.cts` file. */
+    IndexDcts = "index.d.cts",
+    /** The path to the `index.d.mts` file. */
+    IndexDmts = "index.d.mts",
+    /** The path to the `index.d.ts` file. */
+    IndexDts = "index.d.ts",
+    /** The path to the `index.mjs` file. */
+    IndexMjs = "index.mjs",
+    /** The path to the `index.ts` file. */
+    IndexTs = "index.ts",
+    /** The `.js` file extension. */
+    JsExtension = ".js",
+    /** Represents the Library.cjs file. */
+    LibraryCjs = "Library.cjs",
+    /** Represents the Library.mjs file. */
+    LibraryMjs = "Library.mjs",
+    /** The path to the `LICENSE` file. */
+    License = "LICENSE",
+    /** The `.mjs` file extension. */
+    MjsExtension = ".mjs",
+    /**
+     * The path to the `node_modules` directory.
+     */
+    NodeModules = "node_modules",
+    /** The path to the `package.json` file. */
+    PackageJson = "package.json",
+    /** The path to the `README.md` file. */
+    ReadmeMd = "README.md",
+    /** The path to the root directory. */
+    RootDir = "/",
+    /** The path to the `scripts` directory. */
+    Scripts = "scripts",
+    /** The path to the `src` directory. */
+    Src = "src",
+    /** The path to the `_dependencies.ts` file within the `src` directory. */
+    SrcDependenciesTs = "./src/_dependencies.ts",
+    /** The path to the `src` directory. */
+    SrcObsidianTypesDataview = "src/obsidian/@types/Dataview",
+    /** The path to the `static` directory. */
+    Static = "static",
+    /** The path to the `styles` directory. */
+    Styles = "styles",
+    /** The path to the `styles.css` file. */
+    StylesCss = "styles.css",
+    /** The path to the `tsconfig.json` file. */
+    TsConfigJson = "tsconfig.json",
+    /** The `.ts` file extension. */
+    TsExtension = ".ts",
+    /** The path to the `@types` directory, typically used for TypeScript type declarations. */
+    Types = "@types"
+}

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

@@ -1 +1,67 @@
-export * from '../../cjs/ScriptUtils/Root.cjs';
+/**
+ * @packageDocumentation Root
+ * Contains utility functions for executing commands from the root directory of a project,
+ * resolving paths relative to the root.
+ */
+import type { ExecOption, ExecResult } from './Exec.d.mts';
+/**
+ * Executes a command from the root directory of the project.
+ *
+ * @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 execFromRoot(command: string | string[], options?: {
+    withDetails?: false;
+} & ExecOption): Promise<string>;
+/**
+ * Executes a command from the root directory of the project.
+ *
+ * @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 execFromRoot(command: string | string[], options: {
+    withDetails: true;
+} & ExecOption): Promise<ExecResult>;
+/**
+ * Retrieves the root directory of the project.
+ *
+ * @param cwd - The current working directory to resolve from.
+ * @returns The path to the root directory.
+ * @throws If the root directory cannot be found.
+ */
+export declare function getRootDir(cwd?: string): null | string;
+/**
+ * Resolves a path relative to the root directory of the project.
+ *
+ * @param path - The path to resolve.
+ * @param cwd - The current working directory to resolve from.
+ * @returns The resolved absolute path.
+ */
+export declare function resolvePathFromRoot(path: string, cwd?: string): null | string;
+/**
+ * Resolves a path relative to the root directory, returning the resolved path or the original path if it does not exist.
+ *
+ * @param path - The path to resolve.
+ * @param cwd - The current working directory to resolve from.
+ * @returns The resolved path or the original path if it does not exist.
+ */
+export declare function resolvePathFromRootSafe(path: string, cwd?: string): string;
+/**
+ * Converts an absolute path to a relative path from the root directory of the project.
+ *
+ * @param path - The absolute path to convert.
+ * @param cwd - The current working directory to resolve from.
+ * @returns The relative path from the root directory.
+ */
+export declare function toRelativeFromRoot(path: string, cwd?: string): null | string;

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

@@ -1 +1,41 @@
-export * from '../../cjs/ScriptUtils/build.cjs';
+/**
+ * @packageDocumentation build
+ * This module provides utility functions to handle the build process for static assets and cleaning
+ * the build output directory. It includes functions to copy static files to the distribution directory
+ * and to remove the existing build output.
+ */
+/**
+ * Removes the distribution directory and its contents.
+ *
+ * This function deletes the entire distribution directory to ensure a clean build environment.
+ *
+ * @returns A promise that resolves when the directory has been removed.
+ */
+export declare function buildClean(): Promise<void>;
+/**
+ * Compiles the code.
+ *
+ * @returns A promise that resolves when the code compiles successfully.
+ */
+export declare function buildCompile(): Promise<void>;
+/**
+ * Compiles the Svelte code.
+ *
+ * @returns A promise that resolves when the code compiles successfully.
+ */
+export declare function buildCompileSvelte(): Promise<void>;
+/**
+ * Compiles the TypeScript code.
+ *
+ * @returns A promise that resolves when the code compiles successfully.
+ */
+export declare function buildCompileTypeScript(): Promise<void>;
+/**
+ * Copies all static files from the static assets directory to the distribution directory.
+ *
+ * This function recursively reads the contents of the static assets directory and copies
+ * each file to the corresponding path in the distribution directory.
+ *
+ * @returns A promise that resolves when all files have been copied.
+ */
+export declare function buildStatic(): Promise<void>;

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

@@ -1 +1,14 @@
-export * from '../../cjs/ScriptUtils/cli.cjs';
+/**
+ * @packageDocumentation cli
+ * This module defines a CLI for managing various tasks related to Obsidian plugin development.
+ * It leverages the `commander` library to define commands for building, linting, spellchecking,
+ * and updating the version of the plugin. The CLI is designed to be flexible and can handle both
+ * synchronous and asynchronous tasks.
+ */
+/**
+ * Main function to run the CLI. It sets up the commands using the `commander` library and
+ * handles the execution of tasks like building, cleaning, linting, spellchecking, and versioning.
+ *
+ * @param argv - The command-line arguments to parse. Defaults to `process.argv` minus the first two elements.
+ */
+export declare function cli(argv?: string[]): void;

package/dist/lib/esm/ScriptUtils/esbuild/Dependency.d.mts

@@ -1 +1,18 @@
-export * from '../../../cjs/ScriptUtils/esbuild/Dependency.cjs';
+/**
+ * @packageDocumentation Dependency
+ * This module provides utilities for managing dependencies during the esbuild process.
+ * It includes functions to determine which dependencies should be skipped and which
+ * should be bundled, as well as an esbuild plugin for extracting dependencies to bundle.
+ */
+/**
+ * Determines which dependencies should be bundled by esbuild.
+ *
+ * @returns A `Promise` that resolves to an array of dependency names to bundle.
+ */
+export declare function getDependenciesToBundle(): Promise<string[]>;
+/**
+ * Retrieves the list of dependencies that should be skipped during the bundling process.
+ *
+ * @returns A `Promise` that resolves to a `Set` of dependency names to skip.
+ */
+export declare function getDependenciesToSkip(): Promise<Set<string>>;

package/dist/lib/esm/ScriptUtils/esbuild/ObsidianPluginBuilder.d.mts

@@ -1 +1,53 @@
-export * from '../../../cjs/ScriptUtils/esbuild/ObsidianPluginBuilder.cjs';
+/**
+ * @packageDocumentation ObsidianPluginBuilder
+ * This module provides functionality to build and bundle an Obsidian plugin using esbuild.
+ * It includes functions to handle the build process based on different build modes (development or production),
+ * and it sets up various esbuild plugins to preprocess, lint, fix source maps, and copy files to the Obsidian plugins folder.
+ */
+import type { BuildContext, Plugin } from 'esbuild';
+import { CliTaskResult } from '../CliUtils.d.mts';
+/**
+ * Enumeration representing the build modes.
+ */
+export declare enum BuildMode {
+    /** Development mode for building the plugin */
+    Development = 0,
+    /** Production mode for building the plugin */
+    Production = 1
+}
+/**
+ * Banner text to be included at the top of the generated files.
+ */
+export declare const banner = "/*\nTHIS IS A GENERATED/BUNDLED FILE BY ESBUILD\nif you want to view the source, please visit the github repository of this plugin\n*/\n";
+/**
+ * Options for building an Obsidian plugin.
+ */
+export interface BuildObsidianPluginOptions {
+    /**
+     * Custom esbuild plugins to be used during the build process.
+     */
+    customEsbuildPlugins?: Plugin[];
+    /**
+     * The build mode, either Development or Production
+     */
+    mode: BuildMode;
+    /**
+     * The directory for Obsidian configuration. Defaults to the `OBSIDIAN_CONFIG_DIR` environment variable.
+     */
+    obsidianConfigDir?: string;
+}
+/**
+ * Builds the Obsidian plugin based on the specified mode and configuration directory.
+ *
+ * @param options - The parameters for building the plugin.
+ * @returns A promise that resolves to a `TaskResult` indicating the success or failure of the build.
+ */
+export declare function buildObsidianPlugin(options: BuildObsidianPluginOptions): Promise<CliTaskResult>;
+/**
+ * Invokes the build process with the provided build context.
+ *
+ * @param buildContext - The build context generated by esbuild.
+ * @param isProductionBuild - A boolean indicating whether the build is a production build.
+ * @returns A promise that resolves to a `TaskResult` indicating the success or failure of the build.
+ */
+export declare function invokeEsbuild(buildContext: BuildContext, isProductionBuild: boolean): Promise<CliTaskResult>;

package/dist/lib/esm/ScriptUtils/esbuild/changeExtensionPlugin.d.mts

@@ -1 +1,12 @@
-export * from '../../../cjs/ScriptUtils/esbuild/changeExtensionPlugin.cjs';
+/**
+ * @packageDocumentation changeExtensionPlugin
+ * This module defines an esbuild plugin that changes the extension of JavaScript files after the build process.
+ */
+import type { Plugin } from 'esbuild';
+/**
+ * Creates an esbuild plugin that changes the extension of JavaScript files after the build process.
+ *
+ * @param extension - The extension to change the files to.
+ * @returns An esbuild `Plugin` object that handles the renaming and modification of output files.
+ */
+export declare function changeExtensionPlugin(extension: string): Plugin;

package/dist/lib/esm/ScriptUtils/esbuild/copyToObsidianPluginsFolderPlugin.d.mts

@@ -1 +1,18 @@
-export * from '../../../cjs/ScriptUtils/esbuild/copyToObsidianPluginsFolderPlugin.cjs';
+/**
+ * @packageDocumentation copyToObsidianPluginsFolderPlugin
+ * This module defines an esbuild plugin that automatically copies the build output
+ * to the Obsidian plugins folder during development. This plugin helps streamline
+ * the development workflow by ensuring that the latest build is always available
+ * in the correct Obsidian directory for testing and use.
+ */
+import type { Plugin } from 'esbuild';
+/**
+ * Creates an esbuild plugin that copies the build output to the Obsidian plugins folder.
+ *
+ * @param isProductionBuild - A boolean indicating whether the build is a production build.
+ * @param distDir - The directory where the built files are located.
+ * @param obsidianConfigDir - The directory of the Obsidian configuration. If not provided, the plugin will not copy files.
+ * @param pluginName - The name of the Obsidian plugin.
+ * @returns An esbuild `Plugin` object.
+ */
+export declare function copyToObsidianPluginsFolderPlugin(isProductionBuild: boolean, distDir: string, obsidianConfigDir: string, pluginName: string): Plugin;

package/dist/lib/esm/ScriptUtils/esbuild/fixEsmPlugin.d.mts

@@ -1 +1,11 @@
-export * from '../../../cjs/ScriptUtils/esbuild/fixEsmPlugin.cjs';
+/**
+ * @packageDocumentation fixEsmPlugin
+ * This module defines a custom esbuild plugin that fixes the `require` statement for ESM modules.
+ */
+import type { Plugin } from 'esbuild';
+/**
+ * Creates an esbuild plugin that fixes the `require` statement for ESM modules.
+ *
+ * @returns An esbuild `Plugin` object that fixes the `require` statement for ESM modules.
+ */
+export declare function fixEsmPlugin(): Plugin;

package/dist/lib/esm/ScriptUtils/esbuild/fixSourceMapsPlugin.d.mts

@@ -1 +1,17 @@
-export * from '../../../cjs/ScriptUtils/esbuild/fixSourceMapsPlugin.cjs';
+/**
+ * @packageDocumentation fixSourceMapsPlugin
+ * This module defines an esbuild plugin that fixes source maps generated during development.
+ * It adjusts the paths in the source maps to be compatible with Obsidian's internal URL scheme.
+ * The plugin is only active during development builds.
+ */
+import type { Plugin } from 'esbuild';
+/**
+ * Creates an esbuild plugin that fixes source maps by adjusting the paths to be compatible
+ * with Obsidian's internal URL scheme.
+ *
+ * @param isProductionBuild - A boolean indicating whether the build is a production build. The plugin only runs in non-production builds.
+ * @param distPaths - The paths to the output files containing the source maps.
+ * @param pluginName - The name of the Obsidian plugin, used to construct the Obsidian-specific URLs.
+ * @returns An esbuild `Plugin` object that fixes source maps.
+ */
+export declare function fixSourceMapsPlugin(isProductionBuild: boolean, distPaths: string[], pluginName: string): Plugin;

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

@@ -1 +1,9 @@
-export * from '../../../cjs/ScriptUtils/esbuild/index.cjs';
+export * as changeExtensionPlugin from './changeExtensionPlugin.d.mts';
+export * as copyToObsidianPluginsFolderPlugin from './copyToObsidianPluginsFolderPlugin.d.mts';
+export * as Dependency from './Dependency.d.mts';
+export * as fixEsmPlugin from './fixEsmPlugin.d.mts';
+export * as fixSourceMapsPlugin from './fixSourceMapsPlugin.d.mts';
+export * as ObsidianPluginBuilder from './ObsidianPluginBuilder.d.mts';
+export * as preprocessPlugin from './preprocessPlugin.d.mts';
+export * as renameCssPlugin from './renameCssPlugin.d.mts';
+export * as svelteWrapperPlugin from './svelteWrapperPlugin.d.mts';

package/dist/lib/esm/ScriptUtils/esbuild/preprocessPlugin.d.mts

@@ -1 +1,23 @@
-export * from '../../../cjs/ScriptUtils/esbuild/preprocessPlugin.cjs';
+/**
+ * @packageDocumentation preprocessPlugin
+ * This module defines a custom esbuild plugin that preprocesses JavaScript and TypeScript files.
+ * The preprocessing includes replacing `import(dot)meta(dot)url` with a Node.js-compatible alternative,
+ * ensuring compatibility with Obsidian's plugin system, and adding a basic `process` object for environments
+ * where `process` is not available (like mobile or web environments).
+ *
+ * @remarks
+ * We cannot use `.` instead of `(dot)` in the above description because the file itself is preprocessed with the same rule.
+ */
+import type { Plugin } from 'esbuild';
+/**
+ * Creates an esbuild plugin that preprocesses JavaScript and TypeScript files.
+ *
+ * This plugin performs the following tasks:
+ * - Replaces instances of `import(dot)meta(dot)url` with a Node.js-compatible `__filename` alternative.
+ * - Modifies the `sourceMappingURL` comment to ensure compatibility with Obsidian's plugin system.
+ * - Adds a basic `process` object to the global scope if `process` is referenced but not defined.
+ *
+ * @param isEsm - Whether the build is for an ESM format.
+ * @returns An esbuild `Plugin` object that handles the preprocessing.
+ */
+export declare function preprocessPlugin(isEsm?: boolean): Plugin;

package/dist/lib/esm/ScriptUtils/esbuild/renameCssPlugin.d.mts

@@ -1 +1,8 @@
-export * from '../../../cjs/ScriptUtils/esbuild/renameCssPlugin.cjs';
+import type { Plugin } from 'esbuild';
+/**
+ * Plugin that renames the CSS file to the correct name.
+ *
+ * @param distDir - The directory to rename the CSS file in.
+ * @returns The plugin.
+ */
+export declare function renameCssPlugin(distDir: string): Plugin;

package/dist/lib/esm/ScriptUtils/esbuild/svelteWrapperPlugin.d.mts

@@ -1 +1,8 @@
-export * from '../../../cjs/ScriptUtils/esbuild/svelteWrapperPlugin.cjs';
+import type { Plugin } from 'esbuild';
+/**
+ * Wraps the esbuild-svelte plugin to ensure that the correct format is used.
+ *
+ * @param isProductionBuild - Whether the build is a production build.
+ * @returns The esbuild plugin.
+ */
+export declare function svelteWrapperPlugin(isProductionBuild: boolean): Plugin;

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

@@ -1 +1,10 @@
-export * from '../../cjs/ScriptUtils/format.cjs';
+/** @packageDocumentation format
+ * Format the source code.
+ */
+/**
+ * Format the source code.
+ *
+ * @param rewrite - Whether to rewrite the source code.
+ * @returns A promise that resolves when the source code has been formatted.
+ */
+export declare function format(rewrite?: boolean): Promise<void>;

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

@@ -1 +1,17 @@
-export * from '../../cjs/ScriptUtils/index.cjs';
+export * as build from './build.d.mts';
+export * as cli from './cli.d.mts';
+export * as CliUtils from './CliUtils.d.mts';
+export * as CodeGenerator from './CodeGenerator.d.mts';
+export * as esbuild from './esbuild/index.d.mts';
+export * as ESLint from './ESLint/index.d.mts';
+export * as Exec from './Exec.d.mts';
+export * as format from './format.d.mts';
+export * as Fs from './Fs.d.mts';
+export * as JSON from './JSON.d.mts';
+export * as NodeModules from './NodeModules.d.mts';
+export * as Npm from './Npm.d.mts';
+export * as NpmPublish from './NpmPublish.d.mts';
+export * as ObsidianDevUtilsRepoPaths from './ObsidianDevUtilsRepoPaths.d.mts';
+export * as Root from './Root.d.mts';
+export * as spellcheck from './spellcheck.d.mts';
+export * as version from './version.d.mts';

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

@@ -1 +1,14 @@
-export * from '../../cjs/ScriptUtils/spellcheck.cjs';
+/**
+ * @packageDocumentation spellcheck
+ * This module provides a function for running a spellcheck on the codebase using the `cspell` library.
+ * It reports any spelling issues found in the code and returns a `TaskResult` indicating whether the spellcheck was successful.
+ */
+/**
+ * Runs a spellcheck on the entire codebase using `cspell`.
+ *
+ * The function checks all files in the current directory and its subdirectories for spelling issues.
+ * If issues are found, they are logged to the console with their file path, line, and column number.
+ *
+ * @returns A `Promise` that resolves to a `TaskResult`, indicating the success or failure of the spellcheck.
+ */
+export declare function spellcheck(): Promise<void>;