obsidian-dev-utils/dist/lib/cjs/ScriptUtils/ObsidianDevUtilsRepoPaths.d.cts

This is the collection of useful functions that you can use for your Obsidian plugin development

/**
 * @packageDocumentation
 *
 * 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.
 */
/**
 * Enumeration of common file paths and patterns used in the Obsidian development utilities repository.
 */
export declare enum ObsidianDevUtilsRepoPaths {
    /** Any file or folder. */
    Any = "*",
    /** CommonJS file. */
    AnyCjs = "*.cjs",
    /** CommonJS TypeScript declaration file. */
    AnyDcts = "*.d.cts",
    /** ESM TypeScript declaration file. */
    AnyDmts = "*.d.mts",
    /** TypeScript declaration file. */
    AnyDts = "*.d.ts",
    /** ESM JavaScript file. */
    AnyMjs = "*.mjs",
    /** Any path recursively. */
    AnyPath = "**",
    /** Any TypeScript file. */
    AnyTs = "*.ts",
    /** CommonJS folder. */
    Cjs = "cjs",
    /** CommonJS file extension. */
    CjsExtension = ".cjs",
    /** Current folder. */
    CurrentFolder = ".",
    /** Dataview types. */
    DataviewTypes = "src/obsidian/@types/Dataview/**",
    /** CommonJS TypeScript declaration file extension. */
    DctsExtension = ".d.cts",
    /** Distribution folder. */
    Dist = "dist",
    /** A path to the `lib` folder within the {@link Dist} folder. */
    DistLib = "dist/lib",
    /** Transpiled TypeScript declaration file extension. */
    DjsExtension = ".d.js",
    /** ESM TypeScript declaration file extension. */
    DmtsExtension = ".d.mts",
    /** Dprint configuration file. */
    DprintJson = "dprint.json",
    /** TypeScript declaration file extension. */
    DtsExtension = ".d.ts",
    /** ESM TypeScript ESLint configuration file. */
    EslintConfigMts = "eslint.config.mts",
    /** ESM JavaScript folder. */
    Esm = "esm",
    /** CommonJS JavaScript index file. */
    IndexCjs = "index.cjs",
    /** CommonJS TypeScript declaration file index file. */
    IndexDcts = "index.d.cts",
    /** ESM TypeScript declaration file index file. */
    IndexDmts = "index.d.mts",
    /** ESM JavaScript index file. */
    IndexMjs = "index.mjs",
    /** TypeScript index file. */
    IndexTs = "index.ts",
    /** JavaScript file extension. */
    JsExtension = ".js",
    /** Library CommonJS file. */
    LibraryCjs = "Library.cjs",
    /** Library ESM JavaScript file. */
    LibraryMjs = "Library.mjs",
    /** ESM Markdownlint CLI2 configuration file. */
    MarkdownlintCli2ConfigMjs = ".markdownlint-cli2.mjs",
    /** ESM TypeScript Markdownlint CLI2 configuration file. */
    MarkdownlintCli2ConfigMts = ".markdownlint-cli2.mts",
    /** ESM JavaScript file extension. */
    MjsExtension = ".mjs",
    /** Node modules folder. */
    NodeModules = "node_modules",
    /** Package JSON file. */
    PackageJson = "package.json",
    /** Root folder. */
    RootFolder = "/",
    /** Scripts folder. */
    Scripts = "scripts",
    /** Source folder. */
    Src = "src",
    /** Static folder. */
    Static = "static",
    /** Styles folder. */
    Styles = "styles",
    /** Styles CSS file. */
    StylesCss = "styles.css",
    /** TypeScript configuration file. */
    TsConfigJson = "tsconfig.json",
    /** TypeScript file extension. */
    TsExtension = ".ts",
    /** Types folder. */
    Types = "@types"
}