Skip to content

Obsidian Dev Toolkitv3.7.0

Select theme

Guides
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
- demo-vault-buttons
- demo-vault-cli
  - Overview
  - runArchiveDemoVaultCli
- demo-vault-coverage
- 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
- version

Select theme

On this page

Overview

On this page

Overview

ImportOptionalPeerParams.specifier?

ImportOptionalPeerParams › specifier?

Type: string

The module to import. Defaults to packageName.