Vault Intelligence

Appearance

Contributing ​

Thanks for your interest in contributing to this Obsidian plugin. This project relies on modern tooling (Node.js 22+, Vitest, ESLint Flat Config) and follows an "Agentic AI" architecture.

Getting started ​

Prerequisites ​

  • Node.js: v22.x or higher (Verified in .github/workflows/release.yml)
  • npm: v10+

Installation ​

Use npm ci to install dependencies deterministically.

bash
npm ci

Development ​

Running locally ​

To start the development build in watch mode:

bash
npm run dev

*This uses esbuild to compile changes instantly._

To test your changes in Obsidian:

  1. Install the Hot Reload plugin in a test vault.
  2. Symlink this repository into your vault's .obsidian/plugins/ directory.
  3. Add an empty .hotreload file to the root of this repo.

Linting and testing ​

We maintain high code quality standards. Please run these before pushing:

Linting ​

We use ESLint with a flat config (eslint.config.mts).

bash
npm run lint

*Fixes can often be applied automatically with --fix._

Testing ​

We use Vitest for unit and UI testing.

bash
# Run all tests
npm test

# Run tests with UI
npm run test:ui

Project structure ​

  • src/: Source code (modularized, avoiding a monolithic main.ts).
  • devs/: Developer documentation and guides.
    • devs/adr/: Architecture Decision Records. Please review these to understand key design choices.
    • devs/RELEASE_WORKFLOW.md: Details on our automated release process.
  • manifest.json: Plugin metadata.

Release process ​

We use a "Zero Memory" automated workflow. Do not manually tag releases.

To prepare a release:

bash
npm run release:prep <patch|minor|major>

See devs/RELEASE_WORKFLOW.md for the complete guide.

Agentic architecture ​

This plugin uses sophisticated agent patterns. If you are modifying the agents (Gardener, Researcher, etc.), please refer to:

  • AGENTS.md (Root)
  • devs/ARCHITECTURE.md

Security and privacy ​

  • Local first: The plugin must function offline.
  • Consent: No network calls without explicit user action.
  • Secrets: Securely handle API keys; warn users about where they are stored.

Thank you for helping us build specific, intelligent tools for Obsidian!