ObsidianPluginRepoPaths
Enumeration of commonly used file and folder paths in Obsidian plugin development.
Import:
import type { ObsidianPluginRepoPaths } from '@mnaoumov/obsidian-dev-toolkit/obsidian-plugin-repo-paths';Signature:
export enum ObsidianPluginRepoPathsMembers:
| Member | Value | Description |
|---|---|---|
AnyAndroidCaptureIntegrationTestTs |
'*.android-capture.integration.test.ts' |
Any Android capture integration-test TypeScript file. |
AnyAndroidIntegrationTestTs |
'*.android.integration.test.ts' |
Any Android integration-test TypeScript file. |
AnyCjs |
'*.cjs' |
CommonJS file. |
AnyDesktopTs |
'desktop-*.ts' |
Any desktop-only TypeScript module, identified by the desktop- filename prefix. |
AnyIntegrationTestTs |
'*.integration.test.ts' |
Any integration-test TypeScript file. |
AnyJs |
'*.js' |
JavaScript file. |
AnyMjs |
'*.mjs' |
ESM JavaScript file. |
AnyPath |
'**' |
Any path recursively. |
AnyTestTs |
'*.test.ts' |
Any test TypeScript file. |
AnyTs |
'*.ts' |
TypeScript file. |
AnyTsx |
'*.tsx' |
ReactJS TypeScript file. |
AppJson |
'app.json' |
Obsidian application settings file within an Obsidian configuration folder. |
ChangelogMd |
'CHANGELOG.md' |
Changelog file. |
ClaudeWorktrees |
'.claude/worktrees' |
Claude Code’s worktree folder. git worktree add puts a second, complete checkout of the repository here, INSIDE the repository, which is the only reason a repo ever contains a copy of itself. Never source, so every linter that walks the tree has to skip it. |
CommitlintConfigTs |
'commitlint.config.ts' |
Commitlint configuration file. |
CurrentFolder |
'.' |
Current folder. |
DemoVault |
'demo-vault' |
Demo vault folder shipped in a plugin repo root. |
Dist |
'dist' |
Distribution folder. |
DistBuild |
'dist/build' |
Build folder within the Dist 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. |
DistDev |
'dist/dev' |
Development folder within the Dist folder. |
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. |
DotObsidian |
'.obsidian' |
Obsidian configuration folder within a vault. |
EslintConfigCjs |
'eslint.config.cjs' |
CommonJS ESLint configuration file. |
EslintConfigCts |
'eslint.config.cts' |
CommonJS TypeScript ESLint configuration file. |
EslintConfigJs |
'eslint.config.js' |
JavaScript ESLint configuration file. |
EslintConfigMjs |
'eslint.config.mjs' |
ESM JavaScript ESLint configuration file. |
EslintConfigMts |
'eslint.config.mts' |
ESM TypeScript ESLint configuration file. |
EslintConfigTs |
'eslint.config.ts' |
TypeScript ESLint configuration file. |
HotReload |
'.hotreload' |
Hot reload file. |
License |
'LICENSE' |
License file. |
MainCss |
'main.css' |
Main CSS file. |
MainJs |
'main.js' |
Main JavaScript file. |
MainTs |
'main.ts' |
Main TypeScript file. |
ManifestBetaJson |
'manifest-beta.json' |
Manifest file for beta releases. |
ManifestJson |
'manifest.json' |
Manifest file. |
MarkdownlintCli2ConfigCjs |
'.markdownlint-cli2.cjs' |
CommonJS Markdownlint CLI2 configuration file. |
MarkdownlintCli2ConfigJsonc |
'.markdownlint-cli2.jsonc' |
JSONC Markdownlint CLI2 configuration file. |
MarkdownlintCli2ConfigMjs |
'.markdownlint-cli2.mjs' |
ESM Markdownlint CLI2 configuration file. |
MarkdownlintCli2ConfigYaml |
'.markdownlint-cli2.yaml' |
YAML Markdownlint CLI2 configuration file. |
MarkdownlintConfigCjs |
'.markdownlint.cjs' |
CommonJS Markdownlint configuration file. |
MarkdownlintConfigJson |
'.markdownlint.json' |
JSON Markdownlint configuration file. |
MarkdownlintConfigJsonc |
'.markdownlint.jsonc' |
JSONC Markdownlint configuration file. |
MarkdownlintConfigMjs |
'.markdownlint.mjs' |
ESM Markdownlint configuration file. |
MarkdownlintConfigYaml |
'.markdownlint.yaml' |
YAML Markdownlint configuration file. |
MarkdownlintConfigYml |
'.markdownlint.yml' |
YAML Markdownlint configuration file. |
Mocks |
'src/test-helpers' |
Mocks folder. |
NodeModules |
'node_modules' |
Node modules folder. |
NpmShrinkwrapJson |
'npm-shrinkwrap.json' |
NPM shrinkwrap file. |
PackageJson |
'package.json' |
Package JSON file. |
PackageLockJson |
'package-lock.json' |
Package-lock JSON file. |
Plugins |
'plugins' |
Plugins folder within an Obsidian configuration folder. |
Scripts |
'scripts' |
Scripts folder. |
ScriptUtils |
'src/script-utils' |
Script utilities folder (dev-only tooling that runs in the consumer’s Node environment, not the Obsidian runtime). |
Src |
'src' |
Source folder. |
StylesCss |
'styles.css' |
Styles CSS file. |
Tests |
'__tests__' |
Tests folder. |
TsConfigJson |
'tsconfig.json' |
TypeScript configuration file. |
VersionsJson |
'versions.json' |
Versions JSON file. |
VitestConfigTs |
'vitest.config.ts' |
Vitest configuration file. |