mirror of
https://github.com/m-kk/toc.git
synced 2026-07-22 06:44:17 +00:00
🔧 fix: address remaining Obsidian community plugin review feedback
Addresses all outstanding review comments from PR #7753: 1. README: Added "Why This Plugin?" section explaining key differences from other TOC solutions (frontmatter tracking, no visible markers, cache integration, smart positioning) 2. Frontmatter: Replaced manual parsing with MetadataCache API - Now uses getFileCache(file)?.frontmatter to read frontmatter - Uses frontmatterPosition from cache for content splitting - Removed manual parseFrontmatter method (59 lines) - Removed unused FRONTMATTER_PATTERN constant 3. Settings: Removed redundant "Usage" heading per Obsidian guidelines - Kept usage information text without heading wrapper Note: Items already addressed in previous commits: - CSS colors: No hardcoded colors present - Style overrides: Minimal styling with justification - Debounce: Using Obsidian's built-in debounce (imported line 13) - Vault API: Using vault.process (line 401) - Frontmatter updates: Using processFrontMatter (line 393) - Position detection: Using frontmatterPosition from cache (lines 407, 488) Code reduction: -59 lines (removed manual YAML parsing) Build status: ✓ TypeScript compilation successful 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
m-kk
parent
582729fb08
commit
24254ea092
2 changed files with 32 additions and 59 deletions
11
README.md
11
README.md
|
|
@ -2,6 +2,17 @@
|
|||
|
||||
A modern Obsidian plugin that generates clean, trackable table of contents using frontmatter metadata. Creates invisible TOC markers without cluttering your source view, with advanced configuration options and automatic updates.
|
||||
|
||||
## Why This Plugin?
|
||||
|
||||
This plugin differs from other TOC solutions in several key ways:
|
||||
|
||||
- **Frontmatter-Based Tracking**: Uses YAML frontmatter instead of HTML comments for TOC state management, keeping your source view clean and readable
|
||||
- **No Visible Markers**: Unlike plugins that insert HTML comments (`<!-- TOC -->`) visible in source mode, this plugin's TOC tracking is completely invisible
|
||||
- **Metadata Cache Integration**: Leverages Obsidian's built-in metadata cache system for efficient heading detection and frontmatter management
|
||||
- **Smart Positioning**: Automatically places TOC at the document start or after the last H1 heading, intelligently adapting to your document structure
|
||||
- **Duplicate Heading Support**: Correctly handles duplicate headings using Obsidian's native linking format with space separators
|
||||
- **Security Hardened**: Includes ReDoS protection for user-provided regex patterns to prevent performance issues
|
||||
|
||||
<a href="https://www.buymeacoffee.com/mattkk" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
|
||||
|
||||
## Features
|
||||
|
|
|
|||
80
main.ts
80
main.ts
|
|
@ -32,8 +32,6 @@ const TOC_CONTENT_PATTERNS = [
|
|||
/^ {2}-\s+[^[].+$/ // Indented plain text
|
||||
] as const;
|
||||
|
||||
const FRONTMATTER_PATTERN = /^---\s*\n([\s\S]*?)\n---\s*\n/;
|
||||
|
||||
interface TOCSettings {
|
||||
tocTitle: string;
|
||||
excludeH1: boolean;
|
||||
|
|
@ -532,22 +530,34 @@ export default class TableOfContentsPlugin extends Plugin {
|
|||
|
||||
|
||||
private insertOrUpdateTOC(content: string, toc: string, file: TFile): string {
|
||||
const { frontmatter, contentWithoutFrontmatter } = this.frontmatterManager.parseFrontmatter(content);
|
||||
|
||||
// Use Obsidian's metadata cache to read frontmatter
|
||||
const cache = this.app.metadataCache.getFileCache(file);
|
||||
const existingFrontmatter = cache?.frontmatter || {};
|
||||
|
||||
// Create a copy to avoid mutating cached data
|
||||
const frontmatter = { ...existingFrontmatter };
|
||||
|
||||
// Update frontmatter with TOC metadata
|
||||
const tocMetadata: TOCMetadata = {
|
||||
generated: true,
|
||||
lastUpdate: new Date().toISOString()
|
||||
};
|
||||
|
||||
|
||||
frontmatter[TOC_CONFIG.FRONTMATTER_KEY] = tocMetadata;
|
||||
|
||||
|
||||
// Get content without frontmatter using frontmatterPosition from cache
|
||||
const frontmatterEnd = cache?.frontmatterPosition?.end?.line ?? -1;
|
||||
const lines = content.split('\n');
|
||||
const contentWithoutFrontmatter = frontmatterEnd >= 0
|
||||
? lines.slice(frontmatterEnd + 1).join('\n')
|
||||
: content;
|
||||
|
||||
// Remove existing TOC if present
|
||||
const contentWithoutTOC = this.removeTOCFromContent(contentWithoutFrontmatter);
|
||||
|
||||
|
||||
// Insert new TOC at optimal position (position 0 or after last H1)
|
||||
const contentWithNewTOC = this.insertTOCAtOptimalPosition(contentWithoutTOC, toc, file, content);
|
||||
|
||||
|
||||
// Rebuild content with updated frontmatter
|
||||
return this.frontmatterManager.buildContentWithFrontmatter(frontmatter, contentWithNewTOC);
|
||||
}
|
||||
|
|
@ -722,13 +732,12 @@ class TOCSettingTab extends PluginSettingTab {
|
|||
|
||||
|
||||
|
||||
// Usage information
|
||||
new Setting(containerEl).setName('Usage').setHeading();
|
||||
containerEl.createEl('p', {
|
||||
// Usage information (no heading per Obsidian guidelines)
|
||||
containerEl.createEl('p', {
|
||||
text: 'Use the command "Generate table of contents" or click the ribbon icon to insert a table of contents at the optimal position (top of document or after the last H1 heading). ' +
|
||||
'The table of contents is tracked using frontmatter metadata for clean, invisible state management.'
|
||||
});
|
||||
|
||||
|
||||
containerEl.createEl('p', {
|
||||
text: 'To manually update an existing table of contents, simply run the command again. ' +
|
||||
'With auto-update enabled, the table of contents will refresh automatically as you edit.',
|
||||
|
|
@ -814,53 +823,6 @@ class HeadingParser {
|
|||
// New service classes for enhanced functionality
|
||||
|
||||
class FrontmatterManager {
|
||||
parseFrontmatter(content: string): { frontmatter: Record<string, unknown>, contentWithoutFrontmatter: string } {
|
||||
const frontmatterMatch = FRONTMATTER_PATTERN.exec(content);
|
||||
|
||||
if (!frontmatterMatch) {
|
||||
return { frontmatter: {}, contentWithoutFrontmatter: content };
|
||||
}
|
||||
|
||||
const frontmatterText = frontmatterMatch[1];
|
||||
const matchLength = frontmatterMatch[0]?.length || 0;
|
||||
const contentWithoutFrontmatter = content.substring(matchLength);
|
||||
|
||||
try {
|
||||
// Simple YAML parser for basic key-value pairs
|
||||
const frontmatter: Record<string, unknown> = {};
|
||||
const lines = (frontmatterText || '').split('\n');
|
||||
|
||||
for (const line of lines) {
|
||||
const colonIndex = line.indexOf(':');
|
||||
if (colonIndex > 0) {
|
||||
const key = line.substring(0, colonIndex).trim();
|
||||
const value = line.substring(colonIndex + 1).trim();
|
||||
|
||||
// Basic value parsing
|
||||
if (value === 'true') frontmatter[key] = true;
|
||||
else if (value === 'false') frontmatter[key] = false;
|
||||
else if (/^\d+$/.test(value)) frontmatter[key] = parseInt(value);
|
||||
else if (value.startsWith('"') && value.endsWith('"')) {
|
||||
frontmatter[key] = value.slice(1, -1);
|
||||
} else if (value.startsWith('{') || value.startsWith('[')) {
|
||||
try {
|
||||
frontmatter[key] = JSON.parse(value);
|
||||
} catch {
|
||||
frontmatter[key] = value;
|
||||
}
|
||||
} else {
|
||||
frontmatter[key] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return { frontmatter, contentWithoutFrontmatter };
|
||||
} catch (error) {
|
||||
console.error('Error parsing frontmatter:', error);
|
||||
return { frontmatter: {}, contentWithoutFrontmatter: content };
|
||||
}
|
||||
}
|
||||
|
||||
buildContentWithFrontmatter(frontmatter: Record<string, unknown>, content: string): string {
|
||||
if (Object.keys(frontmatter).length === 0) {
|
||||
return content;
|
||||
|
|
|
|||
Loading…
Reference in a new issue