Compare commits
22 Commits
1.0.0-alph
...
1.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
| f4fab2593f | |||
| b395078cf0 | |||
| e495f8712f | |||
| 5a08d78dd2 | |||
| f8c7b6d53f | |||
| c2002b0cdb | |||
| f0808c0346 | |||
| c574a237ce | |||
| 8caed69151 | |||
| c4fe9d82d2 | |||
| 8ca46b911a | |||
| b6722fa3ad | |||
| 296a8de55b | |||
| 6135f7c708 | |||
| 9c14ad8c1f | |||
| c9d7aeb0c3 | |||
| 862ad9d122 | |||
| 0fbc4e352c | |||
| 0d152f3675 | |||
| 7f82902b5e | |||
| d1eb545fed | |||
| a02ebb85d5 |
34
.github/workflows/release.yml
vendored
34
.github/workflows/release.yml
vendored
@@ -27,15 +27,33 @@ jobs:
|
||||
echo "package.json: $PKG_VERSION"
|
||||
echo "manifest.json: $MANIFEST_VERSION"
|
||||
|
||||
if [ "$TAG_VERSION" != "$PKG_VERSION" ] || [ "$TAG_VERSION" != "$MANIFEST_VERSION" ]; then
|
||||
echo "❌ Version mismatch detected!"
|
||||
echo "Git tag: $TAG_VERSION"
|
||||
echo "package.json: $PKG_VERSION"
|
||||
echo "manifest.json: $MANIFEST_VERSION"
|
||||
exit 1
|
||||
fi
|
||||
# Check if this is a prerelease tag (alpha, beta, rc)
|
||||
if [[ "$TAG_VERSION" =~ -alpha\. ]] || [[ "$TAG_VERSION" =~ -beta\. ]] || [[ "$TAG_VERSION" =~ -rc\. ]]; then
|
||||
# For prerelease tags, strip the prerelease suffix and compare base version
|
||||
BASE_VERSION="${TAG_VERSION%%-*}"
|
||||
echo "Prerelease tag detected. Base version: $BASE_VERSION"
|
||||
|
||||
echo "✅ All versions match: $TAG_VERSION"
|
||||
if [ "$BASE_VERSION" != "$PKG_VERSION" ] || [ "$BASE_VERSION" != "$MANIFEST_VERSION" ]; then
|
||||
echo "❌ Base version mismatch detected!"
|
||||
echo "Git tag base: $BASE_VERSION (from $TAG_VERSION)"
|
||||
echo "package.json: $PKG_VERSION"
|
||||
echo "manifest.json: $MANIFEST_VERSION"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ Base versions match: $BASE_VERSION (prerelease: $TAG_VERSION)"
|
||||
else
|
||||
# For production releases, require exact match
|
||||
if [ "$TAG_VERSION" != "$PKG_VERSION" ] || [ "$TAG_VERSION" != "$MANIFEST_VERSION" ]; then
|
||||
echo "❌ Version mismatch detected!"
|
||||
echo "Git tag: $TAG_VERSION"
|
||||
echo "package.json: $PKG_VERSION"
|
||||
echo "manifest.json: $MANIFEST_VERSION"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ All versions match: $TAG_VERSION"
|
||||
fi
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
49
CHANGELOG.md
49
CHANGELOG.md
@@ -6,6 +6,55 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
|
||||
---
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
---
|
||||
|
||||
## [1.1.0] - 2025-10-30
|
||||
|
||||
### Added
|
||||
- **Word Count**: `create_note`, `update_note`, and `update_sections` now automatically return word count for the note content
|
||||
- Excludes YAML frontmatter and Obsidian comments (`%% ... %%`) from word count
|
||||
- Includes all other content (code blocks, inline code, headings, lists, etc.)
|
||||
- **Link Validation**: `create_note`, `update_note`, and `update_sections` now automatically validate all wikilinks and embeds
|
||||
- Validates basic wikilinks (`[[Note]]`), heading links (`[[Note#Heading]]`), and embeds (`![[file.ext]]`)
|
||||
- Categorizes links as: valid, broken notes (note doesn't exist), or broken headings (note exists but heading missing)
|
||||
- Returns detailed broken link information including line number and context snippet
|
||||
- Provides human-readable summary (e.g., "15 links: 12 valid, 2 broken notes, 1 broken heading")
|
||||
- Can be disabled via `validateLinks: false` parameter for performance-critical operations
|
||||
- **Word Count for Read Operations**: Extended word count support to read operations
|
||||
- `read_note` now automatically includes `wordCount` when returning content (with `withContent` or `parseFrontmatter` options)
|
||||
- `stat` supports optional `includeWordCount` parameter to compute word count (with performance warning)
|
||||
- `list` supports optional `includeWordCount` parameter to compute word count for all files (with performance warning)
|
||||
- All read operations use the same word counting rules as write operations (excludes frontmatter and Obsidian comments)
|
||||
- Best-effort error handling: unreadable files are skipped in batch operations without failing the entire request
|
||||
|
||||
### Changed
|
||||
- `create_note`, `update_note`, and `update_sections` response format now includes `wordCount` and optional `linkValidation` fields
|
||||
- `updateNote` now returns structured JSON response instead of simple success message (includes success, path, versionId, modified, wordCount, linkValidation)
|
||||
- `read_note` response now includes `wordCount` field when returning content
|
||||
- `stat` response includes optional `wordCount` field in metadata when `includeWordCount: true`
|
||||
- `list` response includes optional `wordCount` field for each file when `includeWordCount: true`
|
||||
- Type definitions updated: `ParsedNote` and `FileMetadata` interfaces now include optional `wordCount?: number` field
|
||||
|
||||
---
|
||||
|
||||
## [1.0.1] - 2025-10-28
|
||||
|
||||
### Fixed
|
||||
- Updated config path examples from `.obsidian/**` to `templates/**` in tool descriptions to avoid implying hardcoded configuration directory paths
|
||||
- Removed "MCP Server" from command display names per Obsidian plugin guidelines (commands now show as "Start server", "Stop server", etc.)
|
||||
- Replaced deprecated `vault.delete()` with `app.fileManager.trashFile()` to respect user's trash preferences configured in Obsidian settings
|
||||
- Extracted all inline JavaScript styles to semantic CSS classes with `mcp-*` namespace for better maintainability and Obsidian plugin compliance
|
||||
- Applied CSS extraction to notification history modal for consistency
|
||||
|
||||
### Changed
|
||||
- Command palette entries now display shorter names without redundant plugin name prefix
|
||||
- File deletion operations now respect user's configured trash location (system trash or `.trash/` folder)
|
||||
- Settings panel and notification history UI now use centralized CSS classes instead of inline styles
|
||||
|
||||
---
|
||||
|
||||
## [1.0.0] - 2025-10-26
|
||||
|
||||
### 🎉 Initial Public Release
|
||||
|
||||
213
docs/plans/2025-10-28-obsidian-review-bot-fixes-design.md
Normal file
213
docs/plans/2025-10-28-obsidian-review-bot-fixes-design.md
Normal file
@@ -0,0 +1,213 @@
|
||||
# ObsidianReviewBot Fixes Design
|
||||
|
||||
**Date:** 2025-10-28
|
||||
**Status:** Approved
|
||||
**PR:** https://github.com/obsidianmd/obsidian-releases/pull/8298
|
||||
|
||||
## Overview
|
||||
|
||||
This design addresses all required issues identified by ObsidianReviewBot for the MCP Server plugin submission to the Obsidian community plugin repository.
|
||||
|
||||
## Required Fixes
|
||||
|
||||
1. **Config path documentation** - Update hardcoded `.obsidian` examples to generic alternatives
|
||||
2. **Command naming** - Remove "MCP Server" from command display names
|
||||
3. **File deletion API** - Replace `vault.delete()` with `app.fileManager.trashFile()`
|
||||
4. **Inline styles** - Extract 90+ JavaScript style assignments to CSS with semantic class names
|
||||
|
||||
## Implementation Strategy
|
||||
|
||||
**Approach:** Fix-by-fix across files - Complete one type of fix across all affected files before moving to the next fix type.
|
||||
|
||||
**Benefits:**
|
||||
- Groups related changes together for clearer git history
|
||||
- Easier to test each fix type independently
|
||||
- Simpler code review with focused commits
|
||||
|
||||
## Fix Order and Details
|
||||
|
||||
### Fix 1: Config Path Documentation
|
||||
|
||||
**Files affected:** `src/tools/index.ts`
|
||||
|
||||
**Changes:**
|
||||
- Line 235: Update exclude pattern example from `['.obsidian/**', '*.tmp']` to `['templates/**', '*.tmp']`
|
||||
- Line 300: Same update for consistency
|
||||
|
||||
**Rationale:** Obsidian's configuration directory isn't necessarily `.obsidian` - users can configure this. Examples should use generic folders rather than system directories.
|
||||
|
||||
**Risk:** None - documentation only, no functional changes
|
||||
|
||||
### Fix 2: Command Naming
|
||||
|
||||
**Files affected:** `src/main.ts`
|
||||
|
||||
**Changes:**
|
||||
- Line 54: "Start MCP Server" → "Start server"
|
||||
- Line 62: "Stop MCP Server" → "Stop server"
|
||||
- Line 70: "Restart MCP Server" → "Restart server"
|
||||
|
||||
**Note:** Command IDs remain unchanged (stable API requirement)
|
||||
|
||||
**Rationale:** Obsidian plugin guidelines state command names should not include the plugin name itself.
|
||||
|
||||
**Risk:** Low - purely cosmetic change to command palette display
|
||||
|
||||
### Fix 3: File Deletion API
|
||||
|
||||
**Files affected:** `src/tools/note-tools.ts`
|
||||
|
||||
**Changes:**
|
||||
- Line 162: `await this.vault.delete(existingFile)` → `await this.fileManager.trashFile(existingFile)`
|
||||
- Line 546: `await this.vault.delete(file)` → `await this.fileManager.trashFile(file)`
|
||||
|
||||
**Context:**
|
||||
- Line 162: Overwrite conflict resolution when creating files
|
||||
- Line 546: Permanent delete operation (when soft=false)
|
||||
|
||||
**Rationale:** Use `app.fileManager.trashFile()` instead of direct deletion to respect user's trash preferences configured in Obsidian settings.
|
||||
|
||||
**Risk:** Medium - changes deletion behavior, requires testing both scenarios
|
||||
|
||||
**Testing:**
|
||||
- Verify overwrite conflict resolution still works
|
||||
- Verify permanent delete operation respects user preferences
|
||||
- Confirm files go to user's configured trash location
|
||||
|
||||
### Fix 4: Inline Styles to CSS
|
||||
|
||||
**Files affected:**
|
||||
- `styles.css` (add new classes)
|
||||
- `src/settings.ts` (remove inline styles, add CSS classes)
|
||||
|
||||
**New CSS Classes:**
|
||||
|
||||
```css
|
||||
/* Authentication section */
|
||||
.mcp-auth-section { margin-bottom: 20px; }
|
||||
.mcp-auth-summary {
|
||||
font-size: 1.17em;
|
||||
font-weight: bold;
|
||||
margin-bottom: 12px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
/* API key display */
|
||||
.mcp-key-display {
|
||||
padding: 12px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-family: monospace;
|
||||
font-size: 0.9em;
|
||||
word-break: break-all;
|
||||
user-select: all;
|
||||
cursor: text;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
|
||||
/* Tab navigation */
|
||||
.mcp-config-tabs {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
margin-bottom: 16px;
|
||||
border-bottom: 1px solid var(--background-modifier-border);
|
||||
}
|
||||
|
||||
.mcp-tab {
|
||||
padding: 8px 16px;
|
||||
border: none;
|
||||
background: none;
|
||||
cursor: pointer;
|
||||
border-bottom: 2px solid transparent;
|
||||
}
|
||||
|
||||
.mcp-tab-active {
|
||||
border-bottom-color: var(--interactive-accent);
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* Config display */
|
||||
.mcp-config-display {
|
||||
padding: 12px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-size: 0.85em;
|
||||
overflow-x: auto;
|
||||
user-select: text;
|
||||
cursor: text;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
/* Helper text */
|
||||
.mcp-file-path {
|
||||
padding: 8px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-family: monospace;
|
||||
font-size: 0.9em;
|
||||
margin-bottom: 12px;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-usage-note {
|
||||
font-size: 0.9em;
|
||||
color: var(--text-muted);
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* Additional utility classes */
|
||||
.mcp-heading {
|
||||
margin-top: 24px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
.mcp-container { margin-bottom: 20px; }
|
||||
|
||||
.mcp-button-group {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
.mcp-label {
|
||||
margin-bottom: 4px;
|
||||
font-size: 0.9em;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
```
|
||||
|
||||
**Changes to settings.ts:**
|
||||
- Remove all `.style.` property assignments (90+ lines)
|
||||
- Add corresponding CSS class names using `.addClass()` or `className` property
|
||||
- Preserve dynamic styling for tab active state (use conditional class application)
|
||||
|
||||
**Rationale:** Obsidian plugin guidelines require styles to be in CSS files rather than applied via JavaScript. This improves maintainability and follows platform conventions.
|
||||
|
||||
**Risk:** High - largest refactor, visual regression possible
|
||||
|
||||
**Testing:**
|
||||
- Build and load in Obsidian
|
||||
- Verify settings panel appearance unchanged in both light and dark themes
|
||||
- Test all interactive elements: collapsible sections, tabs, buttons
|
||||
- Confirm responsive behavior
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
**After each fix:**
|
||||
1. Run `npm test` - ensure no test failures
|
||||
2. Run `npm run build` - verify TypeScript compilation
|
||||
3. Check for linting issues
|
||||
|
||||
**Before final commit:**
|
||||
1. Full test suite passes
|
||||
2. Clean build with no warnings
|
||||
3. Manual smoke test of all settings UI features
|
||||
4. Visual verification in both light and dark themes
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- All 4 ObsidianReviewBot required issues resolved
|
||||
- No test regressions
|
||||
- No visual regressions in settings panel
|
||||
- Clean build with no TypeScript errors
|
||||
- Ready for PR re-submission
|
||||
555
docs/plans/2025-10-28-obsidian-review-bot-fixes.md
Normal file
555
docs/plans/2025-10-28-obsidian-review-bot-fixes.md
Normal file
@@ -0,0 +1,555 @@
|
||||
# ObsidianReviewBot Fixes Implementation Plan
|
||||
|
||||
> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.
|
||||
|
||||
**Goal:** Fix all required issues identified by ObsidianReviewBot for plugin submission to Obsidian community repository.
|
||||
|
||||
**Architecture:** Fix-by-fix approach across all affected files - complete one type of fix across all files before moving to next fix. Order: documentation → command naming → file deletion API → inline styles extraction.
|
||||
|
||||
**Tech Stack:** TypeScript, Obsidian API, CSS, Jest
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Fix Config Path Documentation
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/tools/index.ts:235`
|
||||
- Modify: `src/tools/index.ts:300`
|
||||
|
||||
**Step 1: Update first exclude pattern example (line 235)**
|
||||
|
||||
In `src/tools/index.ts`, find line 235 and change the example from `.obsidian/**` to a generic folder:
|
||||
|
||||
```typescript
|
||||
description: "Glob patterns to exclude (e.g., ['templates/**', '*.tmp']). Files matching these patterns will be skipped. Takes precedence over includes."
|
||||
```
|
||||
|
||||
**Step 2: Update second exclude pattern example (line 300)**
|
||||
|
||||
In `src/tools/index.ts`, find line 300 and make the same change:
|
||||
|
||||
```typescript
|
||||
description: "Glob patterns to exclude (e.g., ['templates/**', '*.tmp']). Takes precedence over includes."
|
||||
```
|
||||
|
||||
**Step 3: Verify changes**
|
||||
|
||||
Run: `npm run build`
|
||||
Expected: Clean build with no TypeScript errors
|
||||
|
||||
**Step 4: Commit**
|
||||
|
||||
```bash
|
||||
git add src/tools/index.ts
|
||||
git commit -m "fix: use generic folder in exclude pattern examples
|
||||
|
||||
- Replace .obsidian references with templates folder
|
||||
- Obsidian config directory can be customized by users
|
||||
- Addresses ObsidianReviewBot feedback"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 2: Fix Command Names
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/main.ts:54`
|
||||
- Modify: `src/main.ts:62`
|
||||
- Modify: `src/main.ts:70`
|
||||
|
||||
**Step 1: Update "Start MCP Server" command name**
|
||||
|
||||
In `src/main.ts`, find the command registration at line 52-58:
|
||||
|
||||
```typescript
|
||||
this.addCommand({
|
||||
id: 'start-mcp-server',
|
||||
name: 'Start server',
|
||||
callback: async () => {
|
||||
await this.startServer();
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
**Step 2: Update "Stop MCP Server" command name**
|
||||
|
||||
In `src/main.ts`, find the command registration at line 60-66:
|
||||
|
||||
```typescript
|
||||
this.addCommand({
|
||||
id: 'stop-mcp-server',
|
||||
name: 'Stop server',
|
||||
callback: async () => {
|
||||
await this.stopServer();
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
**Step 3: Update "Restart MCP Server" command name**
|
||||
|
||||
In `src/main.ts`, find the command registration at line 68-74:
|
||||
|
||||
```typescript
|
||||
this.addCommand({
|
||||
id: 'restart-mcp-server',
|
||||
name: 'Restart server',
|
||||
callback: async () => {
|
||||
await this.stopServer();
|
||||
await this.startServer();
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
**Step 4: Verify changes**
|
||||
|
||||
Run: `npm run build`
|
||||
Expected: Clean build with no TypeScript errors
|
||||
|
||||
**Step 5: Run tests**
|
||||
|
||||
Run: `npm test`
|
||||
Expected: All 716 tests pass
|
||||
|
||||
**Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/main.ts
|
||||
git commit -m "fix: remove plugin name from command display names
|
||||
|
||||
- 'Start MCP Server' → 'Start server'
|
||||
- 'Stop MCP Server' → 'Stop server'
|
||||
- 'Restart MCP Server' → 'Restart server'
|
||||
- Command IDs unchanged (stable API)
|
||||
- Addresses ObsidianReviewBot feedback"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 3: Fix File Deletion API
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/tools/note-tools.ts:162`
|
||||
- Modify: `src/tools/note-tools.ts:546`
|
||||
|
||||
**Step 1: Replace vault.delete() in overwrite scenario (line 162)**
|
||||
|
||||
In `src/tools/note-tools.ts`, find the overwrite conflict resolution code around line 157-163:
|
||||
|
||||
```typescript
|
||||
} else if (onConflict === 'overwrite') {
|
||||
// Delete existing file before creating
|
||||
const existingFile = PathUtils.resolveFile(this.app, normalizedPath);
|
||||
/* istanbul ignore next */
|
||||
if (existingFile) {
|
||||
await this.fileManager.trashFile(existingFile);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Step 2: Replace vault.delete() in permanent delete (line 546)**
|
||||
|
||||
In `src/tools/note-tools.ts`, find the permanent deletion code around line 544-547:
|
||||
|
||||
```typescript
|
||||
} else {
|
||||
// Permanent deletion
|
||||
await this.fileManager.trashFile(file);
|
||||
}
|
||||
```
|
||||
|
||||
**Step 3: Verify changes**
|
||||
|
||||
Run: `npm run build`
|
||||
Expected: Clean build with no TypeScript errors
|
||||
|
||||
**Step 4: Run tests**
|
||||
|
||||
Run: `npm test`
|
||||
Expected: All 716 tests pass (the test mocks should handle both APIs)
|
||||
|
||||
**Step 5: Run specific note-tools tests**
|
||||
|
||||
Run: `npm test -- tests/note-tools.test.ts`
|
||||
Expected: All note-tools tests pass, including:
|
||||
- createNote with onConflict='overwrite'
|
||||
- deleteNote with soft=false
|
||||
|
||||
**Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/tools/note-tools.ts
|
||||
git commit -m "fix: use fileManager.trashFile instead of vault.delete
|
||||
|
||||
- Replace vault.delete() with app.fileManager.trashFile()
|
||||
- Respects user's trash preferences in Obsidian settings
|
||||
- Applies to both overwrite conflicts and permanent deletes
|
||||
- Addresses ObsidianReviewBot feedback"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 4: Extract Inline Styles to CSS
|
||||
|
||||
**Files:**
|
||||
- Modify: `styles.css` (add new classes)
|
||||
- Modify: `src/settings.ts` (remove inline styles, add CSS classes)
|
||||
|
||||
**Step 1: Add CSS classes to styles.css**
|
||||
|
||||
Append the following CSS classes to `styles.css`:
|
||||
|
||||
```css
|
||||
/* MCP Settings Panel Styles */
|
||||
|
||||
/* Authentication section */
|
||||
.mcp-auth-section {
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.mcp-auth-summary {
|
||||
font-size: 1.17em;
|
||||
font-weight: bold;
|
||||
margin-bottom: 12px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
/* API key display */
|
||||
.mcp-api-key-container {
|
||||
margin-bottom: 20px;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.mcp-button-group {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
.mcp-key-display {
|
||||
padding: 12px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-family: monospace;
|
||||
font-size: 0.9em;
|
||||
word-break: break-all;
|
||||
user-select: all;
|
||||
cursor: text;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
|
||||
/* Headings and containers */
|
||||
.mcp-heading {
|
||||
margin-top: 24px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
.mcp-container {
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
/* Tab navigation */
|
||||
.mcp-tab-container {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
margin-bottom: 16px;
|
||||
border-bottom: 1px solid var(--background-modifier-border);
|
||||
}
|
||||
|
||||
.mcp-tab {
|
||||
padding: 8px 16px;
|
||||
border: none;
|
||||
background: none;
|
||||
cursor: pointer;
|
||||
border-bottom: 2px solid transparent;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.mcp-tab-active {
|
||||
border-bottom-color: var(--interactive-accent);
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* Tab content */
|
||||
.mcp-tab-content {
|
||||
margin-top: 16px;
|
||||
}
|
||||
|
||||
/* Labels and helper text */
|
||||
.mcp-label {
|
||||
margin-bottom: 4px;
|
||||
font-size: 0.9em;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-file-path {
|
||||
padding: 8px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-family: monospace;
|
||||
font-size: 0.9em;
|
||||
margin-bottom: 12px;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-usage-note {
|
||||
font-size: 0.9em;
|
||||
color: var(--text-muted);
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* Config display */
|
||||
.mcp-config-display {
|
||||
padding: 12px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-size: 0.85em;
|
||||
overflow-x: auto;
|
||||
user-select: text;
|
||||
cursor: text;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
/* Copy button spacing */
|
||||
.mcp-copy-button {
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
/* Notification section */
|
||||
.mcp-notif-section {
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.mcp-notif-summary {
|
||||
font-size: 1.17em;
|
||||
font-weight: bold;
|
||||
margin-bottom: 12px;
|
||||
cursor: pointer;
|
||||
}
|
||||
```
|
||||
|
||||
**Step 2: Update authentication section in settings.ts (lines 199-205)**
|
||||
|
||||
In `src/settings.ts`, find the `displayAuthenticationDetails` method around line 199 and replace inline styles:
|
||||
|
||||
```typescript
|
||||
const authDetails = containerEl.createEl('details', { cls: 'mcp-auth-section' });
|
||||
authDetails.open = true;
|
||||
const authSummary = authDetails.createEl('summary', {
|
||||
text: 'Authentication',
|
||||
cls: 'mcp-auth-summary'
|
||||
});
|
||||
```
|
||||
|
||||
**Step 3: Update API key container styles (lines 217-224)**
|
||||
|
||||
Replace:
|
||||
```typescript
|
||||
const apiKeyContainer = containerEl.createDiv({ cls: 'mcp-api-key-container' });
|
||||
const apiKeyButtonContainer = apiKeyContainer.createDiv({ cls: 'mcp-button-group' });
|
||||
```
|
||||
|
||||
**Step 4: Update key display container styles (lines 247-255)**
|
||||
|
||||
Replace:
|
||||
```typescript
|
||||
const keyDisplayContainer = apiKeyContainer.createDiv({
|
||||
text: apiKey,
|
||||
cls: 'mcp-key-display'
|
||||
});
|
||||
```
|
||||
|
||||
**Step 5: Update config section headings (lines 260-264)**
|
||||
|
||||
Replace:
|
||||
```typescript
|
||||
const configHeading = containerEl.createEl('h3', {
|
||||
text: 'Connection Configuration',
|
||||
cls: 'mcp-heading'
|
||||
});
|
||||
const configContainer = containerEl.createDiv({ cls: 'mcp-container' });
|
||||
```
|
||||
|
||||
**Step 6: Update tab container styles (lines 271-285)**
|
||||
|
||||
Replace the tab container creation:
|
||||
```typescript
|
||||
const tabContainer = configContainer.createDiv({ cls: 'mcp-tab-container' });
|
||||
|
||||
const windsurfTab = tabContainer.createEl('button', {
|
||||
text: 'Windsurf',
|
||||
cls: this.activeConfigTab === 'windsurf' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
|
||||
const claudeCodeTab = tabContainer.createEl('button', {
|
||||
text: 'Claude Code',
|
||||
cls: this.activeConfigTab === 'claude-code' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
```
|
||||
|
||||
**Step 7: Update tab content and labels (lines 311-327)**
|
||||
|
||||
Replace:
|
||||
```typescript
|
||||
const tabContent = configContainer.createDiv({ cls: 'mcp-tab-content' });
|
||||
|
||||
const fileLocationLabel = tabContent.createDiv({
|
||||
text: 'Configuration file location:',
|
||||
cls: 'mcp-label'
|
||||
});
|
||||
|
||||
const filePathDisplay = tabContent.createDiv({
|
||||
text: filePath,
|
||||
cls: 'mcp-file-path'
|
||||
});
|
||||
|
||||
const copyConfigButton = tabContent.createEl('button', {
|
||||
text: 'Copy to Clipboard',
|
||||
cls: 'mcp-copy-button'
|
||||
});
|
||||
```
|
||||
|
||||
**Step 8: Update config display (lines 339-346)**
|
||||
|
||||
Replace:
|
||||
```typescript
|
||||
const configDisplay = tabContent.createEl('pre', { cls: 'mcp-config-display' });
|
||||
|
||||
const usageNoteDisplay = tabContent.createDiv({
|
||||
text: usageNote,
|
||||
cls: 'mcp-usage-note'
|
||||
});
|
||||
```
|
||||
|
||||
**Step 9: Update notification section (lines 357-362)**
|
||||
|
||||
Replace:
|
||||
```typescript
|
||||
const notifDetails = containerEl.createEl('details', { cls: 'mcp-notif-section' });
|
||||
notifDetails.open = false;
|
||||
const notifSummary = notifDetails.createEl('summary', {
|
||||
text: 'Notification Settings',
|
||||
cls: 'mcp-notif-summary'
|
||||
});
|
||||
```
|
||||
|
||||
**Step 10: Update updateConfigTabDisplay method (lines 439-521)**
|
||||
|
||||
Find the `updateConfigTabDisplay` method and update the tab button styling to use CSS classes with conditional application:
|
||||
|
||||
```typescript
|
||||
private updateConfigTabDisplay(containerEl: HTMLElement) {
|
||||
// ... existing code ...
|
||||
|
||||
const tabContainer = containerEl.createDiv({ cls: 'mcp-tab-container' });
|
||||
|
||||
const windsurfTab = tabContainer.createEl('button', {
|
||||
text: 'Windsurf',
|
||||
cls: this.activeConfigTab === 'windsurf' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
|
||||
const claudeCodeTab = tabContainer.createEl('button', {
|
||||
text: 'Claude Code',
|
||||
cls: this.activeConfigTab === 'claude-code' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
|
||||
// Update tab content with CSS classes
|
||||
const tabContent = containerEl.createDiv({ cls: 'mcp-tab-content' });
|
||||
|
||||
const fileLocationLabel = tabContent.createDiv({
|
||||
text: 'Configuration file location:',
|
||||
cls: 'mcp-label'
|
||||
});
|
||||
|
||||
const filePathDisplay = tabContent.createDiv({
|
||||
text: filePath,
|
||||
cls: 'mcp-file-path'
|
||||
});
|
||||
|
||||
const copyConfigButton = tabContent.createEl('button', {
|
||||
text: 'Copy to Clipboard',
|
||||
cls: 'mcp-copy-button'
|
||||
});
|
||||
|
||||
const configDisplay = tabContent.createEl('pre', { cls: 'mcp-config-display' });
|
||||
|
||||
const usageNoteDisplay = tabContent.createDiv({
|
||||
text: usageNote,
|
||||
cls: 'mcp-usage-note'
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
**Step 11: Verify all inline styles removed**
|
||||
|
||||
Run: `grep -n "\.style\." src/settings.ts`
|
||||
Expected: No matches (or only legitimate dynamic styling that can't be in CSS)
|
||||
|
||||
**Step 12: Build and verify**
|
||||
|
||||
Run: `npm run build`
|
||||
Expected: Clean build with no TypeScript errors
|
||||
|
||||
**Step 13: Run tests**
|
||||
|
||||
Run: `npm test`
|
||||
Expected: All 716 tests pass
|
||||
|
||||
**Step 14: Commit**
|
||||
|
||||
```bash
|
||||
git add styles.css src/settings.ts
|
||||
git commit -m "fix: extract inline styles to CSS with semantic classes
|
||||
|
||||
- Add mcp-* prefixed CSS classes for all settings UI elements
|
||||
- Remove 90+ inline style assignments from settings.ts
|
||||
- Use Obsidian CSS variables for theming compatibility
|
||||
- Preserve dynamic tab active state with conditional classes
|
||||
- Addresses ObsidianReviewBot feedback"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 5: Final Verification
|
||||
|
||||
**Step 1: Run full test suite**
|
||||
|
||||
Run: `npm test`
|
||||
Expected: All 716 tests pass
|
||||
|
||||
**Step 2: Run build**
|
||||
|
||||
Run: `npm run build`
|
||||
Expected: Clean build, no errors, no warnings
|
||||
|
||||
**Step 3: Check git status**
|
||||
|
||||
Run: `git status`
|
||||
Expected: Clean working tree, all changes committed
|
||||
|
||||
**Step 4: Review commit history**
|
||||
|
||||
Run: `git log --oneline -5`
|
||||
Expected: See all 4 fix commits plus design doc commit
|
||||
|
||||
**Step 5: Manual testing checklist (if Obsidian available)**
|
||||
|
||||
If you can test in Obsidian:
|
||||
1. Copy built files to `.obsidian/plugins/mcp-server/`
|
||||
2. Reload Obsidian
|
||||
3. Open Settings → MCP Server
|
||||
4. Verify settings panel appearance identical to before
|
||||
5. Test both light and dark themes
|
||||
6. Verify collapsible sections work
|
||||
7. Verify tab switching works
|
||||
8. Test command palette shows updated command names
|
||||
|
||||
---
|
||||
|
||||
## Success Criteria
|
||||
|
||||
✅ All 4 ObsidianReviewBot required issues fixed
|
||||
✅ No test regressions (716 tests passing)
|
||||
✅ Clean TypeScript build
|
||||
✅ Settings panel visually unchanged
|
||||
✅ All changes committed with clear messages
|
||||
✅ Ready for PR re-submission
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"id": "mcp-server",
|
||||
"name": "MCP Server",
|
||||
"version": "1.0.0-alpha.7",
|
||||
"version": "1.1.0",
|
||||
"minAppVersion": "0.15.0",
|
||||
"description": "Exposes vault operations via Model Context Protocol (MCP) over HTTP.",
|
||||
"author": "William Ballou",
|
||||
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "mcp-server",
|
||||
"version": "1.0.0-alpha.7",
|
||||
"version": "1.0.1",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "mcp-server",
|
||||
"version": "1.0.0-alpha.7",
|
||||
"version": "1.0.1",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"cors": "^2.8.5",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "mcp-server",
|
||||
"version": "1.0.0-alpha.7",
|
||||
"version": "1.1.0",
|
||||
"description": "MCP (Model Context Protocol) server plugin - exposes vault operations via HTTP",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
|
||||
@@ -51,7 +51,7 @@ export default class MCPServerPlugin extends Plugin {
|
||||
// Register commands
|
||||
this.addCommand({
|
||||
id: 'start-mcp-server',
|
||||
name: 'Start MCP Server',
|
||||
name: 'Start server',
|
||||
callback: async () => {
|
||||
await this.startServer();
|
||||
}
|
||||
@@ -59,7 +59,7 @@ export default class MCPServerPlugin extends Plugin {
|
||||
|
||||
this.addCommand({
|
||||
id: 'stop-mcp-server',
|
||||
name: 'Stop MCP Server',
|
||||
name: 'Stop server',
|
||||
callback: async () => {
|
||||
await this.stopServer();
|
||||
}
|
||||
@@ -67,7 +67,7 @@ export default class MCPServerPlugin extends Plugin {
|
||||
|
||||
this.addCommand({
|
||||
id: 'restart-mcp-server',
|
||||
name: 'Restart MCP Server',
|
||||
name: 'Restart server',
|
||||
callback: async () => {
|
||||
await this.stopServer();
|
||||
await this.startServer();
|
||||
@@ -76,7 +76,7 @@ export default class MCPServerPlugin extends Plugin {
|
||||
|
||||
this.addCommand({
|
||||
id: 'view-notification-history',
|
||||
name: 'View MCP Notification History',
|
||||
name: 'View notification history',
|
||||
callback: () => {
|
||||
this.showNotificationHistory();
|
||||
}
|
||||
|
||||
223
src/settings.ts
223
src/settings.ts
@@ -6,6 +6,9 @@ import { generateApiKey } from './utils/auth-utils';
|
||||
export class MCPServerSettingTab extends PluginSettingTab {
|
||||
plugin: MCPServerPlugin;
|
||||
private notificationDetailsEl: HTMLDetailsElement | null = null;
|
||||
private notificationToggleEl: HTMLElement | null = null;
|
||||
private authDetailsEl: HTMLDetailsElement | null = null;
|
||||
private configContainerEl: HTMLElement | null = null;
|
||||
private activeConfigTab: 'windsurf' | 'claude-code' = 'windsurf';
|
||||
|
||||
constructor(app: App, plugin: MCPServerPlugin) {
|
||||
@@ -118,8 +121,11 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
|
||||
containerEl.empty();
|
||||
|
||||
// Clear notification details reference for fresh render
|
||||
// Clear references for fresh render
|
||||
this.notificationDetailsEl = null;
|
||||
this.notificationToggleEl = null;
|
||||
this.authDetailsEl = null;
|
||||
this.configContainerEl = null;
|
||||
|
||||
containerEl.createEl('h2', {text: 'MCP Server Settings'});
|
||||
|
||||
@@ -189,30 +195,23 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
}));
|
||||
|
||||
// Authentication (Always Enabled)
|
||||
const authDetails = containerEl.createEl('details');
|
||||
authDetails.style.marginBottom = '20px';
|
||||
const authSummary = authDetails.createEl('summary');
|
||||
authSummary.style.fontSize = '1.17em';
|
||||
authSummary.style.fontWeight = 'bold';
|
||||
authSummary.style.marginBottom = '12px';
|
||||
authSummary.style.cursor = 'pointer';
|
||||
const authDetails = containerEl.createEl('details', {cls: 'mcp-auth-section'});
|
||||
const authSummary = authDetails.createEl('summary', {cls: 'mcp-auth-summary'});
|
||||
authSummary.setText('Authentication & Configuration');
|
||||
|
||||
// Store reference for targeted updates
|
||||
this.authDetailsEl = authDetails;
|
||||
|
||||
// API Key Display (always show - auth is always enabled)
|
||||
new Setting(authDetails)
|
||||
.setName('API Key Management')
|
||||
.setDesc('Use as Bearer token in Authorization header');
|
||||
|
||||
// Create a full-width container for buttons and key display
|
||||
const apiKeyContainer = authDetails.createDiv({cls: 'mcp-api-key-section'});
|
||||
apiKeyContainer.style.marginBottom = '20px';
|
||||
apiKeyContainer.style.marginLeft = '0';
|
||||
const apiKeyContainer = authDetails.createDiv({cls: 'mcp-container'});
|
||||
|
||||
// Create button container
|
||||
const apiKeyButtonContainer = apiKeyContainer.createDiv({cls: 'mcp-api-key-buttons'});
|
||||
apiKeyButtonContainer.style.display = 'flex';
|
||||
apiKeyButtonContainer.style.gap = '8px';
|
||||
apiKeyButtonContainer.style.marginBottom = '12px';
|
||||
const apiKeyButtonContainer = apiKeyContainer.createDiv({cls: 'mcp-button-group'});
|
||||
|
||||
// Copy button
|
||||
const copyButton = apiKeyButtonContainer.createEl('button', {text: '📋 Copy Key'});
|
||||
@@ -234,61 +233,38 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
});
|
||||
|
||||
// API Key display (static, copyable text)
|
||||
const keyDisplayContainer = apiKeyContainer.createDiv({cls: 'mcp-api-key-display'});
|
||||
keyDisplayContainer.style.padding = '12px';
|
||||
keyDisplayContainer.style.backgroundColor = 'var(--background-secondary)';
|
||||
keyDisplayContainer.style.borderRadius = '4px';
|
||||
keyDisplayContainer.style.fontFamily = 'monospace';
|
||||
keyDisplayContainer.style.fontSize = '0.9em';
|
||||
keyDisplayContainer.style.wordBreak = 'break-all';
|
||||
keyDisplayContainer.style.userSelect = 'all';
|
||||
keyDisplayContainer.style.cursor = 'text';
|
||||
keyDisplayContainer.style.marginBottom = '16px';
|
||||
const keyDisplayContainer = apiKeyContainer.createDiv({cls: 'mcp-key-display'});
|
||||
keyDisplayContainer.textContent = this.plugin.settings.apiKey || '';
|
||||
|
||||
// MCP Client Configuration heading
|
||||
const configHeading = authDetails.createEl('h4', {text: 'MCP Client Configuration'});
|
||||
configHeading.style.marginTop = '24px';
|
||||
configHeading.style.marginBottom = '12px';
|
||||
authDetails.createEl('h4', {text: 'MCP Client Configuration', cls: 'mcp-heading'});
|
||||
|
||||
const configContainer = authDetails.createDiv({cls: 'mcp-config-snippet'});
|
||||
configContainer.style.marginBottom = '20px';
|
||||
const configContainer = authDetails.createDiv({cls: 'mcp-container'});
|
||||
|
||||
// Store reference for targeted updates
|
||||
this.configContainerEl = configContainer;
|
||||
|
||||
// Tab buttons for switching between clients
|
||||
const tabContainer = configContainer.createDiv({cls: 'mcp-config-tabs'});
|
||||
tabContainer.style.display = 'flex';
|
||||
tabContainer.style.gap = '8px';
|
||||
tabContainer.style.marginBottom = '16px';
|
||||
tabContainer.style.borderBottom = '1px solid var(--background-modifier-border)';
|
||||
|
||||
// Windsurf tab button
|
||||
const windsurfTab = tabContainer.createEl('button', {text: 'Windsurf'});
|
||||
windsurfTab.style.padding = '8px 16px';
|
||||
windsurfTab.style.border = 'none';
|
||||
windsurfTab.style.background = 'none';
|
||||
windsurfTab.style.cursor = 'pointer';
|
||||
windsurfTab.style.borderBottom = this.activeConfigTab === 'windsurf'
|
||||
? '2px solid var(--interactive-accent)'
|
||||
: '2px solid transparent';
|
||||
windsurfTab.style.fontWeight = this.activeConfigTab === 'windsurf' ? 'bold' : 'normal';
|
||||
const windsurfTab = tabContainer.createEl('button', {
|
||||
text: 'Windsurf',
|
||||
cls: this.activeConfigTab === 'windsurf' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
windsurfTab.addEventListener('click', () => {
|
||||
this.activeConfigTab = 'windsurf';
|
||||
this.display();
|
||||
this.updateConfigSection();
|
||||
});
|
||||
|
||||
// Claude Code tab button
|
||||
const claudeCodeTab = tabContainer.createEl('button', {text: 'Claude Code'});
|
||||
claudeCodeTab.style.padding = '8px 16px';
|
||||
claudeCodeTab.style.border = 'none';
|
||||
claudeCodeTab.style.background = 'none';
|
||||
claudeCodeTab.style.cursor = 'pointer';
|
||||
claudeCodeTab.style.borderBottom = this.activeConfigTab === 'claude-code'
|
||||
? '2px solid var(--interactive-accent)'
|
||||
: '2px solid transparent';
|
||||
claudeCodeTab.style.fontWeight = this.activeConfigTab === 'claude-code' ? 'bold' : 'normal';
|
||||
const claudeCodeTab = tabContainer.createEl('button', {
|
||||
text: 'Claude Code',
|
||||
cls: this.activeConfigTab === 'claude-code' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
claudeCodeTab.addEventListener('click', () => {
|
||||
this.activeConfigTab = 'claude-code';
|
||||
this.display();
|
||||
this.updateConfigSection();
|
||||
});
|
||||
|
||||
// Get configuration for active tab
|
||||
@@ -296,65 +272,43 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
|
||||
// Tab content area
|
||||
const tabContent = configContainer.createDiv({cls: 'mcp-config-content'});
|
||||
tabContent.style.marginTop = '16px';
|
||||
|
||||
// File location label
|
||||
const fileLocationLabel = tabContent.createEl('p', {text: 'Configuration file location:'});
|
||||
fileLocationLabel.style.marginBottom = '4px';
|
||||
fileLocationLabel.style.fontSize = '0.9em';
|
||||
fileLocationLabel.style.color = 'var(--text-muted)';
|
||||
tabContent.createEl('p', {text: 'Configuration file location:', cls: 'mcp-label'});
|
||||
|
||||
// File path display
|
||||
const filePathDisplay = tabContent.createEl('div', {text: filePath});
|
||||
filePathDisplay.style.padding = '8px';
|
||||
filePathDisplay.style.backgroundColor = 'var(--background-secondary)';
|
||||
filePathDisplay.style.borderRadius = '4px';
|
||||
filePathDisplay.style.fontFamily = 'monospace';
|
||||
filePathDisplay.style.fontSize = '0.9em';
|
||||
filePathDisplay.style.marginBottom = '12px';
|
||||
filePathDisplay.style.color = 'var(--text-muted)';
|
||||
tabContent.createEl('div', {text: filePath, cls: 'mcp-file-path'});
|
||||
|
||||
// Copy button
|
||||
const copyConfigButton = tabContent.createEl('button', {text: '📋 Copy Configuration'});
|
||||
copyConfigButton.style.marginBottom = '12px';
|
||||
const copyConfigButton = tabContent.createEl('button', {
|
||||
text: '📋 Copy Configuration',
|
||||
cls: 'mcp-config-button'
|
||||
});
|
||||
copyConfigButton.addEventListener('click', async () => {
|
||||
await navigator.clipboard.writeText(JSON.stringify(config, null, 2));
|
||||
new Notice('✅ Configuration copied to clipboard');
|
||||
});
|
||||
|
||||
// Config JSON display
|
||||
const configDisplay = tabContent.createEl('pre');
|
||||
configDisplay.style.padding = '12px';
|
||||
configDisplay.style.backgroundColor = 'var(--background-secondary)';
|
||||
configDisplay.style.borderRadius = '4px';
|
||||
configDisplay.style.fontSize = '0.85em';
|
||||
configDisplay.style.overflowX = 'auto';
|
||||
configDisplay.style.userSelect = 'text';
|
||||
configDisplay.style.cursor = 'text';
|
||||
configDisplay.style.marginBottom = '12px';
|
||||
const configDisplay = tabContent.createEl('pre', {cls: 'mcp-config-display'});
|
||||
configDisplay.textContent = JSON.stringify(config, null, 2);
|
||||
|
||||
// Usage note
|
||||
const usageNoteDisplay = tabContent.createEl('p', {text: usageNote});
|
||||
usageNoteDisplay.style.fontSize = '0.9em';
|
||||
usageNoteDisplay.style.color = 'var(--text-muted)';
|
||||
usageNoteDisplay.style.fontStyle = 'italic';
|
||||
tabContent.createEl('p', {text: usageNote, cls: 'mcp-usage-note'});
|
||||
|
||||
// Notification Settings
|
||||
const notifDetails = containerEl.createEl('details');
|
||||
notifDetails.style.marginBottom = '20px';
|
||||
const notifSummary = notifDetails.createEl('summary');
|
||||
notifSummary.style.fontSize = '1.17em';
|
||||
notifSummary.style.fontWeight = 'bold';
|
||||
notifSummary.style.marginBottom = '12px';
|
||||
notifSummary.style.cursor = 'pointer';
|
||||
const notifDetails = containerEl.createEl('details', {cls: 'mcp-auth-section'});
|
||||
const notifSummary = notifDetails.createEl('summary', {cls: 'mcp-auth-summary'});
|
||||
notifSummary.setText('UI Notifications');
|
||||
|
||||
// Store reference for targeted updates
|
||||
this.notificationDetailsEl = notifDetails;
|
||||
|
||||
// Enable notifications
|
||||
new Setting(notifDetails)
|
||||
// Enable notifications - create container for the toggle setting
|
||||
const notificationToggleContainer = notifDetails.createDiv({cls: 'mcp-notification-toggle'});
|
||||
this.notificationToggleEl = notificationToggleContainer;
|
||||
|
||||
new Setting(notificationToggleContainer)
|
||||
.setName('Enable notifications')
|
||||
.setDesc('Show when MCP tools are called')
|
||||
.addToggle(toggle => toggle
|
||||
@@ -376,7 +330,7 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
* Update only the notification section without re-rendering entire page
|
||||
*/
|
||||
private updateNotificationSection(): void {
|
||||
if (!this.notificationDetailsEl) {
|
||||
if (!this.notificationDetailsEl || !this.notificationToggleEl) {
|
||||
// Fallback to full re-render if reference lost
|
||||
this.display();
|
||||
return;
|
||||
@@ -385,13 +339,16 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
// Store current open state
|
||||
const wasOpen = this.notificationDetailsEl.open;
|
||||
|
||||
// Find and remove all child elements except the summary
|
||||
// Remove all children except the summary and the toggle container
|
||||
const summary = this.notificationDetailsEl.querySelector('summary');
|
||||
while (this.notificationDetailsEl.lastChild && this.notificationDetailsEl.lastChild !== summary) {
|
||||
this.notificationDetailsEl.removeChild(this.notificationDetailsEl.lastChild);
|
||||
const children = Array.from(this.notificationDetailsEl.children);
|
||||
for (const child of children) {
|
||||
if (child !== summary && child !== this.notificationToggleEl) {
|
||||
this.notificationDetailsEl.removeChild(child);
|
||||
}
|
||||
}
|
||||
|
||||
// Rebuild notification settings
|
||||
// Rebuild notification settings only if enabled
|
||||
if (this.plugin.settings.notificationsEnabled) {
|
||||
this.renderNotificationSettings(this.notificationDetailsEl);
|
||||
}
|
||||
@@ -399,4 +356,78 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
// Restore open state
|
||||
this.notificationDetailsEl.open = wasOpen;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update only the config section without re-rendering entire page
|
||||
*/
|
||||
private updateConfigSection(): void {
|
||||
if (!this.configContainerEl) {
|
||||
// Fallback to full re-render if reference lost
|
||||
this.display();
|
||||
return;
|
||||
}
|
||||
|
||||
// Store current open state of the auth details
|
||||
const wasOpen = this.authDetailsEl?.open ?? false;
|
||||
|
||||
// Clear the config container
|
||||
this.configContainerEl.empty();
|
||||
|
||||
// Tab buttons for switching between clients
|
||||
const tabContainer = this.configContainerEl.createDiv({cls: 'mcp-config-tabs'});
|
||||
|
||||
// Windsurf tab button
|
||||
const windsurfTab = tabContainer.createEl('button', {
|
||||
text: 'Windsurf',
|
||||
cls: this.activeConfigTab === 'windsurf' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
windsurfTab.addEventListener('click', () => {
|
||||
this.activeConfigTab = 'windsurf';
|
||||
this.updateConfigSection();
|
||||
});
|
||||
|
||||
// Claude Code tab button
|
||||
const claudeCodeTab = tabContainer.createEl('button', {
|
||||
text: 'Claude Code',
|
||||
cls: this.activeConfigTab === 'claude-code' ? 'mcp-tab mcp-tab-active' : 'mcp-tab'
|
||||
});
|
||||
claudeCodeTab.addEventListener('click', () => {
|
||||
this.activeConfigTab = 'claude-code';
|
||||
this.updateConfigSection();
|
||||
});
|
||||
|
||||
// Get configuration for active tab
|
||||
const {filePath, config, usageNote} = this.generateConfigForClient(this.activeConfigTab);
|
||||
|
||||
// Tab content area
|
||||
const tabContent = this.configContainerEl.createDiv({cls: 'mcp-config-content'});
|
||||
|
||||
// File location label
|
||||
tabContent.createEl('p', {text: 'Configuration file location:', cls: 'mcp-label'});
|
||||
|
||||
// File path display
|
||||
tabContent.createEl('div', {text: filePath, cls: 'mcp-file-path'});
|
||||
|
||||
// Copy button
|
||||
const copyConfigButton = tabContent.createEl('button', {
|
||||
text: '📋 Copy Configuration',
|
||||
cls: 'mcp-config-button'
|
||||
});
|
||||
copyConfigButton.addEventListener('click', async () => {
|
||||
await navigator.clipboard.writeText(JSON.stringify(config, null, 2));
|
||||
new Notice('✅ Configuration copied to clipboard');
|
||||
});
|
||||
|
||||
// Config JSON display
|
||||
const configDisplay = tabContent.createEl('pre', {cls: 'mcp-config-display'});
|
||||
configDisplay.textContent = JSON.stringify(config, null, 2);
|
||||
|
||||
// Usage note
|
||||
tabContent.createEl('p', {text: usageNote, cls: 'mcp-usage-note'});
|
||||
|
||||
// Restore open state (only if authDetailsEl is available)
|
||||
if (this.authDetailsEl) {
|
||||
this.authDetailsEl.open = wasOpen;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -27,7 +27,7 @@ export class ToolRegistry {
|
||||
return [
|
||||
{
|
||||
name: "read_note",
|
||||
description: "Read the content of a file from the Obsidian vault with optional frontmatter parsing. Use this to read the contents of a specific note or file. Path must be vault-relative (no leading slash) and include the file extension. Use list() first if you're unsure of the exact path. This only works on files, not folders. By default returns raw content. Set parseFrontmatter to true to get structured data with separated frontmatter and content.",
|
||||
description: "Read the content of a file from the Obsidian vault with optional frontmatter parsing. Returns word count (excluding frontmatter and Obsidian comments) when content is included in the response. Use this to read the contents of a specific note or file. Path must be vault-relative (no leading slash) and include the file extension. Use list() first if you're unsure of the exact path. This only works on files, not folders. By default returns raw content with word count. Set parseFrontmatter to true to get structured data with separated frontmatter, content, and word count.",
|
||||
inputSchema: {
|
||||
type: "object",
|
||||
properties: {
|
||||
@@ -53,7 +53,7 @@ export class ToolRegistry {
|
||||
},
|
||||
{
|
||||
name: "create_note",
|
||||
description: "Create a new file in the Obsidian vault with conflict handling. Returns structured JSON with success status, path, versionId, created timestamp, and conflict resolution details. Supports automatic parent folder creation and three conflict strategies: 'error' (default, fail if exists), 'overwrite' (replace existing), 'rename' (auto-generate unique name). Use this to create new notes with robust error handling.",
|
||||
description: "Create a new file in the Obsidian vault with conflict handling. Returns structured JSON with success status, path, versionId, created timestamp, conflict resolution details, word count (excluding frontmatter and Obsidian comments), and link validation results. Automatically validates all wikilinks, heading links, and embeds, categorizing them as valid, broken notes, or broken headings. Supports automatic parent folder creation and three conflict strategies: 'error' (default, fail if exists), 'overwrite' (replace existing), 'rename' (auto-generate unique name). Use this to create new notes with robust error handling and automatic content analysis.",
|
||||
inputSchema: {
|
||||
type: "object",
|
||||
properties: {
|
||||
@@ -73,6 +73,10 @@ export class ToolRegistry {
|
||||
type: "string",
|
||||
enum: ["error", "overwrite", "rename"],
|
||||
description: "Conflict resolution strategy if file already exists. 'error' (default): fail with error. 'overwrite': delete existing file and create new. 'rename': auto-generate unique name by appending number. Default: 'error'"
|
||||
},
|
||||
validateLinks: {
|
||||
type: "boolean",
|
||||
description: "If true (default), automatically validate all wikilinks and embeds in the note, returning detailed broken link information. If false, skip link validation for better performance. Link validation checks [[wikilinks]], [[note#heading]] links, and ![[embeds]]. Default: true"
|
||||
}
|
||||
},
|
||||
required: ["path", "content"]
|
||||
@@ -80,7 +84,7 @@ export class ToolRegistry {
|
||||
},
|
||||
{
|
||||
name: "update_note",
|
||||
description: "Update (overwrite) an existing file in the Obsidian vault. Use this to modify the contents of an existing note. This REPLACES the entire file content. The file must already exist. Path must be vault-relative with file extension. Use read_note() first to get current content if you want to make partial changes.",
|
||||
description: "Update (overwrite) an existing file in the Obsidian vault. Returns structured JSON with success status, path, versionId, modified timestamp, word count (excluding frontmatter and Obsidian comments), and link validation results. Automatically validates all wikilinks, heading links, and embeds, categorizing them as valid, broken notes, or broken headings. This REPLACES the entire file content. The file must already exist. Path must be vault-relative with file extension. Use read_note() first to get current content if you want to make partial changes.",
|
||||
inputSchema: {
|
||||
type: "object",
|
||||
properties: {
|
||||
@@ -91,6 +95,10 @@ export class ToolRegistry {
|
||||
content: {
|
||||
type: "string",
|
||||
description: "The complete new content that will replace the entire file. To make partial changes, read the file first, modify the content, then update."
|
||||
},
|
||||
validateLinks: {
|
||||
type: "boolean",
|
||||
description: "If true (default), automatically validate all wikilinks and embeds in the note, returning detailed broken link information. If false, skip link validation for better performance. Link validation checks [[wikilinks]], [[note#heading]] links, and ![[embeds]]. Default: true"
|
||||
}
|
||||
},
|
||||
required: ["path", "content"]
|
||||
@@ -151,7 +159,7 @@ export class ToolRegistry {
|
||||
},
|
||||
{
|
||||
name: "update_sections",
|
||||
description: "Update specific sections of a note by line range. Reduces race conditions by avoiding full file overwrites. Returns structured JSON with success status, path, versionId, modified timestamp, and count of sections updated. Supports multiple edits in a single operation, applied from bottom to top to preserve line numbers. Includes concurrency control via ifMatch parameter. Use this for surgical edits to specific parts of large notes.",
|
||||
description: "Update specific sections of a note by line range. Reduces race conditions by avoiding full file overwrites. Returns structured JSON with success status, path, versionId, modified timestamp, count of sections updated, word count for the entire note (excluding frontmatter and Obsidian comments), and link validation results for the entire note. Automatically validates all wikilinks, heading links, and embeds in the complete note after edits, categorizing them as valid, broken notes, or broken headings. Supports multiple edits in a single operation, applied from bottom to top to preserve line numbers. Includes concurrency control via ifMatch parameter. Use this for surgical edits to specific parts of large notes with automatic content analysis.",
|
||||
inputSchema: {
|
||||
type: "object",
|
||||
properties: {
|
||||
@@ -175,6 +183,10 @@ export class ToolRegistry {
|
||||
ifMatch: {
|
||||
type: "string",
|
||||
description: "Optional ETag/versionId for concurrency control. If provided, update only proceeds if file hasn't been modified. Get versionId from read operations. Prevents conflicting edits in concurrent scenarios."
|
||||
},
|
||||
validateLinks: {
|
||||
type: "boolean",
|
||||
description: "If true (default), automatically validate all wikilinks and embeds in the entire note after applying section edits, returning detailed broken link information. If false, skip link validation for better performance. Link validation checks [[wikilinks]], [[note#heading]] links, and ![[embeds]]. Default: true"
|
||||
}
|
||||
},
|
||||
required: ["path", "edits"]
|
||||
@@ -232,7 +244,7 @@ export class ToolRegistry {
|
||||
excludes: {
|
||||
type: "array",
|
||||
items: { type: "string" },
|
||||
description: "Glob patterns to exclude (e.g., ['.obsidian/**', '*.tmp']). Files matching these patterns will be skipped. Takes precedence over includes."
|
||||
description: "Glob patterns to exclude (e.g., ['templates/**', '*.tmp']). Files matching these patterns will be skipped. Takes precedence over includes."
|
||||
},
|
||||
folder: {
|
||||
type: "string",
|
||||
@@ -277,7 +289,7 @@ export class ToolRegistry {
|
||||
},
|
||||
{
|
||||
name: "list",
|
||||
description: "List files and/or directories with advanced filtering, recursion, and pagination. Returns structured JSON with file/directory metadata and optional frontmatter summaries. Supports glob patterns for includes/excludes, recursive traversal, type filtering, and cursor-based pagination. Use this to explore vault structure with fine-grained control.",
|
||||
description: "List files and/or directories with advanced filtering, recursion, and pagination. Returns structured JSON with file/directory metadata and optional frontmatter summaries. Optional: includeWordCount (boolean) - If true, read each file's content and compute word count (excluding frontmatter and Obsidian comments). WARNING: This can be very slow for large directories or recursive listings, as it reads every file. Files that cannot be read are skipped (best effort). Only computed for files, not directories. Supports glob patterns for includes/excludes, recursive traversal, type filtering, and cursor-based pagination. Use this to explore vault structure with fine-grained control.",
|
||||
inputSchema: {
|
||||
type: "object",
|
||||
properties: {
|
||||
@@ -297,7 +309,7 @@ export class ToolRegistry {
|
||||
excludes: {
|
||||
type: "array",
|
||||
items: { type: "string" },
|
||||
description: "Glob patterns to exclude (e.g., ['.obsidian/**', '*.tmp']). Takes precedence over includes."
|
||||
description: "Glob patterns to exclude (e.g., ['templates/**', '*.tmp']). Takes precedence over includes."
|
||||
},
|
||||
only: {
|
||||
type: "string",
|
||||
@@ -315,19 +327,27 @@ export class ToolRegistry {
|
||||
withFrontmatterSummary: {
|
||||
type: "boolean",
|
||||
description: "If true, include parsed frontmatter (title, tags, aliases) for markdown files without reading full content. Default: false."
|
||||
},
|
||||
includeWordCount: {
|
||||
type: "boolean",
|
||||
description: "If true, read each file's content and compute word count. WARNING: Can be very slow for large directories or recursive listings. Only applies to files. Default: false"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
name: "stat",
|
||||
description: "Get detailed metadata for a file or folder at a specific path. Returns existence status, kind (file or directory), and full metadata including size, dates, etc. Use this to check if a path exists and get its properties. More detailed than exists() but slightly slower. Returns structured JSON with path, exists boolean, kind, and metadata object.",
|
||||
description: "Get detailed metadata for a file or folder at a specific path. Returns existence status, kind (file or directory), and full metadata including size, dates, etc. Optional: includeWordCount (boolean) - If true, read file content and compute word count (excluding frontmatter and Obsidian comments). WARNING: This requires reading the entire file and is significantly slower than metadata-only stat. Only works for files, not directories. Use this to check if a path exists and get its properties. More detailed than exists() but slightly slower. Returns structured JSON with path, exists boolean, kind, and metadata object.",
|
||||
inputSchema: {
|
||||
type: "object",
|
||||
properties: {
|
||||
path: {
|
||||
type: "string",
|
||||
description: "Vault-relative path to check (e.g., 'folder/note.md' or 'projects'). Can be a file or folder. Paths are case-sensitive on macOS/Linux. Do not use leading or trailing slashes."
|
||||
},
|
||||
includeWordCount: {
|
||||
type: "boolean",
|
||||
description: "If true, read file content and compute word count. WARNING: Significantly slower than metadata-only stat. Only applies to files. Default: false"
|
||||
}
|
||||
},
|
||||
required: ["path"]
|
||||
@@ -475,14 +495,19 @@ export class ToolRegistry {
|
||||
break;
|
||||
case "create_note":
|
||||
result = await this.noteTools.createNote(
|
||||
args.path,
|
||||
args.content,
|
||||
args.path,
|
||||
args.content,
|
||||
args.createParents ?? false,
|
||||
args.onConflict ?? 'error'
|
||||
args.onConflict ?? 'error',
|
||||
args.validateLinks ?? true
|
||||
);
|
||||
break;
|
||||
case "update_note":
|
||||
result = await this.noteTools.updateNote(args.path, args.content);
|
||||
result = await this.noteTools.updateNote(
|
||||
args.path,
|
||||
args.content,
|
||||
args.validateLinks ?? true
|
||||
);
|
||||
break;
|
||||
case "update_frontmatter":
|
||||
result = await this.noteTools.updateFrontmatter(
|
||||
@@ -496,7 +521,8 @@ export class ToolRegistry {
|
||||
result = await this.noteTools.updateSections(
|
||||
args.path,
|
||||
args.edits,
|
||||
args.ifMatch
|
||||
args.ifMatch,
|
||||
args.validateLinks ?? true
|
||||
);
|
||||
break;
|
||||
case "rename_file":
|
||||
@@ -543,11 +569,12 @@ export class ToolRegistry {
|
||||
only: args.only,
|
||||
limit: args.limit,
|
||||
cursor: args.cursor,
|
||||
withFrontmatterSummary: args.withFrontmatterSummary
|
||||
withFrontmatterSummary: args.withFrontmatterSummary,
|
||||
includeWordCount: args.includeWordCount
|
||||
});
|
||||
break;
|
||||
case "stat":
|
||||
result = await this.vaultTools.stat(args.path);
|
||||
result = await this.vaultTools.stat(args.path, args.includeWordCount);
|
||||
break;
|
||||
case "exists":
|
||||
result = await this.vaultTools.exists(args.path);
|
||||
|
||||
@@ -2,6 +2,7 @@ import { App } from 'obsidian';
|
||||
import { NoteTools } from './note-tools';
|
||||
import { VaultAdapter } from '../adapters/vault-adapter';
|
||||
import { FileManagerAdapter } from '../adapters/file-manager-adapter';
|
||||
import { MetadataCacheAdapter } from '../adapters/metadata-adapter';
|
||||
|
||||
/**
|
||||
* Factory function to create NoteTools with concrete adapters
|
||||
@@ -10,6 +11,7 @@ export function createNoteTools(app: App): NoteTools {
|
||||
return new NoteTools(
|
||||
new VaultAdapter(app.vault),
|
||||
new FileManagerAdapter(app.fileManager),
|
||||
new MetadataCacheAdapter(app.metadataCache),
|
||||
app
|
||||
);
|
||||
}
|
||||
@@ -16,12 +16,15 @@ import { ErrorMessages } from '../utils/error-messages';
|
||||
import { FrontmatterUtils } from '../utils/frontmatter-utils';
|
||||
import { WaypointUtils } from '../utils/waypoint-utils';
|
||||
import { VersionUtils } from '../utils/version-utils';
|
||||
import { IVaultAdapter, IFileManagerAdapter } from '../adapters/interfaces';
|
||||
import { ContentUtils } from '../utils/content-utils';
|
||||
import { LinkUtils } from '../utils/link-utils';
|
||||
import { IVaultAdapter, IFileManagerAdapter, IMetadataCacheAdapter } from '../adapters/interfaces';
|
||||
|
||||
export class NoteTools {
|
||||
constructor(
|
||||
private vault: IVaultAdapter,
|
||||
private fileManager: IFileManagerAdapter,
|
||||
private metadata: IMetadataCacheAdapter,
|
||||
private app: App // Keep temporarily for methods not yet migrated
|
||||
) {}
|
||||
|
||||
@@ -79,6 +82,17 @@ export class NoteTools {
|
||||
|
||||
// If no special options, return simple content
|
||||
if (!parseFrontmatter) {
|
||||
// Compute word count when returning content
|
||||
if (withContent) {
|
||||
const wordCount = ContentUtils.countWords(content);
|
||||
const result = {
|
||||
content,
|
||||
wordCount
|
||||
};
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
|
||||
};
|
||||
}
|
||||
return {
|
||||
content: [{ type: "text", text: content }]
|
||||
};
|
||||
@@ -107,6 +121,11 @@ export class NoteTools {
|
||||
result.contentWithoutFrontmatter = extracted.contentWithoutFrontmatter;
|
||||
}
|
||||
|
||||
// Add word count when content is included
|
||||
if (withContent) {
|
||||
result.wordCount = ContentUtils.countWords(content);
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
|
||||
};
|
||||
@@ -119,10 +138,11 @@ export class NoteTools {
|
||||
}
|
||||
|
||||
async createNote(
|
||||
path: string,
|
||||
content: string,
|
||||
path: string,
|
||||
content: string,
|
||||
createParents: boolean = false,
|
||||
onConflict: ConflictStrategy = 'error'
|
||||
onConflict: ConflictStrategy = 'error',
|
||||
validateLinks: boolean = true
|
||||
): Promise<CallToolResult> {
|
||||
// Validate path
|
||||
if (!path || path.trim() === '') {
|
||||
@@ -159,7 +179,7 @@ export class NoteTools {
|
||||
const existingFile = PathUtils.resolveFile(this.app, normalizedPath);
|
||||
/* istanbul ignore next */
|
||||
if (existingFile) {
|
||||
await this.vault.delete(existingFile);
|
||||
await this.fileManager.trashFile(existingFile);
|
||||
}
|
||||
} else if (onConflict === 'rename') {
|
||||
// Generate a unique name
|
||||
@@ -213,7 +233,7 @@ export class NoteTools {
|
||||
// Proceed with file creation
|
||||
try {
|
||||
const file = await this.vault.create(finalPath, content);
|
||||
|
||||
|
||||
const result: CreateNoteResult = {
|
||||
success: true,
|
||||
path: file.path,
|
||||
@@ -223,6 +243,19 @@ export class NoteTools {
|
||||
originalPath: originalPath
|
||||
};
|
||||
|
||||
// Add word count
|
||||
result.wordCount = ContentUtils.countWords(content);
|
||||
|
||||
// Add link validation if requested
|
||||
if (validateLinks) {
|
||||
result.linkValidation = await LinkUtils.validateLinks(
|
||||
this.vault,
|
||||
this.metadata,
|
||||
content,
|
||||
file.path
|
||||
);
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
|
||||
};
|
||||
@@ -271,7 +304,7 @@ export class NoteTools {
|
||||
}
|
||||
}
|
||||
|
||||
async updateNote(path: string, content: string): Promise<CallToolResult> {
|
||||
async updateNote(path: string, content: string, validateLinks: boolean = true): Promise<CallToolResult> {
|
||||
// Validate path
|
||||
if (!path || path.trim() === '') {
|
||||
return {
|
||||
@@ -329,8 +362,30 @@ export class NoteTools {
|
||||
}
|
||||
|
||||
await this.vault.modify(file, content);
|
||||
|
||||
// Build response with word count and link validation
|
||||
const result: any = {
|
||||
success: true,
|
||||
path: file.path,
|
||||
versionId: VersionUtils.generateVersionId(file),
|
||||
modified: file.stat.mtime
|
||||
};
|
||||
|
||||
// Add word count
|
||||
result.wordCount = ContentUtils.countWords(content);
|
||||
|
||||
// Add link validation if requested
|
||||
if (validateLinks) {
|
||||
result.linkValidation = await LinkUtils.validateLinks(
|
||||
this.vault,
|
||||
this.metadata,
|
||||
content,
|
||||
file.path
|
||||
);
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: "text", text: `Note updated successfully: ${file.path}` }]
|
||||
content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
@@ -542,8 +597,8 @@ export class NoteTools {
|
||||
await this.vault.trash(file, true);
|
||||
destination = `.trash/${file.name}`;
|
||||
} else {
|
||||
// Permanent deletion
|
||||
await this.vault.delete(file);
|
||||
// Delete using user's preferred trash settings (system trash or .trash/ folder)
|
||||
await this.fileManager.trashFile(file);
|
||||
}
|
||||
|
||||
const result: DeleteNoteResult = {
|
||||
@@ -813,7 +868,8 @@ export class NoteTools {
|
||||
async updateSections(
|
||||
path: string,
|
||||
edits: SectionEdit[],
|
||||
ifMatch?: string
|
||||
ifMatch?: string,
|
||||
validateLinks: boolean = true
|
||||
): Promise<CallToolResult> {
|
||||
// Validate path
|
||||
if (!path || path.trim() === '') {
|
||||
@@ -917,6 +973,19 @@ export class NoteTools {
|
||||
sectionsUpdated: edits.length
|
||||
};
|
||||
|
||||
// Add word count
|
||||
result.wordCount = ContentUtils.countWords(newContent);
|
||||
|
||||
// Add link validation if requested
|
||||
if (validateLinks) {
|
||||
result.linkValidation = await LinkUtils.validateLinks(
|
||||
this.vault,
|
||||
this.metadata,
|
||||
newContent,
|
||||
file.path
|
||||
);
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
|
||||
};
|
||||
|
||||
@@ -6,6 +6,7 @@ import { GlobUtils } from '../utils/glob-utils';
|
||||
import { SearchUtils } from '../utils/search-utils';
|
||||
import { WaypointUtils } from '../utils/waypoint-utils';
|
||||
import { LinkUtils } from '../utils/link-utils';
|
||||
import { ContentUtils } from '../utils/content-utils';
|
||||
import { IVaultAdapter, IMetadataCacheAdapter } from '../adapters/interfaces';
|
||||
|
||||
export class VaultTools {
|
||||
@@ -145,6 +146,7 @@ export class VaultTools {
|
||||
limit?: number;
|
||||
cursor?: string;
|
||||
withFrontmatterSummary?: boolean;
|
||||
includeWordCount?: boolean;
|
||||
}): Promise<CallToolResult> {
|
||||
const {
|
||||
path,
|
||||
@@ -154,7 +156,8 @@ export class VaultTools {
|
||||
only = 'any',
|
||||
limit,
|
||||
cursor,
|
||||
withFrontmatterSummary = false
|
||||
withFrontmatterSummary = false,
|
||||
includeWordCount = false
|
||||
} = options;
|
||||
|
||||
let items: Array<FileMetadataWithFrontmatter | DirectoryMetadata> = [];
|
||||
@@ -201,7 +204,7 @@ export class VaultTools {
|
||||
}
|
||||
|
||||
// Collect items based on recursive flag
|
||||
await this.collectItems(targetFolder, items, recursive, includes, excludes, only, withFrontmatterSummary);
|
||||
await this.collectItems(targetFolder, items, recursive, includes, excludes, only, withFrontmatterSummary, includeWordCount);
|
||||
|
||||
// Sort: directories first, then files, alphabetically within each group
|
||||
items.sort((a, b) => {
|
||||
@@ -259,7 +262,8 @@ export class VaultTools {
|
||||
includes?: string[],
|
||||
excludes?: string[],
|
||||
only?: 'files' | 'directories' | 'any',
|
||||
withFrontmatterSummary?: boolean
|
||||
withFrontmatterSummary?: boolean,
|
||||
includeWordCount?: boolean
|
||||
): Promise<void> {
|
||||
for (const item of folder.children) {
|
||||
// Skip the vault root itself
|
||||
@@ -276,6 +280,18 @@ export class VaultTools {
|
||||
if (item instanceof TFile) {
|
||||
if (only !== 'directories') {
|
||||
const fileMetadata = await this.createFileMetadataWithFrontmatter(item, withFrontmatterSummary || false);
|
||||
|
||||
// Optionally include word count (best effort)
|
||||
if (includeWordCount) {
|
||||
try {
|
||||
const content = await this.vault.read(item);
|
||||
fileMetadata.wordCount = ContentUtils.countWords(content);
|
||||
} catch (error) {
|
||||
// Skip word count if file can't be read (binary file, etc.)
|
||||
// wordCount field simply omitted for this file
|
||||
}
|
||||
}
|
||||
|
||||
items.push(fileMetadata);
|
||||
}
|
||||
} else if (item instanceof TFolder) {
|
||||
@@ -285,7 +301,7 @@ export class VaultTools {
|
||||
|
||||
// Recursively collect from subfolders if needed
|
||||
if (recursive) {
|
||||
await this.collectItems(item, items, recursive, includes, excludes, only, withFrontmatterSummary);
|
||||
await this.collectItems(item, items, recursive, includes, excludes, only, withFrontmatterSummary, includeWordCount);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -386,7 +402,7 @@ export class VaultTools {
|
||||
}
|
||||
|
||||
// Phase 3: Discovery Endpoints
|
||||
async stat(path: string): Promise<CallToolResult> {
|
||||
async stat(path: string, includeWordCount: boolean = false): Promise<CallToolResult> {
|
||||
// Validate path
|
||||
if (!PathUtils.isValidVaultPath(path)) {
|
||||
return {
|
||||
@@ -417,11 +433,23 @@ export class VaultTools {
|
||||
|
||||
// Check if it's a file
|
||||
if (item instanceof TFile) {
|
||||
const metadata = this.createFileMetadata(item);
|
||||
|
||||
// Optionally include word count
|
||||
if (includeWordCount) {
|
||||
try {
|
||||
const content = await this.vault.read(item);
|
||||
metadata.wordCount = ContentUtils.countWords(content);
|
||||
} catch (error) {
|
||||
// Skip word count if file can't be read (binary file, etc.)
|
||||
}
|
||||
}
|
||||
|
||||
const result: StatResult = {
|
||||
path: normalizedPath,
|
||||
exists: true,
|
||||
kind: "file",
|
||||
metadata: this.createFileMetadata(item)
|
||||
metadata
|
||||
};
|
||||
return {
|
||||
content: [{
|
||||
|
||||
@@ -73,6 +73,7 @@ export interface FileMetadata {
|
||||
size: number;
|
||||
modified: number;
|
||||
created: number;
|
||||
wordCount?: number;
|
||||
}
|
||||
|
||||
export interface DirectoryMetadata {
|
||||
@@ -181,6 +182,7 @@ export interface ParsedNote {
|
||||
parsedFrontmatter?: Record<string, any>;
|
||||
content: string;
|
||||
contentWithoutFrontmatter?: string;
|
||||
wordCount?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -248,6 +250,8 @@ export interface UpdateSectionsResult {
|
||||
versionId: string;
|
||||
modified: number;
|
||||
sectionsUpdated: number;
|
||||
wordCount?: number;
|
||||
linkValidation?: LinkValidationResult;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -260,6 +264,8 @@ export interface CreateNoteResult {
|
||||
created: number;
|
||||
renamed?: boolean;
|
||||
originalPath?: string;
|
||||
wordCount?: number;
|
||||
linkValidation?: LinkValidationResult;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -305,6 +311,35 @@ export interface UnresolvedLink {
|
||||
suggestions: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Broken link information (note doesn't exist)
|
||||
*/
|
||||
export interface BrokenNoteLink {
|
||||
link: string;
|
||||
line: number;
|
||||
context: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Broken heading link information (note exists but heading doesn't)
|
||||
*/
|
||||
export interface BrokenHeadingLink {
|
||||
link: string;
|
||||
line: number;
|
||||
context: string;
|
||||
note: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Link validation result for write operations
|
||||
*/
|
||||
export interface LinkValidationResult {
|
||||
valid: string[];
|
||||
brokenNotes: BrokenNoteLink[];
|
||||
brokenHeadings: BrokenHeadingLink[];
|
||||
summary: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Result from validate_wikilinks operation
|
||||
*/
|
||||
|
||||
@@ -50,7 +50,6 @@ export class NotificationHistoryModal extends Modal {
|
||||
*/
|
||||
private createFilters(containerEl: HTMLElement): void {
|
||||
const filterContainer = containerEl.createDiv({ cls: 'mcp-history-filters' });
|
||||
filterContainer.style.marginBottom = '16px';
|
||||
|
||||
// Tool name filter using Setting component
|
||||
new Setting(filterContainer)
|
||||
@@ -80,9 +79,6 @@ export class NotificationHistoryModal extends Modal {
|
||||
|
||||
// Results count
|
||||
this.countEl = filterContainer.createDiv({ cls: 'mcp-history-count' });
|
||||
this.countEl.style.marginTop = '8px';
|
||||
this.countEl.style.fontSize = '0.9em';
|
||||
this.countEl.style.color = 'var(--text-muted)';
|
||||
this.updateResultsCount();
|
||||
}
|
||||
|
||||
@@ -91,11 +87,6 @@ export class NotificationHistoryModal extends Modal {
|
||||
*/
|
||||
private createHistoryListContainer(containerEl: HTMLElement): void {
|
||||
this.listContainerEl = containerEl.createDiv({ cls: 'mcp-history-list' });
|
||||
this.listContainerEl.style.maxHeight = '400px';
|
||||
this.listContainerEl.style.overflowY = 'auto';
|
||||
this.listContainerEl.style.marginBottom = '16px';
|
||||
this.listContainerEl.style.border = '1px solid var(--background-modifier-border)';
|
||||
this.listContainerEl.style.borderRadius = '4px';
|
||||
|
||||
// Initial render
|
||||
this.updateHistoryList();
|
||||
@@ -112,36 +103,31 @@ export class NotificationHistoryModal extends Modal {
|
||||
|
||||
if (this.filteredHistory.length === 0) {
|
||||
const emptyEl = this.listContainerEl.createDiv({ cls: 'mcp-history-empty' });
|
||||
emptyEl.style.padding = '24px';
|
||||
emptyEl.style.textAlign = 'center';
|
||||
emptyEl.style.color = 'var(--text-muted)';
|
||||
emptyEl.textContent = 'No entries found';
|
||||
return;
|
||||
}
|
||||
|
||||
this.filteredHistory.forEach((entry, index) => {
|
||||
const entryEl = this.listContainerEl!.createDiv({ cls: 'mcp-history-entry' });
|
||||
entryEl.style.padding = '12px';
|
||||
entryEl.style.borderBottom = index < this.filteredHistory.length - 1
|
||||
? '1px solid var(--background-modifier-border)'
|
||||
: 'none';
|
||||
|
||||
// Add border class to all entries except the last one
|
||||
if (index < this.filteredHistory.length - 1) {
|
||||
entryEl.addClass('mcp-history-entry-border');
|
||||
}
|
||||
|
||||
// Header row
|
||||
const headerEl = entryEl.createDiv({ cls: 'mcp-history-entry-header' });
|
||||
headerEl.style.display = 'flex';
|
||||
headerEl.style.justifyContent = 'space-between';
|
||||
headerEl.style.marginBottom = '8px';
|
||||
|
||||
// Tool name and status
|
||||
const titleEl = headerEl.createDiv();
|
||||
const statusIcon = entry.success ? '✅' : '❌';
|
||||
const toolName = titleEl.createEl('strong', { text: `${statusIcon} ${entry.toolName}` });
|
||||
toolName.style.color = entry.success ? 'var(--text-success)' : 'var(--text-error)';
|
||||
|
||||
// Add dynamic color class based on success/error
|
||||
toolName.addClass(entry.success ? 'mcp-history-entry-title-success' : 'mcp-history-entry-title-error');
|
||||
|
||||
// Timestamp and duration
|
||||
const metaEl = headerEl.createDiv();
|
||||
metaEl.style.fontSize = '0.85em';
|
||||
metaEl.style.color = 'var(--text-muted)';
|
||||
const metaEl = headerEl.createDiv({ cls: 'mcp-history-entry-header-meta' });
|
||||
const timestamp = new Date(entry.timestamp).toLocaleTimeString();
|
||||
const durationStr = entry.duration ? ` • ${entry.duration}ms` : '';
|
||||
metaEl.textContent = `${timestamp}${durationStr}`;
|
||||
@@ -149,25 +135,12 @@ export class NotificationHistoryModal extends Modal {
|
||||
// Arguments
|
||||
if (entry.args && Object.keys(entry.args).length > 0) {
|
||||
const argsEl = entryEl.createDiv({ cls: 'mcp-history-entry-args' });
|
||||
argsEl.style.fontSize = '0.85em';
|
||||
argsEl.style.fontFamily = 'monospace';
|
||||
argsEl.style.backgroundColor = 'var(--background-secondary)';
|
||||
argsEl.style.padding = '8px';
|
||||
argsEl.style.borderRadius = '4px';
|
||||
argsEl.style.marginBottom = '8px';
|
||||
argsEl.style.overflowX = 'auto';
|
||||
argsEl.textContent = JSON.stringify(entry.args, null, 2);
|
||||
}
|
||||
|
||||
// Error message
|
||||
if (!entry.success && entry.error) {
|
||||
const errorEl = entryEl.createDiv({ cls: 'mcp-history-entry-error' });
|
||||
errorEl.style.fontSize = '0.85em';
|
||||
errorEl.style.color = 'var(--text-error)';
|
||||
errorEl.style.backgroundColor = 'var(--background-secondary)';
|
||||
errorEl.style.padding = '8px';
|
||||
errorEl.style.borderRadius = '4px';
|
||||
errorEl.style.fontFamily = 'monospace';
|
||||
errorEl.textContent = entry.error;
|
||||
}
|
||||
});
|
||||
@@ -186,9 +159,6 @@ export class NotificationHistoryModal extends Modal {
|
||||
*/
|
||||
private createActions(containerEl: HTMLElement): void {
|
||||
const actionsContainer = containerEl.createDiv({ cls: 'mcp-history-actions' });
|
||||
actionsContainer.style.display = 'flex';
|
||||
actionsContainer.style.gap = '8px';
|
||||
actionsContainer.style.justifyContent = 'flex-end';
|
||||
|
||||
// Export button
|
||||
const exportButton = actionsContainer.createEl('button', { text: 'Export to Clipboard' });
|
||||
|
||||
42
src/utils/content-utils.ts
Normal file
42
src/utils/content-utils.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
import { FrontmatterUtils } from './frontmatter-utils';
|
||||
|
||||
/**
|
||||
* Utility class for content analysis and manipulation
|
||||
*/
|
||||
export class ContentUtils {
|
||||
/**
|
||||
* Count words in content, excluding frontmatter and Obsidian comments
|
||||
* Includes all other content: headings, paragraphs, lists, code blocks, inline code
|
||||
*
|
||||
* @param content The full markdown content to analyze
|
||||
* @returns Word count (excludes frontmatter and Obsidian comments only)
|
||||
*/
|
||||
static countWords(content: string): number {
|
||||
// Extract frontmatter to get content without it
|
||||
const { contentWithoutFrontmatter } = FrontmatterUtils.extractFrontmatter(content);
|
||||
|
||||
// Remove Obsidian comments (%% ... %%)
|
||||
// Handle both single-line and multi-line comments
|
||||
const withoutComments = this.removeObsidianComments(contentWithoutFrontmatter);
|
||||
|
||||
// Split by whitespace and count non-empty tokens
|
||||
const words = withoutComments
|
||||
.split(/\s+/)
|
||||
.filter(word => word.trim().length > 0);
|
||||
|
||||
return words.length;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove Obsidian comments from content
|
||||
* Handles both %% single line %% and multi-line comments
|
||||
*
|
||||
* @param content Content to process
|
||||
* @returns Content with Obsidian comments removed
|
||||
*/
|
||||
private static removeObsidianComments(content: string): string {
|
||||
// Remove Obsidian comments: %% ... %%
|
||||
// Use non-greedy match to handle multiple comments
|
||||
return content.replace(/%%[\s\S]*?%%/g, '');
|
||||
}
|
||||
}
|
||||
@@ -41,6 +41,46 @@ export interface UnresolvedLink {
|
||||
suggestions: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Broken link information (note doesn't exist)
|
||||
*/
|
||||
export interface BrokenNoteLink {
|
||||
/** Original link text */
|
||||
link: string;
|
||||
/** Line number where the link appears */
|
||||
line: number;
|
||||
/** Context snippet around the link */
|
||||
context: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Broken heading link information (note exists but heading doesn't)
|
||||
*/
|
||||
export interface BrokenHeadingLink {
|
||||
/** Original link text */
|
||||
link: string;
|
||||
/** Line number where the link appears */
|
||||
line: number;
|
||||
/** Context snippet around the link */
|
||||
context: string;
|
||||
/** The note path that exists */
|
||||
note: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Link validation result
|
||||
*/
|
||||
export interface LinkValidationResult {
|
||||
/** Array of valid links */
|
||||
valid: string[];
|
||||
/** Array of broken note links (note doesn't exist) */
|
||||
brokenNotes: BrokenNoteLink[];
|
||||
/** Array of broken heading links (note exists but heading doesn't) */
|
||||
brokenHeadings: BrokenHeadingLink[];
|
||||
/** Human-readable summary */
|
||||
summary: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Backlink occurrence in a file
|
||||
*/
|
||||
@@ -394,4 +434,108 @@ export class LinkUtils {
|
||||
|
||||
return { resolvedLinks, unresolvedLinks };
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate all links in content (wikilinks, heading links, and embeds)
|
||||
* Returns categorized results: valid, broken notes, and broken headings
|
||||
*
|
||||
* @param vault Vault adapter for file operations
|
||||
* @param metadata Metadata cache adapter for link resolution
|
||||
* @param content File content to validate
|
||||
* @param sourcePath Path of the file containing the links
|
||||
* @returns Structured validation result with categorized links
|
||||
*/
|
||||
static async validateLinks(
|
||||
vault: IVaultAdapter,
|
||||
metadata: IMetadataCacheAdapter,
|
||||
content: string,
|
||||
sourcePath: string
|
||||
): Promise<LinkValidationResult> {
|
||||
const valid: string[] = [];
|
||||
const brokenNotes: BrokenNoteLink[] = [];
|
||||
const brokenHeadings: BrokenHeadingLink[] = [];
|
||||
|
||||
// Parse all wikilinks from content (includes embeds which start with !)
|
||||
const wikilinks = this.parseWikilinks(content);
|
||||
const lines = content.split('\n');
|
||||
|
||||
for (const link of wikilinks) {
|
||||
// Check if this is a heading link
|
||||
const hasHeading = link.target.includes('#');
|
||||
|
||||
if (hasHeading) {
|
||||
// Split note path and heading
|
||||
const [notePath, ...headingParts] = link.target.split('#');
|
||||
const heading = headingParts.join('#'); // Rejoin in case heading has # in it
|
||||
|
||||
// Try to resolve the note
|
||||
const resolvedFile = this.resolveLink(vault, metadata, sourcePath, notePath || sourcePath);
|
||||
|
||||
if (!resolvedFile) {
|
||||
// Note doesn't exist
|
||||
const context = this.extractSnippet(lines, link.line - 1, 100);
|
||||
brokenNotes.push({
|
||||
link: link.raw,
|
||||
line: link.line,
|
||||
context
|
||||
});
|
||||
} else {
|
||||
// Note exists, check if heading exists
|
||||
const fileCache = metadata.getFileCache(resolvedFile);
|
||||
const headings = fileCache?.headings || [];
|
||||
|
||||
// Normalize heading for comparison (remove # and trim)
|
||||
const normalizedHeading = heading.trim().toLowerCase();
|
||||
const headingExists = headings.some(h =>
|
||||
h.heading.trim().toLowerCase() === normalizedHeading
|
||||
);
|
||||
|
||||
if (headingExists) {
|
||||
// Both note and heading exist
|
||||
valid.push(link.raw);
|
||||
} else {
|
||||
// Note exists but heading doesn't
|
||||
const context = this.extractSnippet(lines, link.line - 1, 100);
|
||||
brokenHeadings.push({
|
||||
link: link.raw,
|
||||
line: link.line,
|
||||
context,
|
||||
note: resolvedFile.path
|
||||
});
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Regular link or embed (no heading)
|
||||
const resolvedFile = this.resolveLink(vault, metadata, sourcePath, link.target);
|
||||
|
||||
if (resolvedFile) {
|
||||
valid.push(link.raw);
|
||||
} else {
|
||||
const context = this.extractSnippet(lines, link.line - 1, 100);
|
||||
brokenNotes.push({
|
||||
link: link.raw,
|
||||
line: link.line,
|
||||
context
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Generate summary
|
||||
const totalLinks = valid.length + brokenNotes.length + brokenHeadings.length;
|
||||
let summary = `${totalLinks} links: ${valid.length} valid`;
|
||||
if (brokenNotes.length > 0) {
|
||||
summary += `, ${brokenNotes.length} broken note${brokenNotes.length === 1 ? '' : 's'}`;
|
||||
}
|
||||
if (brokenHeadings.length > 0) {
|
||||
summary += `, ${brokenHeadings.length} broken heading${brokenHeadings.length === 1 ? '' : 's'}`;
|
||||
}
|
||||
|
||||
return {
|
||||
valid,
|
||||
brokenNotes,
|
||||
brokenHeadings,
|
||||
summary
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
182
styles.css
182
styles.css
@@ -51,3 +51,185 @@
|
||||
margin: 0.5em 0 0.25em 0;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
/* Authentication section */
|
||||
.mcp-auth-section { margin-bottom: 20px; }
|
||||
.mcp-auth-summary {
|
||||
font-size: 1.17em;
|
||||
font-weight: bold;
|
||||
margin-bottom: 12px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
/* API key display */
|
||||
.mcp-key-display {
|
||||
padding: 12px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-family: monospace;
|
||||
font-size: 0.9em;
|
||||
word-break: break-all;
|
||||
user-select: all;
|
||||
cursor: text;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
|
||||
/* Tab navigation */
|
||||
.mcp-config-tabs {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
margin-bottom: 16px;
|
||||
border-bottom: 1px solid var(--background-modifier-border);
|
||||
}
|
||||
|
||||
.mcp-tab {
|
||||
padding: 8px 16px;
|
||||
border: none;
|
||||
background: none;
|
||||
cursor: pointer;
|
||||
border-bottom: 2px solid transparent;
|
||||
}
|
||||
|
||||
.mcp-tab-active {
|
||||
border-bottom-color: var(--interactive-accent);
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* Config display */
|
||||
.mcp-config-display {
|
||||
padding: 12px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-size: 0.85em;
|
||||
overflow-x: auto;
|
||||
user-select: text;
|
||||
cursor: text;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
/* Helper text */
|
||||
.mcp-file-path {
|
||||
padding: 8px;
|
||||
background-color: var(--background-secondary);
|
||||
border-radius: 4px;
|
||||
font-family: monospace;
|
||||
font-size: 0.9em;
|
||||
margin-bottom: 12px;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-usage-note {
|
||||
font-size: 0.9em;
|
||||
color: var(--text-muted);
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* Additional utility classes */
|
||||
.mcp-heading {
|
||||
margin-top: 24px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
.mcp-container { margin-bottom: 20px; }
|
||||
|
||||
.mcp-button-group {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
.mcp-label {
|
||||
margin-bottom: 4px;
|
||||
font-size: 0.9em;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-config-content {
|
||||
margin-top: 16px;
|
||||
}
|
||||
|
||||
.mcp-config-button {
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
/* Notification History Modal */
|
||||
.mcp-notification-history-modal {
|
||||
/* Base modal styling handled by Obsidian */
|
||||
}
|
||||
|
||||
.mcp-history-filters {
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
|
||||
.mcp-history-count {
|
||||
margin-top: 8px;
|
||||
font-size: 0.9em;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-history-list {
|
||||
max-height: 400px;
|
||||
overflow-y: auto;
|
||||
margin-bottom: 16px;
|
||||
border: 1px solid var(--background-modifier-border);
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.mcp-history-empty {
|
||||
padding: 24px;
|
||||
text-align: center;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-history-entry {
|
||||
padding: 12px;
|
||||
}
|
||||
|
||||
.mcp-history-entry-header {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
|
||||
.mcp-history-entry-header-meta {
|
||||
font-size: 0.85em;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.mcp-history-entry-args {
|
||||
font-size: 0.85em;
|
||||
font-family: monospace;
|
||||
background-color: var(--background-secondary);
|
||||
padding: 8px;
|
||||
border-radius: 4px;
|
||||
margin-bottom: 8px;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.mcp-history-entry-error {
|
||||
font-size: 0.85em;
|
||||
color: var(--text-error);
|
||||
background-color: var(--background-secondary);
|
||||
padding: 8px;
|
||||
border-radius: 4px;
|
||||
font-family: monospace;
|
||||
}
|
||||
|
||||
.mcp-history-actions {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
justify-content: flex-end;
|
||||
}
|
||||
|
||||
/* Dynamic state classes */
|
||||
.mcp-history-entry-border {
|
||||
border-bottom: 1px solid var(--background-modifier-border);
|
||||
}
|
||||
|
||||
.mcp-history-entry-title-success {
|
||||
color: var(--text-success);
|
||||
}
|
||||
|
||||
.mcp-history-entry-title-error {
|
||||
color: var(--text-error);
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { NoteTools } from '../src/tools/note-tools';
|
||||
import { createMockVaultAdapter, createMockFileManagerAdapter, createMockTFile, createMockTFolder } from './__mocks__/adapters';
|
||||
import { createMockVaultAdapter, createMockFileManagerAdapter, createMockMetadataCacheAdapter, createMockTFile, createMockTFolder } from './__mocks__/adapters';
|
||||
import { App, Vault, TFile, TFolder } from 'obsidian';
|
||||
|
||||
// Mock PathUtils since NoteTools uses it extensively
|
||||
@@ -18,6 +18,18 @@ jest.mock('../src/utils/path-utils', () => ({
|
||||
}
|
||||
}));
|
||||
|
||||
// Mock LinkUtils for link validation tests
|
||||
jest.mock('../src/utils/link-utils', () => ({
|
||||
LinkUtils: {
|
||||
validateLinks: jest.fn().mockResolvedValue({
|
||||
valid: [],
|
||||
brokenNotes: [],
|
||||
brokenHeadings: [],
|
||||
summary: 'No links found'
|
||||
})
|
||||
}
|
||||
}));
|
||||
|
||||
// Import the mocked PathUtils
|
||||
import { PathUtils } from '../src/utils/path-utils';
|
||||
|
||||
@@ -25,13 +37,15 @@ describe('NoteTools', () => {
|
||||
let noteTools: NoteTools;
|
||||
let mockVault: ReturnType<typeof createMockVaultAdapter>;
|
||||
let mockFileManager: ReturnType<typeof createMockFileManagerAdapter>;
|
||||
let mockMetadata: ReturnType<typeof createMockMetadataCacheAdapter>;
|
||||
let mockApp: App;
|
||||
|
||||
beforeEach(() => {
|
||||
mockVault = createMockVaultAdapter();
|
||||
mockFileManager = createMockFileManagerAdapter();
|
||||
mockMetadata = createMockMetadataCacheAdapter();
|
||||
mockApp = new App();
|
||||
noteTools = new NoteTools(mockVault, mockFileManager, mockApp);
|
||||
noteTools = new NoteTools(mockVault, mockFileManager, mockMetadata, mockApp);
|
||||
|
||||
// Reset all mocks
|
||||
jest.clearAllMocks();
|
||||
@@ -48,7 +62,10 @@ describe('NoteTools', () => {
|
||||
const result = await noteTools.readNote('test.md');
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
expect(result.content[0].text).toBe(content);
|
||||
// Now returns JSON with content and wordCount
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.content).toBe(content);
|
||||
expect(parsed.wordCount).toBe(7); // Test Note This is test content
|
||||
expect(mockVault.read).toHaveBeenCalledWith(mockFile);
|
||||
});
|
||||
|
||||
@@ -99,6 +116,93 @@ describe('NoteTools', () => {
|
||||
// frontmatter field is the raw YAML string
|
||||
expect(parsed.frontmatter).toBeDefined();
|
||||
});
|
||||
|
||||
it('should include word count when withContent is true', async () => {
|
||||
const mockFile = createMockTFile('test.md');
|
||||
const content = '# Test Note\n\nThis is a test note with some words.';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await noteTools.readNote('test.md', { withContent: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.content).toBe(content);
|
||||
expect(parsed.wordCount).toBe(11); // Test Note This is a test note with some words
|
||||
});
|
||||
|
||||
it('should include word count when parseFrontmatter is true', async () => {
|
||||
const mockFile = createMockTFile('test.md');
|
||||
const content = '---\ntitle: Test\n---\n\nThis is content.';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await noteTools.readNote('test.md', { parseFrontmatter: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(3); // "This is content."
|
||||
});
|
||||
|
||||
it('should exclude frontmatter from word count', async () => {
|
||||
const mockFile = createMockTFile('test.md');
|
||||
const content = '---\ntitle: Test Note\ntags: [test, example]\n---\n\nActual content words.';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await noteTools.readNote('test.md', { parseFrontmatter: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(3); // "Actual content words."
|
||||
});
|
||||
|
||||
it('should exclude Obsidian comments from word count', async () => {
|
||||
const mockFile = createMockTFile('test.md');
|
||||
const content = 'Visible text %% Hidden comment %% more visible.';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await noteTools.readNote('test.md', { withContent: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(4); // "Visible text more visible"
|
||||
});
|
||||
|
||||
it('should return 0 word count for empty file', async () => {
|
||||
const mockFile = createMockTFile('empty.md');
|
||||
const content = '';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await noteTools.readNote('empty.md', { withContent: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(0);
|
||||
});
|
||||
|
||||
it('should return JSON format even with default options', async () => {
|
||||
const mockFile = createMockTFile('test.md');
|
||||
const content = '# Test Note\n\nContent here.';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await noteTools.readNote('test.md');
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
// Now returns JSON even with default options
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.content).toBe(content);
|
||||
expect(parsed.wordCount).toBe(5); // Test Note Content here
|
||||
});
|
||||
});
|
||||
|
||||
describe('createNote', () => {
|
||||
@@ -137,7 +241,7 @@ describe('NoteTools', () => {
|
||||
|
||||
(PathUtils.fileExists as jest.Mock).mockReturnValue(true);
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.delete = jest.fn().mockResolvedValue(undefined);
|
||||
mockFileManager.trashFile = jest.fn().mockResolvedValue(undefined);
|
||||
mockVault.create = jest.fn().mockResolvedValue(mockFile);
|
||||
(PathUtils.folderExists as jest.Mock).mockReturnValue(false);
|
||||
(PathUtils.getParentPath as jest.Mock).mockReturnValue('');
|
||||
@@ -145,7 +249,7 @@ describe('NoteTools', () => {
|
||||
const result = await noteTools.createNote('test.md', 'content', false, 'overwrite');
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
expect(mockVault.delete).toHaveBeenCalledWith(mockFile);
|
||||
expect(mockFileManager.trashFile).toHaveBeenCalledWith(mockFile);
|
||||
expect(mockVault.create).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
@@ -273,7 +377,10 @@ describe('NoteTools', () => {
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
expect(mockVault.modify).toHaveBeenCalledWith(mockFile, newContent);
|
||||
expect(result.content[0].text).toContain('updated successfully');
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.success).toBe(true);
|
||||
expect(parsed.path).toBe('test.md');
|
||||
expect(parsed.wordCount).toBeDefined();
|
||||
});
|
||||
|
||||
it('should return error if file not found', async () => {
|
||||
@@ -344,12 +451,12 @@ describe('NoteTools', () => {
|
||||
const mockFile = createMockTFile('test.md');
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.delete = jest.fn().mockResolvedValue(undefined);
|
||||
mockFileManager.trashFile = jest.fn().mockResolvedValue(undefined);
|
||||
|
||||
const result = await noteTools.deleteNote('test.md', false, false);
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
expect(mockVault.delete).toHaveBeenCalledWith(mockFile);
|
||||
expect(mockFileManager.trashFile).toHaveBeenCalledWith(mockFile);
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.deleted).toBe(true);
|
||||
expect(parsed.soft).toBe(false);
|
||||
@@ -1017,4 +1124,206 @@ Some text
|
||||
expect(result.content[0].text).toContain('empty');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Word Count and Link Validation', () => {
|
||||
beforeEach(() => {
|
||||
// Setup default mocks for all word count/link validation tests
|
||||
(PathUtils.isValidVaultPath as jest.Mock).mockReturnValue(true);
|
||||
(PathUtils.fileExists as jest.Mock).mockReturnValue(false);
|
||||
(PathUtils.folderExists as jest.Mock).mockReturnValue(false);
|
||||
(PathUtils.getParentPath as jest.Mock).mockReturnValue('');
|
||||
(PathUtils.resolveFile as jest.Mock).mockImplementation((app: any, path: string) => {
|
||||
// Return null for non-existent files
|
||||
return null;
|
||||
});
|
||||
});
|
||||
|
||||
describe('createNote with word count and link validation', () => {
|
||||
beforeEach(() => {
|
||||
// Setup mocks for these tests
|
||||
(PathUtils.fileExists as jest.Mock).mockReturnValue(false);
|
||||
(PathUtils.folderExists as jest.Mock).mockReturnValue(false);
|
||||
(PathUtils.getParentPath as jest.Mock).mockReturnValue('');
|
||||
});
|
||||
|
||||
it('should return word count when creating a note', async () => {
|
||||
const content = 'This is a test note with some words.';
|
||||
const mockFile = createMockTFile('test-note.md');
|
||||
|
||||
mockVault.create = jest.fn().mockResolvedValue(mockFile);
|
||||
|
||||
const result = await noteTools.createNote('test-note.md', content);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(8);
|
||||
});
|
||||
|
||||
it('should return link validation structure when creating a note', async () => {
|
||||
const content = 'This note has some [[links]].';
|
||||
const mockFile = createMockTFile('test-note.md');
|
||||
|
||||
mockVault.create = jest.fn().mockResolvedValue(mockFile);
|
||||
|
||||
const result = await noteTools.createNote('test-note.md', content);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.linkValidation).toBeDefined();
|
||||
expect(parsed.linkValidation).toHaveProperty('valid');
|
||||
expect(parsed.linkValidation).toHaveProperty('brokenNotes');
|
||||
expect(parsed.linkValidation).toHaveProperty('brokenHeadings');
|
||||
expect(parsed.linkValidation).toHaveProperty('summary');
|
||||
});
|
||||
|
||||
it('should skip link validation when validateLinks is false', async () => {
|
||||
const content = 'This note links to [[Some Note]].';
|
||||
const mockFile = createMockTFile('test-note.md');
|
||||
|
||||
mockVault.create = jest.fn().mockResolvedValue(mockFile);
|
||||
|
||||
const result = await noteTools.createNote('test-note.md', content, false, 'error', false);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBeDefined();
|
||||
expect(parsed.linkValidation).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('updateNote with word count and link validation', () => {
|
||||
it('should return word count when updating a note', async () => {
|
||||
const mockFile = createMockTFile('update-test.md');
|
||||
const newContent = 'This is updated content with several more words.';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue('Old content');
|
||||
mockVault.modify = jest.fn().mockResolvedValue(undefined);
|
||||
|
||||
const result = await noteTools.updateNote('update-test.md', newContent);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(8);
|
||||
});
|
||||
|
||||
it('should return link validation structure when updating a note', async () => {
|
||||
const mockFile = createMockTFile('update-test.md');
|
||||
const newContent = 'Updated with [[Referenced]] link.';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue('Old content');
|
||||
mockVault.modify = jest.fn().mockResolvedValue(undefined);
|
||||
|
||||
const result = await noteTools.updateNote('update-test.md', newContent);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.linkValidation).toBeDefined();
|
||||
expect(parsed.linkValidation).toHaveProperty('valid');
|
||||
expect(parsed.linkValidation).toHaveProperty('brokenNotes');
|
||||
expect(parsed.linkValidation).toHaveProperty('brokenHeadings');
|
||||
});
|
||||
|
||||
it('should skip link validation when validateLinks is false', async () => {
|
||||
const mockFile = createMockTFile('update-test.md');
|
||||
const newContent = 'Updated content with [[Some Link]].';
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue('Old content');
|
||||
mockVault.modify = jest.fn().mockResolvedValue(undefined);
|
||||
|
||||
const result = await noteTools.updateNote('update-test.md', newContent, false);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBeDefined();
|
||||
expect(parsed.linkValidation).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('updateSections with word count and link validation', () => {
|
||||
it('should return word count for entire note after section update', async () => {
|
||||
const mockFile = createMockTFile('sections-test.md');
|
||||
const edits = [{ startLine: 2, endLine: 2, content: 'Updated line two with more words' }];
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue('Line 1\nLine 2\nLine 3');
|
||||
mockVault.modify = jest.fn().mockResolvedValue(undefined);
|
||||
|
||||
const result = await noteTools.updateSections('sections-test.md', edits);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBeGreaterThan(0);
|
||||
expect(parsed.sectionsUpdated).toBe(1);
|
||||
});
|
||||
|
||||
it('should return link validation structure for entire note after section update', async () => {
|
||||
const mockFile = createMockTFile('sections-test.md');
|
||||
const edits = [{ startLine: 2, endLine: 2, content: 'See [[Link Target]] here' }];
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue('Line 1\nLine 2\nLine 3');
|
||||
mockVault.modify = jest.fn().mockResolvedValue(undefined);
|
||||
|
||||
const result = await noteTools.updateSections('sections-test.md', edits);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.linkValidation).toBeDefined();
|
||||
expect(parsed.linkValidation).toHaveProperty('valid');
|
||||
expect(parsed.linkValidation).toHaveProperty('brokenNotes');
|
||||
});
|
||||
|
||||
it('should skip link validation when validateLinks is false', async () => {
|
||||
const mockFile = createMockTFile('sections-test.md');
|
||||
const edits = [{ startLine: 1, endLine: 1, content: 'Updated with [[Link]]' }];
|
||||
|
||||
(PathUtils.resolveFile as jest.Mock).mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue('Line 1\nLine 2\nLine 3');
|
||||
mockVault.modify = jest.fn().mockResolvedValue(undefined);
|
||||
|
||||
const result = await noteTools.updateSections('sections-test.md', edits, undefined, false);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBeDefined();
|
||||
expect(parsed.linkValidation).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Word count with frontmatter and comments', () => {
|
||||
it('should exclude frontmatter from word count', async () => {
|
||||
const content = `---
|
||||
title: Test Note
|
||||
tags: [test]
|
||||
---
|
||||
|
||||
This is the actual content with words.`;
|
||||
const mockFile = createMockTFile('test-note.md');
|
||||
|
||||
mockVault.create = jest.fn().mockResolvedValue(mockFile);
|
||||
|
||||
const result = await noteTools.createNote('test-note.md', content);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(7); // "This is the actual content with words."
|
||||
});
|
||||
|
||||
it('should exclude Obsidian comments from word count', async () => {
|
||||
const content = `This is visible. %% This is hidden %% More visible.`;
|
||||
const mockFile = createMockTFile('test-note.md');
|
||||
|
||||
mockVault.create = jest.fn().mockResolvedValue(mockFile);
|
||||
|
||||
const result = await noteTools.createNote('test-note.md', content);
|
||||
|
||||
expect(result.isError).toBeFalsy();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.wordCount).toBe(5); // "This is visible. More visible." = 5 words
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,6 +1,6 @@
|
||||
import { App } from 'obsidian';
|
||||
import { NoteTools } from '../src/tools/note-tools';
|
||||
import { createMockVaultAdapter, createMockFileManagerAdapter, createMockTFile, createMockTFolder } from './__mocks__/adapters';
|
||||
import { createMockVaultAdapter, createMockFileManagerAdapter, createMockMetadataCacheAdapter, createMockTFile, createMockTFolder } from './__mocks__/adapters';
|
||||
|
||||
// Mock Obsidian API
|
||||
jest.mock('obsidian');
|
||||
@@ -9,11 +9,13 @@ describe('Enhanced Parent Folder Detection', () => {
|
||||
let noteTools: NoteTools;
|
||||
let mockVault: ReturnType<typeof createMockVaultAdapter>;
|
||||
let mockFileManager: ReturnType<typeof createMockFileManagerAdapter>;
|
||||
let mockMetadata: ReturnType<typeof createMockMetadataCacheAdapter>;
|
||||
let mockApp: App;
|
||||
|
||||
beforeEach(() => {
|
||||
mockVault = createMockVaultAdapter();
|
||||
mockFileManager = createMockFileManagerAdapter();
|
||||
mockMetadata = createMockMetadataCacheAdapter();
|
||||
|
||||
// Create a minimal mock App that supports PathUtils
|
||||
// Use a getter to ensure it always uses the current mock
|
||||
@@ -25,7 +27,7 @@ describe('Enhanced Parent Folder Detection', () => {
|
||||
}
|
||||
} as any;
|
||||
|
||||
noteTools = new NoteTools(mockVault, mockFileManager, mockApp);
|
||||
noteTools = new NoteTools(mockVault, mockFileManager, mockMetadata, mockApp);
|
||||
});
|
||||
|
||||
describe('Explicit parent folder detection', () => {
|
||||
|
||||
146
tests/utils/content-utils.test.ts
Normal file
146
tests/utils/content-utils.test.ts
Normal file
@@ -0,0 +1,146 @@
|
||||
import { ContentUtils } from '../../src/utils/content-utils';
|
||||
|
||||
describe('ContentUtils', () => {
|
||||
describe('countWords', () => {
|
||||
it('should count words in simple text', () => {
|
||||
const content = 'This is a simple test.';
|
||||
expect(ContentUtils.countWords(content)).toBe(5);
|
||||
});
|
||||
|
||||
it('should count words with multiple spaces', () => {
|
||||
const content = 'This is a test';
|
||||
expect(ContentUtils.countWords(content)).toBe(4);
|
||||
});
|
||||
|
||||
it('should exclude frontmatter from word count', () => {
|
||||
const content = `---
|
||||
title: My Note
|
||||
tags: [test, example]
|
||||
---
|
||||
|
||||
This is the actual content with seven words.`;
|
||||
expect(ContentUtils.countWords(content)).toBe(8); // "This is the actual content with seven words."
|
||||
});
|
||||
|
||||
it('should include code blocks in word count', () => {
|
||||
const content = `This is text.
|
||||
|
||||
\`\`\`javascript
|
||||
function test() {
|
||||
return true;
|
||||
}
|
||||
\`\`\`
|
||||
|
||||
More text here.`;
|
||||
// Counts: This, is, text., ```javascript, function, test(), {, return, true;, }, ```, More, text, here.
|
||||
expect(ContentUtils.countWords(content)).toBe(14);
|
||||
});
|
||||
|
||||
it('should include inline code in word count', () => {
|
||||
const content = 'Use the `console.log` function to debug.';
|
||||
// Counts: Use, the, `console.log`, function, to, debug.
|
||||
expect(ContentUtils.countWords(content)).toBe(6);
|
||||
});
|
||||
|
||||
it('should exclude Obsidian comments from word count', () => {
|
||||
const content = `This is visible text.
|
||||
|
||||
%% This is a comment and should not be counted %%
|
||||
|
||||
More visible text.`;
|
||||
expect(ContentUtils.countWords(content)).toBe(7); // "This is visible text. More visible text."
|
||||
});
|
||||
|
||||
it('should exclude multi-line Obsidian comments', () => {
|
||||
const content = `Start of note.
|
||||
|
||||
%%
|
||||
This is a multi-line comment
|
||||
that spans several lines
|
||||
and should not be counted
|
||||
%%
|
||||
|
||||
End of note.`;
|
||||
expect(ContentUtils.countWords(content)).toBe(6); // "Start of note. End of note."
|
||||
});
|
||||
|
||||
it('should handle multiple Obsidian comments', () => {
|
||||
const content = `First section. %% comment one %% Second section. %% comment two %% Third section.`;
|
||||
expect(ContentUtils.countWords(content)).toBe(6); // "First section. Second section. Third section."
|
||||
});
|
||||
|
||||
it('should count zero words for empty content', () => {
|
||||
expect(ContentUtils.countWords('')).toBe(0);
|
||||
});
|
||||
|
||||
it('should count zero words for only whitespace', () => {
|
||||
expect(ContentUtils.countWords(' \n\n \t ')).toBe(0);
|
||||
});
|
||||
|
||||
it('should count zero words for only frontmatter', () => {
|
||||
const content = `---
|
||||
title: Test
|
||||
---`;
|
||||
expect(ContentUtils.countWords(content)).toBe(0);
|
||||
});
|
||||
|
||||
it('should count zero words for only comments', () => {
|
||||
const content = '%% This is just a comment %%';
|
||||
expect(ContentUtils.countWords(content)).toBe(0);
|
||||
});
|
||||
|
||||
it('should handle content with headings', () => {
|
||||
const content = `# Main Heading
|
||||
|
||||
This is a paragraph with some text.
|
||||
|
||||
## Subheading
|
||||
|
||||
More text here.`;
|
||||
// Counts: #, Main, Heading, This, is, a, paragraph, with, some, text., ##, Subheading, More, text, here.
|
||||
expect(ContentUtils.countWords(content)).toBe(15);
|
||||
});
|
||||
|
||||
it('should handle content with lists', () => {
|
||||
const content = `- Item one
|
||||
- Item two
|
||||
- Item three
|
||||
|
||||
1. Numbered one
|
||||
2. Numbered two`;
|
||||
// Counts: -, Item, one, -, Item, two, -, Item, three, 1., Numbered, one, 2., Numbered, two
|
||||
expect(ContentUtils.countWords(content)).toBe(15);
|
||||
});
|
||||
|
||||
it('should handle content with wikilinks', () => {
|
||||
const content = 'See [[Other Note]] for more details.';
|
||||
expect(ContentUtils.countWords(content)).toBe(6); // Links are counted as words
|
||||
});
|
||||
|
||||
it('should handle complex mixed content', () => {
|
||||
const content = `---
|
||||
title: Complex Note
|
||||
tags: [test]
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
This is a test note with [[links]] and \`code\`.
|
||||
|
||||
%% This comment should not be counted %%
|
||||
|
||||
\`\`\`python
|
||||
def hello():
|
||||
print("world")
|
||||
\`\`\`
|
||||
|
||||
## Conclusion
|
||||
|
||||
Final thoughts here.`;
|
||||
// Excluding frontmatter and comment, counts:
|
||||
// #, Introduction, This, is, a, test, note, with, [[links]], and, `code`.,
|
||||
// ```python, def, hello():, print("world"), ```, ##, Conclusion, Final, thoughts, here.
|
||||
expect(ContentUtils.countWords(content)).toBe(21);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -195,6 +195,97 @@ describe('VaultTools', () => {
|
||||
expect(result.isError).toBe(true);
|
||||
expect(result.content[0].text).toContain('Invalid path');
|
||||
});
|
||||
|
||||
it('should include word count when includeWordCount is true', async () => {
|
||||
const mockFile = createMockTFile('test.md', {
|
||||
ctime: 1000,
|
||||
mtime: 2000,
|
||||
size: 500
|
||||
});
|
||||
const content = '# Test Note\n\nThis is a test note with some words.';
|
||||
|
||||
mockVault.getAbstractFileByPath = jest.fn().mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await vaultTools.stat('test.md', true);
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.exists).toBe(true);
|
||||
expect(parsed.kind).toBe('file');
|
||||
expect(parsed.metadata.wordCount).toBe(11); // Test Note This is a test note with some words
|
||||
expect(mockVault.read).toHaveBeenCalledWith(mockFile);
|
||||
});
|
||||
|
||||
it('should not include word count when includeWordCount is false', async () => {
|
||||
const mockFile = createMockTFile('test.md', {
|
||||
ctime: 1000,
|
||||
mtime: 2000,
|
||||
size: 500
|
||||
});
|
||||
|
||||
mockVault.getAbstractFileByPath = jest.fn().mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn();
|
||||
|
||||
const result = await vaultTools.stat('test.md', false);
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.metadata.wordCount).toBeUndefined();
|
||||
expect(mockVault.read).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should exclude frontmatter from word count in stat', async () => {
|
||||
const mockFile = createMockTFile('test.md', {
|
||||
ctime: 1000,
|
||||
mtime: 2000,
|
||||
size: 500
|
||||
});
|
||||
const content = '---\ntitle: Test Note\ntags: [test]\n---\n\nActual content words.';
|
||||
|
||||
mockVault.getAbstractFileByPath = jest.fn().mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await vaultTools.stat('test.md', true);
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.metadata.wordCount).toBe(3); // "Actual content words."
|
||||
});
|
||||
|
||||
it('should handle read errors when computing word count', async () => {
|
||||
const mockFile = createMockTFile('test.md', {
|
||||
ctime: 1000,
|
||||
mtime: 2000,
|
||||
size: 500
|
||||
});
|
||||
|
||||
mockVault.getAbstractFileByPath = jest.fn().mockReturnValue(mockFile);
|
||||
mockVault.read = jest.fn().mockRejectedValue(new Error('Cannot read file'));
|
||||
|
||||
const result = await vaultTools.stat('test.md', true);
|
||||
|
||||
// Should still succeed but without word count
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.exists).toBe(true);
|
||||
expect(parsed.metadata.wordCount).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should not include word count for directories', async () => {
|
||||
const mockFolder = createMockTFolder('folder1', [
|
||||
createMockTFile('folder1/file1.md')
|
||||
]);
|
||||
|
||||
mockVault.getAbstractFileByPath = jest.fn().mockReturnValue(mockFolder);
|
||||
|
||||
const result = await vaultTools.stat('folder1', true);
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.kind).toBe('directory');
|
||||
expect(parsed.metadata.wordCount).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('exists', () => {
|
||||
@@ -486,6 +577,112 @@ describe('VaultTools', () => {
|
||||
expect(parsed.items.length).toBe(1);
|
||||
expect(parsed.items[0].frontmatterSummary).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should include word count when includeWordCount is true', async () => {
|
||||
const mockFile1 = createMockTFile('file1.md');
|
||||
const mockFile2 = createMockTFile('file2.md');
|
||||
const mockRoot = createMockTFolder('', [mockFile1, mockFile2]);
|
||||
|
||||
mockVault.getRoot = jest.fn().mockReturnValue(mockRoot);
|
||||
mockVault.read = jest.fn()
|
||||
.mockResolvedValueOnce('# File One\n\nThis has five words.')
|
||||
.mockResolvedValueOnce('# File Two\n\nThis has more than five words here.');
|
||||
|
||||
const result = await vaultTools.list({ includeWordCount: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.items.length).toBe(2);
|
||||
expect(parsed.items[0].wordCount).toBe(7); // File One This has five words
|
||||
expect(parsed.items[1].wordCount).toBe(10); // File Two This has more than five words here
|
||||
});
|
||||
|
||||
it('should not include word count when includeWordCount is false', async () => {
|
||||
const mockFile = createMockTFile('file.md');
|
||||
const mockRoot = createMockTFolder('', [mockFile]);
|
||||
|
||||
mockVault.getRoot = jest.fn().mockReturnValue(mockRoot);
|
||||
mockVault.read = jest.fn();
|
||||
|
||||
const result = await vaultTools.list({ includeWordCount: false });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.items.length).toBe(1);
|
||||
expect(parsed.items[0].wordCount).toBeUndefined();
|
||||
expect(mockVault.read).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should exclude frontmatter from word count in list', async () => {
|
||||
const mockFile = createMockTFile('file.md');
|
||||
const mockRoot = createMockTFolder('', [mockFile]);
|
||||
const content = '---\ntitle: Test\ntags: [test]\n---\n\nActual content.';
|
||||
|
||||
mockVault.getRoot = jest.fn().mockReturnValue(mockRoot);
|
||||
mockVault.read = jest.fn().mockResolvedValue(content);
|
||||
|
||||
const result = await vaultTools.list({ includeWordCount: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.items[0].wordCount).toBe(2); // "Actual content"
|
||||
});
|
||||
|
||||
it('should handle read errors gracefully when computing word count', async () => {
|
||||
const mockFile1 = createMockTFile('file1.md');
|
||||
const mockFile2 = createMockTFile('file2.md');
|
||||
const mockRoot = createMockTFolder('', [mockFile1, mockFile2]);
|
||||
|
||||
mockVault.getRoot = jest.fn().mockReturnValue(mockRoot);
|
||||
mockVault.read = jest.fn()
|
||||
.mockResolvedValueOnce('Content for file 1.')
|
||||
.mockRejectedValueOnce(new Error('Cannot read file2'));
|
||||
|
||||
const result = await vaultTools.list({ includeWordCount: true });
|
||||
|
||||
// Should still succeed but skip word count for unreadable files
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.items.length).toBe(2);
|
||||
expect(parsed.items[0].wordCount).toBe(4); // "Content for file 1"
|
||||
expect(parsed.items[1].wordCount).toBeUndefined(); // Error, skip word count
|
||||
});
|
||||
|
||||
it('should not include word count for directories', async () => {
|
||||
const mockFile = createMockTFile('file.md');
|
||||
const mockFolder = createMockTFolder('folder');
|
||||
const mockRoot = createMockTFolder('', [mockFile, mockFolder]);
|
||||
|
||||
mockVault.getRoot = jest.fn().mockReturnValue(mockRoot);
|
||||
mockVault.read = jest.fn().mockResolvedValue('Some content.');
|
||||
|
||||
const result = await vaultTools.list({ includeWordCount: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.items.length).toBe(2);
|
||||
const fileItem = parsed.items.find((item: any) => item.kind === 'file');
|
||||
const folderItem = parsed.items.find((item: any) => item.kind === 'directory');
|
||||
expect(fileItem.wordCount).toBe(2); // "Some content"
|
||||
expect(folderItem.wordCount).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should filter files and include word count', async () => {
|
||||
const mockFile = createMockTFile('file.md');
|
||||
const mockFolder = createMockTFolder('folder');
|
||||
const mockRoot = createMockTFolder('', [mockFile, mockFolder]);
|
||||
|
||||
mockVault.getRoot = jest.fn().mockReturnValue(mockRoot);
|
||||
mockVault.read = jest.fn().mockResolvedValue('File content here.');
|
||||
|
||||
const result = await vaultTools.list({ only: 'files', includeWordCount: true });
|
||||
|
||||
expect(result.isError).toBeUndefined();
|
||||
const parsed = JSON.parse(result.content[0].text);
|
||||
expect(parsed.items.length).toBe(1);
|
||||
expect(parsed.items[0].kind).toBe('file');
|
||||
expect(parsed.items[0].wordCount).toBe(3); // "File content here"
|
||||
});
|
||||
});
|
||||
|
||||
describe('getBacklinks', () => {
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
{
|
||||
"1.0.0": "0.15.0"
|
||||
"1.0.0": "0.15.0",
|
||||
"1.0.1": "0.15.0",
|
||||
"1.1.0": "0.15.0"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user