# snezhig/obsidian-front-matter-title architecture

> Architecture diagram of the GitHub repository snezhig/obsidian-front-matter-title, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/snezhig/obsidian-front-matter-title
- Repository: https://github.com/snezhig/obsidian-front-matter-title

## Overview

##### Project type and purpose
- This is an Obsidian plugin written in TypeScript. Its job is to take the YAML front-matter in a Markdown file and display a custom “title” (or other front-matter value) instead of the filename in Obsidian’s Explorer and Graph views.

##### File structure
- Top-level:
- config/ – Inversify DI container setup and service-binding configurations
- src/ – Core plugin code under these major areas:
· Components – low-level building blocks (EventDispatcher, Cache, Processor, Extractor, ApiAdapter, etc.)
· Creator – assembles the display title from template definitions and placeholders
· Feature – each Obsidian feature (Explorer, Graph, Backlink, NoteLink, etc.) lives here, managed by FeatureService
· Resolver – reads front-matter values using strategies (ArrayStrategy, BooleanStrategy, etc.)
· Settings – settings UI (SettingsTab) and builder patterns to construct plugin options
· Obsidian – a façade abstracting Obsidian API calls
· Storage/Migrator – persistent storage and version migration handlers
· i18n – localization support for multiple languages
- main.ts – plugin entrypoint (Obsidian’s onload/onunload hooks)
- utils/ – bundling and release scripts (esbuild, pack, version bump)
- modules/api-provider – optional external API provider integration

##### README for additional insights
- Confirms it is strictly a client-side Obsidian plugin, no backend or external server.
- Major feature: templating engine for “title” extraction.
- Points to docs/ for details on Features, Processors, TemplateExamples.

a. Main Components
1. Obsidian Platform
2. FrontMatterTitlePlugin (main.ts & App.ts)
3. DI Container (config/inversify.config.ts)
4. Core Services:
- EventDispatcher
- Resolver (with cached proxy)
- Creator (Template Factory / Composite)
- Processor pipeline
- Cache
- Storage & Migrator
5. FeatureService & FeatureComposer (registers all AbstractFeature implementations)
6. Individual Feature Modules (ExplorerManager, GraphManager, NoteLinkFeature, etc.)
7. Settings UI (SettingsTab + FeatureBuilder / SettingBuilders)
8. i18n module
9. Optional API Adapter & external API provider module
b. Relationships & Data Flows
- Plugin onload → initialize DI container → bind interfaces to implementations
- DI Container → instantiate core services & FeatureService & SettingsService
- Plugin registers SettingsTab and FeatureService listeners in Obsidian API
- User action/file events in Obsidian → EventDispatcher → FeatureService
- FeatureService → for each enabled feature: uses Resolver to read front-matter → Creator to build display string → EventDispatcher or directly calls ObsidianFacade to update UI
- SettingsTab changes → SettingBuilders → update SettingsService → propagate to FeatureService or Processor configurations
- i18n used by UI components and Features to render localized labels
- Cache used by Resolver/Creator to avoid redundant computations
c. Architectural Patterns & Design Principles
- Dependency Injection (Inversify) for loose coupling
- Observer / Event Dispatcher for decoupled event handling
- Strategy pattern in Resolver/Extractor strategies
- Composite + Factory in Template Placeholders (Simple, Composite, BracketsPlaceholder, etc.)
- Builder pattern in Settings (FeatureBuilder, SettingBuilders)
- Proxy pattern in ResolverCachedProxy
d. Key Technologies / Frameworks
- TypeScript
- Inversify (DI)
- Obsidian API (plugin SDK)
- esbuild (bundling)
- Jest (unit tests)

##### Detail
- Both static structure (packages, classes) and dynamic flows (event dispatch, service calls)
- Don’t omit patterns: label “Strategy”, “Composite”, “Observer” where they occur

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Infra Layer
    subgraph "Plugin Lifecycle"
        direction TB
        Plugin["FrontMatterTitlePlugin"]:::infra
        ObsidianFacade["ObsidianFacade"]:::infra
        DIContainer["DI Container"]:::infra
    end

    %% Core Services
    subgraph "Core Services"
        direction TB
        EventDispatcher["EventDispatcher"]:::core
        subgraph "Resolver Services"
            direction TB
            ResolverService["ResolverService"]:::core
            Resolver["Resolver"]:::core
            ResolverProxy["ResolverCachedProxy"]:::core
        end
        Creator["Creator"]:::core
        TemplateFactory["Template Factory"]:::core
        ProcessorPipeline["Processor Pipeline"]:::core
        FunctionProcessor["FunctionProcessor"]:::core
        ReplaceProcessor["ReplaceProcessor"]:::core
        CacheService["Cache"]:::core
        StorageService["Storage"]:::core
        MigratorService["Migrator"]:::core
    end

    %% Feature Modules
    subgraph "Feature Modules"
        direction TB
        FeatureService["FeatureService"]:::feature
        FeatureComposer["FeatureComposer"]:::feature
        ManagerComposer["ManagerComposer"]:::feature
        ExplorerManager["ExplorerManager"]:::feature
        GraphManager["GraphManager"]:::feature
        NoteLinkFeature["NoteLinkFeature"]:::feature
    end

    %% UI/Settings
    subgraph "Settings & UI"
        direction TB
        SettingsTab["SettingsTab"]:::ui
        FeatureBuilder["FeatureBuilder"]:::ui
        SettingBuilders["SettingBuilders"]:::ui
    end

    %% Localization & API
    subgraph "Localization & API"
        direction TB
        I18n["i18n Module"]:::ui
        APIAdapter["ApiAdapter"]:::infra
        APIProvider["External API Provider"]:::infra
    end

    %% Connections
    Plugin -->|onload| DIContainer
    Plugin -->|uses| ObsidianFacade
    DIContainer --> EventDispatcher
    DIContainer --> ResolverService
    DIContainer --> Creator
    DIContainer --> ProcessorPipeline
    DIContainer --> CacheService
    DIContainer --> StorageService
    DIContainer --> MigratorService
    DIContainer --> FeatureService
    DIContainer --> SettingsTab
    DIContainer --> I18n

    EventDispatcher --> FeatureService
    FeatureService --> FeatureComposer
    FeatureService --> ManagerComposer
    ManagerComposer --> ExplorerManager
    ManagerComposer --> GraphManager
    ManagerComposer --> NoteLinkFeature

    FeatureService -->|for each feature| Resolver
    Resolver --> ResolverProxy
    ResolverProxy --> ResolverService
    FeatureService -->|build title| Creator
    Creator --> TemplateFactory
    Creator --> ProcessorPipeline
    ProcessorPipeline --> FunctionProcessor
    ProcessorPipeline --> ReplaceProcessor
    Creator --> CacheService
    ExplorerManager --> ObsidianFacade
    GraphManager --> ObsidianFacade
    NoteLinkFeature --> ObsidianFacade

    SettingsTab --> SettingsTabChange[Settings Change Event]
    SettingsTabChange --> FeatureBuilder
    SettingsTabChange --> SettingBuilders
    FeatureBuilder --> FeatureService
    SettingBuilders --> ProcessorPipeline

    I18n --> SettingsTab
    I18n --> ExplorerManager
    I18n --> GraphManager
    I18n --> NoteLinkFeature

    APIAdapter --> APIProvider

    %% Click Events
    click ObsidianFacade "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Obsidian/ObsidianFacade.ts"
    click Plugin "https://github.com/snezhig/obsidian-front-matter-title/blob/master/main.ts"
    click Plugin "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/App.ts"
    click DIContainer "https://github.com/snezhig/obsidian-front-matter-title/blob/master/config/inversify.config.ts"
    click EventDispatcher "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Components/EventDispatcher/EventDispatcher.ts"
    click Resolver "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Resolver/Resolver.ts"
    click ResolverProxy "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Resolver/ResolverCachedProxy.ts"
    click ResolverService "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Resolver/ResolverService.ts"
    click Creator "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Creator/Creator.ts"
    click TemplateFactory "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Creator/Template/Factory.ts"
    click FunctionProcessor "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Components/Processor/FunctionProcessor.ts"
    click ReplaceProcessor "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Components/Processor/ReplaceProcessor.ts"
    click CacheService "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Components/Cache/Cache.ts"
    click StorageService "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Storage/Storage.ts"
    click MigratorService "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Migrator/Migrator.ts"
    click FeatureService "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Feature/FeatureService.ts"
    click FeatureComposer "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Feature/FeatureComposer.ts"
    click ManagerComposer "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Feature/ManagerComposer.ts"
    click ExplorerManager "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Feature/Explorer/ExplorerManager.ts"
    click GraphManager "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Feature/Graph/GraphManager.ts"
    click NoteLinkFeature "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Feature/NoteLink/NoteLinkFeature.ts"
    click SettingsTab "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Settings/SettingsTab.ts"
    click FeatureBuilder "https://github.com/snezhig/obsidian-front-matter-title/tree/master/src/Settings/FeatureBuilder"
    click SettingBuilders "https://github.com/snezhig/obsidian-front-matter-title/tree/master/src/Settings/SettingBuilders"
    click I18n "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/i18n/Locale.ts"
    click APIAdapter "https://github.com/snezhig/obsidian-front-matter-title/blob/master/src/Components/ApiAdapter/Api.ts"
    click APIProvider "https://github.com/snezhig/obsidian-front-matter-title/tree/master/modules/api-provider"

    %% Styles
    classDef core fill:#bbdefb,stroke:#1e88e5,stroke-width:1px
    classDef feature fill:#c8e6c9,stroke:#43a047,stroke-width:1px
    classDef ui fill:#ffe0b2,stroke:#fb8c00,stroke-width:1px
    classDef infra fill:#e1bee7,stroke:#8e24aa,stroke-width:1px
```
