开发Obsidian插件：如何在[[触发的内部链接建议中加入自定义数据？

要在Obsidian原生[[触发的内部链接建议中注入自定义数据，最直接的方式是通过**猴子补丁（Monkey Patch）**修改原生InternalLinkSuggest类的候选列表生成逻辑，无需重新实现整个EditorSuggest组件。

步骤1：捕获并覆写原生建议逻辑 #

在插件的onload方法中，定位原生InternalLinkSuggest类，保存其原始方法后覆写，实现自定义数据与原生建议的合并：

import { Plugin, Editor, SuggestItem } from 'obsidian';

export default class CustomLinkSuggestPlugin extends Plugin {
  private originalGetSuggestions: (query: string) => Promise<SuggestItem[]>;
  private originalOnChooseItem?: (item: SuggestItem, evt: MouseEvent | KeyboardEvent) => void;

  async onload() {
    // 定位原生InternalLinkSuggest类
    const InternalLinkSuggest = (this.app.workspace as any).editorSuggests.suggestions.find(
      (s: any) => s.constructor.name === 'InternalLinkSuggest'
    ).constructor;

    // 保存原始的候选列表生成方法
    this.originalGetSuggestions = InternalLinkSuggest.prototype.getSuggestions;

    // 覆写方法，合并自定义数据
    InternalLinkSuggest.prototype.getSuggestions = async function(query: string) {
      // 获取原生内部链接建议
      const nativeSuggestions = await this.originalGetSuggestions(query);
      // 调用自定义API获取数据（替换为你的实际逻辑）
      const customData = await fetchCustomSuggestions(query);
      // 将自定义数据转为符合原生结构的建议项
      const customSuggestions = customData.map(item => ({
        value: item.id,
        displayName: `[自定义] ${item.title}`,
        path: item.id,
        basename: item.title
      }));
      // 合并并返回结果
      return [...nativeSuggestions, ...customSuggestions];
    };

    // 可选：覆选项目选择逻辑，处理自定义项的跳转
    this.originalOnChooseItem = InternalLinkSuggest.prototype.onChooseItem;
    InternalLinkSuggest.prototype.onChooseItem = function(item: SuggestItem, evt: MouseEvent | KeyboardEvent) {
      if (item.displayName.startsWith('[自定义]')) {
        // 自定义跳转/插入逻辑，示例：插入自定义链接文本
        const editor = this.context.editor;
        editor.replaceRange(`[[${item.value}]]`, this.context.start, this.context.end);
        return;
      }
      // 非自定义项沿用原生逻辑
      this.originalOnChooseItem.call(this, item, evt);
    };
  }

  onunload() {
    // 卸载插件时恢复原生方法，避免影响其他功能
    const InternalLinkSuggest = (this.app.workspace as any).editorSuggests.suggestions.find(
      (s: any) => s.constructor.name === 'InternalLinkSuggest'
    ).constructor;
    InternalLinkSuggest.prototype.getSuggestions = this.originalGetSuggestions;
    if (this.originalOnChooseItem) {
      InternalLinkSuggest.prototype.onChooseItem = this.originalOnChooseItem;
    }
  }
}

// 示例：模拟API获取自定义建议数据
async function fetchCustomSuggestions(query: string): Promise<Array<{id: string, title: string}>> {
  // 替换为你的实际API调用或本地数据查询逻辑
  return [
    { id: 'custom-note-1', title: '自定义笔记1' },
    { id: 'custom-note-2', title: '自定义笔记2' }
  ];
}

关键注意事项 #

• 猴子补丁依赖Obsidian内部API结构，版本更新可能需要适配类名或方法名。
• 自定义建议项需匹配原生字段结构（如displayName、path），避免UI渲染异常。
• 插件卸载时必须恢复原生方法，防止污染Obsidian运行环境。

内容的提问来源于stack exchange，提问作者Dan Sto Domingo