mirror of
https://github.com/rmellmer/obsidian-link-range.git
synced 2026-07-22 07:40:31 +00:00
Compare commits
No commits in common. "master" and "2.0.0" have entirely different histories.
4 changed files with 117 additions and 184 deletions
2
main.ts
2
main.ts
|
|
@ -27,7 +27,7 @@ export default class LinkRange extends Plugin {
|
|||
// wait for layout to be ready
|
||||
this.app.workspace.onLayoutReady(() => {
|
||||
this.registerEditorExtension(ViewPlugin.define((v) => {
|
||||
return new LifePreviewEmbedReplacer(v, this.settings, this.app)
|
||||
return new LifePreviewEmbedReplacer(this.settings, this.app)
|
||||
}));
|
||||
|
||||
const ext = Prec.lowest(buildCMViewPlugin(this.app, this.settings));
|
||||
|
|
|
|||
132
src/embeds.ts
132
src/embeds.ts
|
|
@ -2,105 +2,69 @@ import { App, MarkdownRenderer, setIcon, TFile } from "obsidian";
|
|||
import { LinkRangeSettings } from "./settings";
|
||||
import { checkLink } from "./utils";
|
||||
|
||||
// Simple string hash for cache key generation (djb2)
|
||||
function hashString(str: string): string {
|
||||
let hash = 5381;
|
||||
for (let i = 0; i < str.length; i++) {
|
||||
hash = ((hash << 5) + hash + str.charCodeAt(i)) | 0;
|
||||
}
|
||||
return hash.toString(36);
|
||||
}
|
||||
|
||||
export async function replaceEmbed(app: App, embed: Node, settings: LinkRangeSettings, isMarkdownPost = false) {
|
||||
let embedHtml = embed as HTMLElement
|
||||
// Keep a reference to the original outer element for cache key storage
|
||||
const outerElement = embedHtml;
|
||||
|
||||
const res = checkLink(app, embedHtml, settings, true, "src");
|
||||
|
||||
const isLinkRange = res !== null && res.h2 !== undefined;
|
||||
const file = res?.file
|
||||
if (isLinkRange && file !== undefined) {
|
||||
if (isLinkRange) {
|
||||
const { vault } = app;
|
||||
const foundNote : TFile | undefined = app.vault.getMarkdownFiles().filter(
|
||||
x => x.basename == res.note
|
||||
).first()
|
||||
|
||||
// Read file content first so we can include a content hash in the
|
||||
// cache key. This ensures we re-render when the source text changes
|
||||
// even if the heading line numbers stay the same.
|
||||
const fileContent = await vault.cachedRead(file);
|
||||
let lines = fileContent.split("\n");
|
||||
lines = lines.slice(res.h1Line, res.h2Line);
|
||||
const contentText = lines.join("\n");
|
||||
|
||||
const cacheKey = `${file.path}:${res.h1Line}:${res.h2Line}:${hashString(contentText)}`;
|
||||
// Check the cache key on the outer element (works for both live preview
|
||||
// and markdown post-processor paths)
|
||||
const prevKey = outerElement.getAttribute("data-link-range-key");
|
||||
if (prevKey === cacheKey) {
|
||||
// Already rendered with the same content — bail out
|
||||
return;
|
||||
}
|
||||
|
||||
// Guard against async race: another call may have started rendering
|
||||
// while we were awaiting cachedRead. If so, let the newer one win.
|
||||
// We use a generation counter stored on the element.
|
||||
const generation = (parseInt(outerElement.getAttribute("data-link-range-gen") || "0") || 0) + 1;
|
||||
outerElement.setAttribute("data-link-range-gen", generation.toString());
|
||||
|
||||
embedHtml.childNodes.forEach(x => {
|
||||
x.remove()
|
||||
})
|
||||
|
||||
const linkRange = embedHtml.querySelectorAll("div.link-range-embed")
|
||||
|
||||
linkRange.forEach(x => {
|
||||
x.remove()
|
||||
})
|
||||
|
||||
if (isMarkdownPost) {
|
||||
// prevent default embed functionality for markdown post processor
|
||||
embedHtml.removeClasses(["internal-embed"])
|
||||
// create a child div under embedHtml to place content inside
|
||||
embedHtml = embedHtml.createDiv({
|
||||
cls: ["internal-embed", "markdown-embed", "inline-embed", "is-loaded", "link-range-embed"]
|
||||
if (foundNote) {
|
||||
embedHtml.childNodes.forEach(x => {
|
||||
x.remove()
|
||||
})
|
||||
}
|
||||
|
||||
embedHtml.setText("")
|
||||
const linkRange = embedHtml.querySelectorAll("div.link-range-embed")
|
||||
|
||||
embedHtml.createEl("h2", {
|
||||
text: res.altText
|
||||
})
|
||||
linkRange.forEach(x => {
|
||||
x.remove()
|
||||
})
|
||||
|
||||
const linkDiv = embedHtml.createDiv({
|
||||
cls: ["markdown-embed-link"],
|
||||
});
|
||||
if (isMarkdownPost) {
|
||||
// prevent default embed functionality for markdown post processor
|
||||
embedHtml.removeClasses(["internal-embed"])
|
||||
// create a child div under embedHtml to place content inside
|
||||
embedHtml = embedHtml.createDiv({
|
||||
cls: ["internal-embed", "markdown-embed", "inline-embed", "is-loaded", "link-range-embed"]
|
||||
})
|
||||
}
|
||||
|
||||
setIcon(linkDiv, 'link')
|
||||
embedHtml.setText("")
|
||||
|
||||
linkDiv.onClickEvent((ev: MouseEvent) => {
|
||||
const leaf = app.workspace.getMostRecentLeaf();
|
||||
leaf?.openFile(file, {
|
||||
state: {
|
||||
scroll: res.h1Line
|
||||
}
|
||||
embedHtml.createEl("h2", {
|
||||
text: res.altText
|
||||
})
|
||||
|
||||
const linkDiv = embedHtml.createDiv({
|
||||
cls: ["markdown-embed-link"],
|
||||
});
|
||||
})
|
||||
|
||||
// Post-await race guard: if a newer render kicked off while we were
|
||||
// waiting, abort this one so the newer render wins.
|
||||
const currentGen = parseInt(outerElement.getAttribute("data-link-range-gen") || "0") || 0;
|
||||
if (currentGen !== generation) {
|
||||
return;
|
||||
setIcon(linkDiv, 'link')
|
||||
|
||||
linkDiv.onClickEvent((ev: MouseEvent) => {
|
||||
const leaf = app.workspace.getMostRecentLeaf();
|
||||
leaf?.openFile(foundNote, {
|
||||
state: {
|
||||
scroll: res.h1Line
|
||||
}
|
||||
});
|
||||
})
|
||||
|
||||
const fileContent = await vault.cachedRead(foundNote);
|
||||
|
||||
let lines = fileContent.split("\n");
|
||||
lines = lines.slice(res.h1Line, res.h2Line);
|
||||
|
||||
const contentDiv = embedHtml.createDiv({
|
||||
cls: ["markdown-embed-content"]
|
||||
})
|
||||
|
||||
MarkdownRenderer.renderMarkdown(lines.join("\n"), contentDiv, "", null!)
|
||||
}
|
||||
|
||||
const contentDiv = embedHtml.createDiv({
|
||||
cls: ["markdown-embed-content"]
|
||||
})
|
||||
|
||||
await MarkdownRenderer.renderMarkdown(contentText, contentDiv, "", null!)
|
||||
|
||||
// Tag the outer element with the cache key so subsequent calls can
|
||||
// skip re-rendering (works for both live preview and post-processor)
|
||||
outerElement.setAttribute("data-link-range-key", cacheKey);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,17 +8,10 @@ export class LifePreviewEmbedReplacer implements PluginValue {
|
|||
decorations: DecorationSet = Decoration.none;
|
||||
settings: LinkRangeSettings;
|
||||
app: App;
|
||||
// Debounce timer to avoid hammering replaceEmbed on rapid typing
|
||||
private debounceTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
private pendingView: EditorView | null = null;
|
||||
|
||||
constructor(view: EditorView, settings: LinkRangeSettings, app: App) {
|
||||
constructor(settings: LinkRangeSettings, app: App) {
|
||||
this.settings = settings;
|
||||
this.app = app;
|
||||
// Eagerly render once on construction so embeds appear immediately
|
||||
// when opening a note or switching to live preview mode, without
|
||||
// requiring a doc change or scroll.
|
||||
this.decorations = this.buildDecorations(view);
|
||||
}
|
||||
|
||||
buildDecorations(view: EditorView): DecorationSet {
|
||||
|
|
@ -39,29 +32,8 @@ export class LifePreviewEmbedReplacer implements PluginValue {
|
|||
return;
|
||||
}
|
||||
|
||||
// Only rebuild on doc changes or viewport changes — NOT focusChanged.
|
||||
// focusChanged fires on every keystroke and caused the viewport to
|
||||
// jump because replaceEmbed() destroys and recreates the entire DOM.
|
||||
if (update.docChanged || update.viewportChanged) {
|
||||
// Debounce to avoid re-rendering embeds on every single keystroke.
|
||||
// This lets the user type freely without the viewport jumping around.
|
||||
if (this.debounceTimer) {
|
||||
clearTimeout(this.debounceTimer);
|
||||
}
|
||||
this.pendingView = update.view;
|
||||
this.debounceTimer = setTimeout(() => {
|
||||
if (this.pendingView) {
|
||||
this.decorations = this.buildDecorations(this.pendingView);
|
||||
this.pendingView = null;
|
||||
}
|
||||
this.debounceTimer = null;
|
||||
}, 300);
|
||||
if ( update.docChanged || update.viewportChanged || update.focusChanged ) {
|
||||
this.decorations = this.buildDecorations(update.view);
|
||||
}
|
||||
}
|
||||
|
||||
destroy() {
|
||||
if (this.debounceTimer) {
|
||||
clearTimeout(this.debounceTimer);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
131
src/utils.ts
131
src/utils.ts
|
|
@ -1,17 +1,19 @@
|
|||
import { App, TFile } from "obsidian";
|
||||
import { LinkRangeSettings, Pattern } from "./settings";
|
||||
import * as path from 'path';
|
||||
|
||||
export interface ParsedLink {
|
||||
note: string;
|
||||
h1: string;
|
||||
h2?: string;
|
||||
altText?: string;
|
||||
file?: TFile;
|
||||
h1Line?: number;
|
||||
h2Line?: number;
|
||||
}
|
||||
|
||||
const NOTE_PLACEHOLDER = "$note"
|
||||
const H1_PLACEHOLDER = "$h1"
|
||||
const H2_PLACEHOLDER = "$h2"
|
||||
|
||||
export function checkLinkText(href: string, settings: LinkRangeSettings): ParsedLink | null {
|
||||
const linkRegex = /([^#|]*)#?([^#|]*)?\|?(.*)?/;
|
||||
|
||||
|
|
@ -34,18 +36,19 @@ export function checkLinkText(href: string, settings: LinkRangeSettings): Parsed
|
|||
altText = matches[3]
|
||||
}
|
||||
else {
|
||||
const pattern = findPatternForFile(note, settings);
|
||||
const baseNote = path.basename(note)
|
||||
const headingVisual = pattern.headingVisual === '' ? '#' : pattern.headingVisual;
|
||||
const headingSeparatorVisual = pattern.headingSeparatorVisual === '' ? settings.headingSeparator : pattern.headingSeparatorVisual;
|
||||
let pattern = findPatternForFile(note, settings);
|
||||
|
||||
let headingVisual = pattern.headingVisual === '' ? '#' : pattern.headingVisual;
|
||||
let headingSeparatorVisual = pattern.headingSeparatorVisual === '' ? settings.headingSeparator : pattern.headingSeparatorVisual;
|
||||
|
||||
if (h2 !== undefined) {
|
||||
altText = `${baseNote}${headingVisual}${h1}${headingSeparatorVisual}${h2}`
|
||||
altText = `${note}${headingVisual}${h1}${headingSeparatorVisual}${h2}`
|
||||
}
|
||||
else {
|
||||
altText = `${baseNote}${headingVisual}${h1}`
|
||||
altText = `${note}${headingVisual}${h1}`
|
||||
}
|
||||
}
|
||||
|
||||
return { note, h1, h2, altText }
|
||||
}
|
||||
|
||||
|
|
@ -60,69 +63,63 @@ export function checkLink(app :App, linkHTML: HTMLElement, settings: LinkRangeSe
|
|||
|
||||
const alt = linkHTML.getAttribute("alt")
|
||||
|
||||
if (!res || app.metadataCache == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// non-standard alt text, must be user provided via "|"
|
||||
if (alt != null && !alt.contains(res.note)) {
|
||||
res.altText = alt
|
||||
}
|
||||
|
||||
if (!isEmbed && !linkHTML.innerText.contains(res.note)) {
|
||||
res.altText = linkHTML.innerText
|
||||
}
|
||||
|
||||
// Locate the referenced file, including partial paths
|
||||
const partialPath = res.note + ".md"
|
||||
const basePart = path.basename(res.note)
|
||||
const file : TFile | undefined = app.vault.getMarkdownFiles().filter(
|
||||
x => x.basename == basePart && x.path.endsWith(partialPath)
|
||||
).first()
|
||||
|
||||
if (!file) {
|
||||
return null
|
||||
}
|
||||
|
||||
res.file = file
|
||||
|
||||
const meta = app.metadataCache.getFileCache(file);
|
||||
|
||||
if (meta == undefined || meta?.headings == undefined) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const h1Line = meta?.headings?.filter(
|
||||
h => h.heading == res.h1
|
||||
).first()?.position.start.line;
|
||||
|
||||
let h2Line = null;
|
||||
|
||||
if (settings.endInclusive) {
|
||||
let h2LineIndex = meta?.headings?.findIndex(
|
||||
h => h.heading == res.h2
|
||||
)
|
||||
|
||||
if (meta?.headings?.length > h2LineIndex) {
|
||||
h2LineIndex += 1
|
||||
if (res && app.metadataCache != null) {
|
||||
// non-standard alt text, must be user provided via "|"
|
||||
if (alt != null && !alt.contains(res.note)) {
|
||||
res.altText = alt
|
||||
}
|
||||
|
||||
h2Line = meta?.headings?.at(h2LineIndex)?.position.end.line
|
||||
}
|
||||
else {
|
||||
h2Line = meta?.headings?.filter(
|
||||
h => h.heading == res.h2
|
||||
).first()?.position.end.line;
|
||||
if (!isEmbed && !linkHTML.innerText.contains(res.note)) {
|
||||
res.altText = linkHTML.innerText
|
||||
}
|
||||
|
||||
const foundNote : TFile | undefined = app.vault.getMarkdownFiles().filter(
|
||||
x => x.basename == res.note
|
||||
).first()
|
||||
|
||||
if (foundNote) {
|
||||
const meta = app.metadataCache.getFileCache(foundNote);
|
||||
|
||||
if (meta == undefined || meta?.headings == undefined) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const h1Line = meta?.headings?.filter(
|
||||
h => h.heading == res.h1
|
||||
).first()?.position.start.line;
|
||||
|
||||
let h2Line = null;
|
||||
|
||||
if (settings.endInclusive) {
|
||||
let h2LineIndex = meta?.headings?.findIndex(
|
||||
h => h.heading == res.h2
|
||||
)
|
||||
|
||||
if (meta?.headings?.length > h2LineIndex) {
|
||||
h2LineIndex += 1
|
||||
}
|
||||
|
||||
h2Line = meta?.headings?.at(h2LineIndex)?.position.end.line
|
||||
|
||||
}
|
||||
else {
|
||||
h2Line = meta?.headings?.filter(
|
||||
h => h.heading == res.h2
|
||||
).first()?.position.end.line;
|
||||
}
|
||||
|
||||
if (h1Line == undefined) {
|
||||
return null;
|
||||
}
|
||||
|
||||
res.h1Line = h1Line
|
||||
res.h2Line = h2Line
|
||||
|
||||
return res;
|
||||
}
|
||||
}
|
||||
|
||||
if (h1Line == undefined) {
|
||||
return null;
|
||||
}
|
||||
|
||||
res.h1Line = h1Line
|
||||
res.h2Line = h2Line
|
||||
|
||||
return res;
|
||||
return null;
|
||||
}
|
||||
|
||||
export function postProcessorUpdate(app: App) {
|
||||
|
|
|
|||
Loading…
Reference in a new issue