Skip to content
Obsidian Dev Toolkit
v3.7.0
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Guides
Getting started
Bundlers
CI and Release
Commands
Demo Vault
End-to-end Testing
Testing
API reference
bundlers
esbuild-impl
copy-to-obsidian-plugins-folder-plugin
Overview
copyToObsidianPluginsFolderPlugin
CopyToObsidianPluginsFolderPluginParams
dependency
Overview
getDependenciesToBundle
getDependenciesToSkip
feature-options
Overview
EsbuildFeatureBuildOptions
getEsbuildFeatureBuildOptions
GetEsbuildFeatureBuildOptionsParams
getEsbuildFeaturePlugins
GetEsbuildFeaturePluginsParams
getSassPluginOptionsList
GetSassPluginOptionsListParams
fix-source-maps-plugin
Overview
fixSourceMapsPlugin
FixSourceMapsPluginParams
obsidian-plugin-builder
Overview
banner
build
buildObsidianPlugin
BuildObsidianPluginParams
BuildOptions
dev
invokeEsbuild
preprocess-plugin
Overview
preprocessPlugin
rename-css-plugin
Overview
renameCssPlugin
obsidian-cli-reload
Overview
OBSIDIAN_CLI_COMMAND
reloadPluginWithObsidianCli
ReloadPluginWithObsidianCliParams
obsidian-plugin-build
Overview
BuildMode
cleanObsidianPluginDistFolder
completeObsidianPluginDistFolder
CssAsset
getObsidianPluginBanner
getObsidianPluginDistFolder
getObsidianPluginEntryPoint
isCssFileName
isObsidianPluginExternal
mergeCssAssets
MergeCssAssetsResult
OBSIDIAN_PLUGIN_EXTERNALS
OBSIDIAN_PLUGIN_RUNTIME_MODULES
ObsidianPluginBuildContext
ObsidianPluginDeploymentOptions
ObsidianPluginReload
resolveFromRoot
resolveObsidianPluginBuildContext
ResolveObsidianPluginBuildContextParams
obsidian-plugin-features
Overview
FeatureFileKind
getFeatureFileKind
getFrameworkDefines
GetFrameworkDefinesParams
getJsxImportSource
importOptionalPeer
ImportOptionalPeerParams
isCssModuleFile
isPostcssNeeded
ObsidianPluginFeatureOptions
ObsidianPluginFramework
ObsidianPluginStylesOptions
replaceDefines
requireOptionalPeer
RequireOptionalPeerParams
resolveOptionalPeer
ResolveOptionalPeerParams
obsidian-plugin-transforms
Overview
appendInlineSourceMap
getCssModuleCode
getWasmModuleCode
loadPostcssConfig
LoadPostcssConfigParams
PostcssConfig
SourceMapLike
transformCss
TransformCssParams
TransformedCss
TransformedModule
transformJsx
TransformJsxParams
TransformModuleParams
transformSolid
TransformSolidParams
transformSvelte
TransformSvelteParams
obsidian-plugin-webpack-loader
Overview
obsidianPluginWebpackLoader
ObsidianPluginWebpackLoaderKind
ObsidianPluginWebpackLoaderOptions
raw
obsidian-plugins-folder-deployment
Overview
deployToObsidianPluginsFolder
DeployToObsidianPluginsFolderParams
parcel
Overview
build
buildObsidianPluginWithParcel
BuildObsidianPluginWithParcelParams
BuildOptions
dev
getParcelConfigFiles
GetParcelConfigFilesParams
getParcelOptions
GetParcelOptionsParams
ParcelConfigFiles
rollup
Overview
applyRollupInputDefaults
ApplyRollupInputDefaultsParams
applyRollupOutputDefaults
ApplyRollupOutputDefaultsParams
obsidianPluginRollup
ObsidianPluginRollupOptions
rollup-compatible
Overview
AssetEmitter
BundleOutputLike
CombinedExternalFunction
combineExternal
EmittedCssAsset
ExternalFunction
ExternalLike
ExternalPattern
renameCssAssets
rollup-compatible-features
Overview
createRollupCompatibleFeaturePlugin
CreateRollupCompatibleFeaturePluginParams
createUnpluginVuePlugin
CreateUnpluginVuePluginParams
FeaturePluginContext
RollupCompatibleFeaturePlugin
vite
Overview
getViteBuildMode
getViteConfigDefaults
getViteFeatureConfig
GetViteFeatureConfigParams
obsidianPluginVite
ObsidianPluginViteOptions
webpack
Overview
getWebpackBuildMode
getWebpackFeatureRules
GetWebpackFeatureRulesParams
obsidianPluginWebpackExternals
ObsidianPluginWebpackPlugin
ObsidianPluginWebpackPluginOptions
demo-vault
Overview
archivePluginDemoVault
demo-vault-app-json
Overview
buildArchivedDemoVaultAppJsonContent
BuildArchivedDemoVaultAppJsonContentParams
DEMO_VAULT_APP_JSON_SETTINGS
DemoVaultAppJson
findOwnedDemoVaultAppJsonSettings
FindOwnedDemoVaultAppJsonSettingsParams
parseDemoVaultAppJson
ParseDemoVaultAppJsonParams
demo-vault-buttons
Overview
assertClickBudgetsFitTransportCap
ClickButtonTimeouts
CODE_SCRIPT_TOOLKIT_PLUGIN_ID
countRenderedButtons
DemoVaultButtonResult
DemoVaultNote
ExpectedNonOkButton
findDuplicateCaptions
formatFailures
listNotesWithButtons
listRenderedButtonCaptions
registerDemoVaultButtonSuite
RegisterDemoVaultButtonSuiteOptions
selectUnexpectedFailures
demo-vault-cli
Overview
runArchiveDemoVaultCli
demo-vault-coverage
Overview
DemoVaultAuthoringSpec
DemoVaultCheckSeverity
DemoVaultConfigInterfaceCoverageSpec
DemoVaultCoverageChecker
DemoVaultCoverageCheckerConstructorParams
DemoVaultCoverageCheckerFindStaleReferencesParams
DemoVaultCoverageCheckerFindUndemonstratedMembersParams
DemoVaultCoverageCheckerFindUnlinkedFeatureDocsParams
DemoVaultCoverageCheckerFindUnreachableNotesParams
DemoVaultCoverageCheckerGetExportedFunctionNamesParams
DemoVaultCoverageCheckerGetInterfaceMembersParams
DemoVaultDocsCoverageSpec
DemoVaultFunctionsCoverageSpec
DemoVaultInterfaceCoverageSpec
DemoVaultInterfaceMemberKind
DemoVaultNonTrivialGuardSpec
DemoVaultNote
DirectiveScan
DirectiveScanState
InterfaceMembers
NoteLine
OpenDirectiveRegion
OpenWikilinkDirectiveRegion
registerDemoVaultCoverageSuite
RegisterDemoVaultCoverageSuiteParams
WikilinkDirectiveScan
WikilinkDirectiveScanState
docs-site
obsidian-external-type-links
Overview
OBSIDIAN_EXTERNAL_TYPE_LINKS
formatters
dprint
Overview
format
linters
eslint
Overview
lint
eslint-config
Overview
defineEslintConfigs
eslint-rules
manifest-description
Overview
manifestDescription
MESSAGE_ID_CONTAINS_OBSIDIAN
MESSAGE_ID_MISSING_PERIOD
MESSAGE_ID_NOT_CAPITALIZED
MESSAGE_ID_SELF_REFERENCE
MESSAGE_ID_TOO_LONG
MESSAGE_ID_TOO_SHORT
manifest-helpers
Overview
findManifestMember
getManifestObject
getManifestStringValue
getMemberKey
getStringValue
JSON_NODE_TYPE_BOOLEAN
JSON_NODE_TYPE_OBJECT
JSON_NODE_TYPE_STRING
JsonDocumentNode
JsonLiteralNode
JsonMemberNode
JsonNode
JsonObjectNode
jsonPlugin
toReportNode
UNRELEASED_VERSION
manifest-id
Overview
manifestId
MESSAGE_ID_CONTAINS_OBSIDIAN
MESSAGE_ID_ENDS_WITH_PLUGIN
MESSAGE_ID_INVALID_CHARACTERS
manifest-name
Overview
manifestName
MESSAGE_ID_CONTAINS_OBSIDIAN
MESSAGE_ID_CONTAINS_PLUGIN
MESSAGE_ID_INVALID_CHARACTERS
manifest-schema
Overview
manifestSchema
MESSAGE_ID_DISALLOWED_KEY
MESSAGE_ID_DUPLICATE_KEY
MESSAGE_ID_EMPTY_FUNDING_URL
MESSAGE_ID_INVALID_FUNDING_URL
MESSAGE_ID_INVALID_TYPE
MESSAGE_ID_MISSING_KEY
MESSAGE_ID_MUST_BE_ROOT_OBJECT
no-local-obsidian-internals
Overview
MESSAGE_ID
noLocalObsidianInternals
no-over-cap-wait-in-eval-in-obsidian
Overview
MESSAGE_ID
noOverCapWaitInEvalInObsidian
no-untrusted-input-events
Overview
MESSAGE_ID
noUntrustedInputEvents
obsidian-dev-toolkit-plugin
Overview
OBSIDIAN_DEV_TOOLKIT_ESLINT_PLUGIN_NAME
obsidianDevToolkitPlugin
plugin-name-as-code
Overview
MESSAGE_ID
PLUGIN_NAME_RULE_SCHEMA
pluginNameAsCode
plugin-name-as-code-in-ui
Overview
MESSAGE_ID
pluginNameAsCodeInUi
require-component-suffix
Overview
MESSAGE_ID_ABSTRACT_NEEDS_BASE
MESSAGE_ID_BASE_NOT_ABSTRACT
MESSAGE_ID_MISSING_SUFFIX
requireComponentSuffix
require-plugin-api-contract-schemas
Overview
MESSAGE_ID
requirePluginApiContractSchemas
markdownlint
Overview
lint
markdownlint-cli2-config
Overview
obsidianMarkdownlintCli2Config
markdownlint-rules
plugin-name-as-code
Overview
PLUGIN_NAME_AS_CODE_RULE_NAME
pluginNameAsCodeRule
obsidianmd-rule-custom-message
Overview
RULE_CUSTOM_MESSAGE_RULE_NAME
stripOwnedRuleCustomMessageEntries
StripOwnedRuleCustomMessageEntriesParams
plugin-names
Overview
findPluginNameMatches
getPluginNames
GetPluginNamesParams
MNAOUMOV_PLUGIN_NAMES
PluginNameMatch
PluginNameRuleOptions
THIRD_PARTY_PLUGIN_NAMES
obsidian-plugin-repo-paths
Overview
ObsidianPluginRepoPaths
templates
Overview
getTemplateFilePath
test-runners
coverage-badge
Overview
CoverageBadgeMetric
CoverageCount
CoverageTotals
generateCoverageBadge
GenerateCoverageBadgeOptions
GenerateCoverageBadgeResult
getCoverageBadgeColor
getCoveragePercent
parseLcovTotals
renderCoverageBadgeSvg
RenderCoverageBadgeSvgParams
coverage-badge-cli
Overview
parseCoverageBadgeArguments
runCoverageBadgeCli
e2e-runner-support
Overview
assertProjectPackagesInstalled
AssertProjectPackagesInstalledParams
DEFAULT_END_TO_END_SPECS
integration-test-plugin
Overview
getIntegrationTestPluginPopulate
OBSIDIAN_DEV_TOOLKIT_INTEGRATION_TEST_PLUGIN_ID
registerIntegrationTestLibResolver
jest-config
Overview
defineObsidianPluginJestConfig
DefineObsidianPluginJestConfigOptions
OBSIDIAN_JEST_INTEGRATION_TEST_PATH_IGNORE_PATTERN
OBSIDIAN_JEST_MODULE_NAME_MAPPER
OBSIDIAN_JEST_SETUP_FILES_AFTER_ENV
obsidian-test-runner
Overview
testEndToEndWithObsidianTest
TestEndToEndWithObsidianTestOptions
performance-eval-cap
Overview
DEFAULT_EVAL_CAP_IN_MILLISECONDS
DESKTOP_PERFORMANCE_TEST_FILE_SUFFIX
PERFORMANCE_EVAL_CAP_IN_MILLISECONDS
vitest-config
Overview
defineObsidianPluginVitestConfig
DefineObsidianPluginVitestConfigOptions
INTEGRATION_TEST_TIMEOUT_IN_MILLISECONDS
ObsidianPluginVitestConfigContext
ObsidianPluginVitestProjectConfig
ObsidianPluginVitestReporter
wdio-obsidian
Overview
DEFAULT_WDIO_OBSIDIAN_TEST_TIMEOUT_IN_MILLISECONDS
defineWdioObsidianConfig
DefineWdioObsidianConfigOptions
testEndToEndWithWdioObsidian
TestEndToEndWithWdioObsidianOptions
WDIO_CONFIG_FILE_NAMES
WdioObsidianCapability
WdioObsidianCapabilityOptions
WdioObsidianConfig
WdioObsidianMochaOptions
version
Overview
copyUpdatedManifest
DesktopReleasesJson
Manifest
ParsedVersionArguments
parseVersionArguments
updateVersion
UpdateVersionOptions
GitHub
Select theme
Dark
Light
Auto
GetParcelOptionsParams.configPath
GetParcelOptionsParams
› configPath
Type:
string
The generated
.parcelrc
.