ObsidianPluginRepoPaths

Enumeration of commonly used file and folder paths in Obsidian plugin development.

Import:

import type { ObsidianPluginRepoPaths } from 'obsidian-dev-utils/obsidian/plugin/obsidian-plugin-repo-paths';

Signature:

export enum ObsidianPluginRepoPaths

Members:

Member	Value	Description
`AnyCjs`	`'*.cjs'`	CommonJS file.
`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.
`ChangelogMd`	`'CHANGELOG.md'`	Changelog file.
`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.
`DistDev`	`'dist/dev'`	Development folder within the `Dist` folder.
`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.
`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.