ObsidianDevUtilsRepoPaths
Enumeration of common file paths and patterns used in the Obsidian development utilities repository.
Import:
import type { ObsidianDevUtilsRepoPaths } from 'obsidian-dev-utils/script-utils/obsidian-dev-utils-repo-paths';Signature:
export enum ObsidianDevUtilsRepoPathsMembers:
| Member | Value | Description |
|---|---|---|
Any | '*' | Any file or folder. |
AnyCjs | '*.cjs' | CommonJS file. |
AnyDcts | '*.d.cts' | CommonJS TypeScript declaration file. |
AnyDmts | '*.d.mts' | ESM TypeScript declaration file. |
AnyDts | '*.d.ts' | TypeScript declaration file. |
AnyMjs | '*.mjs' | ESM JavaScript file. |
AnyPath | '**' | Any path recursively. |
AnyTs | '*.ts' | Any TypeScript file. |
AstroConfigTs | 'astro.config.ts' | Astro configuration file (documentation site) at the repo root. |
BatExtension | '.bat' | Windows batch file extension. |
Bin | '.bin' | Folder holding the executable shims of locally-installed packages. |
BunLock | 'bun.lock' | Bun lockfile. |
BunLockb | 'bun.lockb' | Binary bun lockfile, written by bun before v1.2. |
Cjs | 'cjs' | CommonJS folder. |
CjsExtension | '.cjs' | CommonJS file extension. |
CommandExtension | '.cmd' | Windows command script extension. |
CurrentFolder | '.' | Current folder. |
DataviewTypes | 'src/obsidian/@types/dataview/**' | Dataview types. |
DctsExtension | '.d.cts' | CommonJS TypeScript declaration file extension. |
Dist | 'dist' | Distribution folder. |
DistDemoVaultHelper | 'dist/demo-vault-helper' | A path to the built demo-vault-helper plugin within the Dist folder, injected into demo vaults at release time. |
DistIntegrationTestPlugin | 'dist/integration-test-plugin' | A path to the built integration-test harness plugin within the Dist folder, seeded into a consumer’s integration-test vault so its evalInObsidian closures reach the library via lib. |
DistLib | 'dist/lib' | A path to the lib folder within the Dist folder. |
DistPluginApiTestConsumer | 'dist/plugin-api-test-consumer' | A path to the built plugin-API integration-test CONSUMER plugin within the Dist folder. Test-only and never shipped; built separately from its provider so the two carry distinct obsidian-dev-utils copies. |
DistPluginApiTestProvider | 'dist/plugin-api-test-provider' | A path to the built plugin-API integration-test PROVIDER plugin within the Dist folder. Test-only and never shipped; built separately from its consumer so the two carry distinct obsidian-dev-utils copies. |
DistTemplates | 'dist/templates' | A path to the templates folder within the Dist folder, holding the consumer-facing templates. |
DjsExtension | '.d.js' | Transpiled TypeScript declaration file extension. |
DmtsExtension | '.d.mts' | ESM TypeScript declaration file extension. |
Docs | 'docs' | Documentation site folder (Astro + Starlight API-docs sub-project). |
DocsDist | 'docs/dist' | Build output folder of the documentation site. |
DprintJson | 'dprint.json' | Dprint configuration file. |
DtsExtension | '.d.ts' | TypeScript declaration file extension. |
EslintConfigMts | 'eslint.config.mts' | ESM TypeScript ESLint configuration file. |
Esm | 'esm' | ESM JavaScript folder. |
ExeExtension | '.exe' | Windows executable extension. |
GeneratedDuringBuildCjs | 'generated-during-build.cjs' | Generated-during-build CommonJS file. |
GeneratedDuringBuildMjs | 'generated-during-build.mjs' | Generated-during-build ESM JavaScript file. |
IndexCjs | 'index.cjs' | CommonJS JavaScript index file. |
IndexDcts | 'index.d.cts' | CommonJS TypeScript declaration file index file. |
IndexDmts | 'index.d.mts' | ESM TypeScript declaration file index file. |
IndexMjs | 'index.mjs' | ESM JavaScript index file. |
IndexTs | 'index.ts' | TypeScript index file. |
IntegrationTestPluginApiConsumer | 'integration-test-plugin-api/consumer' | A path to the sources of the plugin-API integration-test CONSUMER plugin. |
IntegrationTestPluginApiProvider | 'integration-test-plugin-api/provider' | A path to the sources of the plugin-API integration-test PROVIDER plugin. |
JsExtension | '.js' | JavaScript file extension. |
MarkdownlintCli2ConfigMjs | '.markdownlint-cli2.mjs' | ESM Markdownlint CLI2 configuration file. |
MarkdownlintTypesMarkdownlintCli2ConfigSchemaDts | 'src/script-utils/linters/markdownlint-types/@types/markdownlint-cli2-config-schema.d.ts' | Markdownlint CLI2 configuration schema TypeScript declaration file. |
MergedTs | '__merged.ts' | Generated flat re-export barrel file. |
MjsExtension | '.mjs' | ESM JavaScript file extension. |
NodeModules | 'node_modules' | Node modules folder. |
PackageJson | 'package.json' | Package JSON file. |
PackageLockJson | 'package-lock.json' | NPM lockfile. |
Patches | 'patches' | Folder holding hand-written patched copies of third-party packages. |
PnpmLockYaml | 'pnpm-lock.yaml' | Pnpm lockfile. |
RootFolder | '/' | Root folder. |
Scripts | 'scripts' | Scripts folder. |
ScriptUtils | 'script-utils' | ScriptUtils folder. |
Src | 'src' | Source folder. |
Styles | 'styles' | Styles folder. |
StylesCss | 'styles.css' | Styles CSS file. |
Templates | 'templates' | Templates folder. |
TestHelpers | 'test-helpers' | Test helpers folder. |
TsConfigJson | 'tsconfig.json' | TypeScript configuration file. |
TsConfigValidateDeclarationsCjsJson | 'tsconfig.validate-declarations-cjs.json' | TypeScript configuration file that validates the generated CommonJS declarations. |
TsConfigValidateDeclarationsJson | 'tsconfig.validate-declarations.json' | TypeScript configuration file that validates the generated ESM declarations. |
TsExtension | '.ts' | TypeScript file extension. |
Types | '@types' | Types folder. |
YarnLock | 'yarn.lock' | Yarn lockfile. |