Imported from mnaoumov/obsidian-root-folder-context-menu (AGENTS.md). Install upstream with npx skills add mnaoumov/obsidian-root-folder-context-menu. Copyright stays with the author.

AGENTS.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Overview

Root Folder Context Menu enables the right-click context menu for the vault root folder in Obsidian's File Explorer, which Obsidian normally only offers for non-root folders. It is built on obsidian-dev-utils.

Commands

Architecture

• Root config files are thin re-exports — actual logic lives in scripts/ (eslint.config.mts → scripts/eslint-config.ts, etc.).
• src/ — plugin source:
  • main.ts — Obsidian entry point (default export of Plugin).
  • plugin.ts — Plugin extends PluginBase; its onloadImpl adds the RootFolderContextMenuComponent child.
  • root-folder-context-menu-component.ts — LayoutReadyComponent holding the core logic: resolves the File Explorer plugin/view (disabling itself if File Explorer is off), wires contextmenu handlers on the root anchor and nav-files container, filters disallowed items (move/delete/copy/rename/search) out of the root folder's file-menu, and reloads the File Explorer.
    • The root anchor is per-platform — ROOT_ANCHOR_SELECTORS is tried in order: .workspace-drawer-vault-switcher (the vault profile at the bottom of the desktop left sidebar, built inside if (isDesktopApp)) then .workspace-drawer-header-name (the vault-name row at the top of the mobile left drawer). The class name of the first reads mobile but the element is desktop-only, which is how the mobile half stayed broken unnoticed; the nav-files hook is nested inside the anchor's if, so a null anchor kills both listeners at once. Both platforms are covered end-to-end by plugin.desktop.integration.test.ts / plugin.android.integration.test.ts.
  • patches/file-explorer-view-open-file-context-menu-patch-component.ts — MonkeyAroundComponent that monkey-patches FileExplorerView.openFileContextMenu so the root TFolder is temporarily treated as non-root, making Obsidian build the context menu for it.
• main field points to src/main.ts (Obsidian plugin source entry; built artifact is dist/build/main.js, not published to npm).