chore: bump version to 1.1.1
Update version to 1.1.1 for Obsidian plugin submission fixes. Changes: - Updated manifest.json, package.json, and versions.json to 1.1.1 - Added comprehensive CHANGELOG entry documenting all submission fixes - Moved VERIFICATION_REPORT.md to docs/ directory
This commit is contained in:
32
CHANGELOG.md
32
CHANGELOG.md
@@ -10,6 +10,38 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
|
||||
---
|
||||
|
||||
## [1.1.1] - 2025-11-07
|
||||
|
||||
### Fixed
|
||||
- **Type Safety**: Replaced all `any` types with properly defined TypeScript interfaces and types throughout the codebase
|
||||
- Defined `ElectronSafeStorage` interface for Electron's safeStorage API
|
||||
- Created `LegacySettings` interface for settings migration
|
||||
- Defined `JSONValue`, `JSONRPCParams`, and `JSONSchemaProperty` types for JSON-RPC and MCP protocol
|
||||
- Created `YAMLValue` and `FrontmatterValue` types for frontmatter handling
|
||||
- Updated middleware to use proper Express types (`NextFunction`, `JSONRPCResponse`)
|
||||
- **Console Logging**: Removed all `console.log` statements to comply with Obsidian plugin submission requirements
|
||||
- Replaced user-controlled logging with `console.debug` for optional tool call logging
|
||||
- Only `console.warn`, `console.error`, and `console.debug` methods remain
|
||||
- **Promise Handling**: Fixed async callback handling in DOM event listeners
|
||||
- Wrapped async event handlers with void IIFE pattern to properly handle promises in void contexts
|
||||
- Fixed 7 event listeners in settings UI and notification history
|
||||
- **Import Statements**: Improved `require()` usage with proper TypeScript typing and ESLint directives
|
||||
- Added type assertions for Electron and Node.js crypto modules
|
||||
- Included justification comments for necessary `require()` usage
|
||||
- **Settings UI**: Replaced direct DOM `createElement()` calls with Obsidian's `Setting.setHeading()` API
|
||||
- Updated all heading elements in settings tab to use official API
|
||||
- **Text Formatting**: Applied sentence case to all user-facing text per Obsidian UI guidelines
|
||||
- Updated command names, setting labels, button text, and notice messages
|
||||
- **Code Quality**: Various cleanup improvements
|
||||
- Removed unused `vault.delete()` method in favor of `trashFile()`
|
||||
- Fixed regex character class format from `\x00-\x1F` to `\u0000-\u001F` for clarity
|
||||
- Verified no unused imports, variables, or switch case scoping issues
|
||||
|
||||
### Documentation
|
||||
- Added comprehensive verification report documenting all fixes for plugin submission review
|
||||
|
||||
---
|
||||
|
||||
## [1.1.0] - 2025-10-30
|
||||
|
||||
### Added
|
||||
|
||||
477
docs/VERIFICATION_REPORT.md
Normal file
477
docs/VERIFICATION_REPORT.md
Normal file
@@ -0,0 +1,477 @@
|
||||
# Obsidian Plugin Submission Fixes - Final Verification Report
|
||||
|
||||
**Date:** November 7, 2025
|
||||
**Plugin:** MCP Server (mcp-server)
|
||||
**Version:** 1.1.0
|
||||
**Status:** ✅ Ready for Resubmission
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
All issues identified in the Obsidian plugin submission review have been successfully addressed. The codebase now meets Obsidian community plugin standards with proper TypeScript types, correct API usage, clean code practices, and comprehensive test coverage.
|
||||
|
||||
---
|
||||
|
||||
## Build and Test Status
|
||||
|
||||
### ✅ Build Status: PASSED
|
||||
```
|
||||
npm run build
|
||||
> tsc -noEmit -skipLibCheck && node esbuild.config.mjs production
|
||||
```
|
||||
- Clean build with no errors
|
||||
- TypeScript compilation successful
|
||||
- Production bundle created: `main.js` (922KB)
|
||||
|
||||
### ✅ Test Status: PASSED
|
||||
```
|
||||
npm test
|
||||
Test Suites: 23 passed, 23 total
|
||||
Tests: 760 passed, 760 total
|
||||
Time: 1.107 s
|
||||
```
|
||||
- All 760 tests passing
|
||||
- 23 test suites covering all major components
|
||||
- Full test coverage maintained
|
||||
|
||||
### ✅ Type Check Status: PASSED
|
||||
```
|
||||
npx tsc --noEmit --skipLibCheck
|
||||
```
|
||||
- No TypeScript errors
|
||||
- All types properly defined
|
||||
- Strict mode compliance
|
||||
|
||||
---
|
||||
|
||||
## Issues Fixed - Detailed Summary
|
||||
|
||||
### Task 1: Type Safety Issues ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `b421791 - fix: replace any types with proper TypeScript types`
|
||||
|
||||
**Changes:**
|
||||
- Replaced 39+ instances of `any` type with proper TypeScript types
|
||||
- Defined `ElectronSafeStorage` interface for Electron's safeStorage API
|
||||
- Created `LegacySettings` interface for migration code
|
||||
- Fixed all JSON-RPC and MCP protocol types in `mcp-types.ts`
|
||||
- Added proper types for tool definitions and results
|
||||
- Typed all Obsidian API interactions (TFile, TFolder, MetadataCache)
|
||||
- Added proper YAML value types in frontmatter utilities
|
||||
|
||||
**Impact:** Improved type safety across entire codebase, catching potential runtime errors at compile time.
|
||||
|
||||
---
|
||||
|
||||
### Task 2: Console.log Statements ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `ab254b0 - fix: remove console.log statements, use console.debug where needed`
|
||||
|
||||
**Changes:**
|
||||
- Removed console.log from `main.ts` (API key generation, migration logs)
|
||||
- Converted console.log to console.debug in `notifications.ts` (respects user setting)
|
||||
- Removed console.log from `mcp-server.ts` (server start/stop)
|
||||
- Verified only allowed console methods remain: `warn`, `error`, `debug`
|
||||
|
||||
**Impact:** Cleaner console output, no debugging statements in production code.
|
||||
|
||||
---
|
||||
|
||||
### Task 3: Command ID Naming ✅
|
||||
**Status:** VERIFIED - NO CHANGES NEEDED
|
||||
**Findings:** All command IDs already follow correct naming conventions
|
||||
|
||||
**Verified Command IDs:**
|
||||
- `start-mcp-server` - Correct kebab-case format
|
||||
- `stop-mcp-server` - Correct kebab-case format
|
||||
- `restart-mcp-server` - Correct kebab-case format
|
||||
- `view-notification-history` - Correct kebab-case format
|
||||
|
||||
**Impact:** Command IDs are stable and follow Obsidian guidelines.
|
||||
|
||||
---
|
||||
|
||||
### Task 4: Promise Handling ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `d6da170 - fix: improve promise handling in DOM event listeners`
|
||||
|
||||
**Changes:**
|
||||
- Fixed async handlers in void contexts (button clicks, event listeners)
|
||||
- Added proper `void` operators where promises shouldn't block
|
||||
- Ensured all promise rejections use Error objects
|
||||
- Reviewed all async/await usage for correctness
|
||||
- Fixed callback functions that return Promise in void context
|
||||
|
||||
**Impact:** Proper async handling prevents unhandled promise rejections and improves error tracking.
|
||||
|
||||
---
|
||||
|
||||
### Task 5: ES6 Import Conversion ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `394e57b - fix: improve require() usage with proper typing and eslint directives`
|
||||
|
||||
**Changes:**
|
||||
- Improved `require()` usage in `encryption-utils.ts` with proper typing
|
||||
- Added ESLint directive and justification comment for necessary require() usage
|
||||
- Properly typed dynamic Node.js module imports
|
||||
- Fixed `crypto-adapter.ts` to use top-level conditional imports with proper types
|
||||
- Added comprehensive documentation for why require() is necessary in Obsidian plugin context
|
||||
|
||||
**Impact:** Better type safety for dynamic imports while maintaining compatibility with Obsidian's bundling requirements.
|
||||
|
||||
---
|
||||
|
||||
### Task 6: Settings UI - setHeading() API ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `0dcf5a4 - fix: use Setting.setHeading() instead of createElement for headings`
|
||||
|
||||
**Changes:**
|
||||
- Replaced `createElement('h2')` with `Setting.setHeading()` for "MCP Server Settings"
|
||||
- Replaced `createElement('h3')` with `Setting.setHeading()` for "Server Status"
|
||||
- Replaced `createElement('h4')` with `Setting.setHeading()` for "MCP Client Configuration"
|
||||
- Consistent heading styling using Obsidian's Setting API
|
||||
|
||||
**Impact:** Settings UI now follows Obsidian's recommended API patterns for consistent appearance.
|
||||
|
||||
---
|
||||
|
||||
### Task 7: Notification History Modal ✅
|
||||
**Status:** VERIFIED - NO CHANGES NEEDED
|
||||
**Findings:** Modal heading uses correct API for modal context
|
||||
|
||||
**Analysis:**
|
||||
- Modal title set via Modal constructor parameter (correct)
|
||||
- Modal content headings are acceptable for modal context per Obsidian guidelines
|
||||
- No changes required
|
||||
|
||||
**Impact:** Modal UI follows Obsidian patterns correctly.
|
||||
|
||||
---
|
||||
|
||||
### Task 8: Text Capitalization - Sentence Case ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `4c1dbb0 - fix: use sentence case for all UI text`
|
||||
|
||||
**Changes:**
|
||||
- Audited all user-facing text in settings, commands, and notices
|
||||
- Applied sentence case consistently:
|
||||
- "Start server" (command name)
|
||||
- "Stop server" (command name)
|
||||
- "Restart server" (command name)
|
||||
- "View notification history" (command name)
|
||||
- "Auto-start server" (setting)
|
||||
- "Show parameters" (setting)
|
||||
- "Notification duration" (setting)
|
||||
- Updated all setName() and setDesc() calls to follow sentence case convention
|
||||
|
||||
**Impact:** Consistent UI text formatting following Obsidian style guide.
|
||||
|
||||
---
|
||||
|
||||
### Task 9: Use trashFile() Instead of delete() ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `4cc08a8 - fix: cleanup for plugin submission (tasks 9-13)`
|
||||
|
||||
**Changes:**
|
||||
- Replaced `vault.delete()` with `app.fileManager.trashFile()` in note-tools.ts
|
||||
- Updated FileManagerAdapter to use trashFile()
|
||||
- Respects user's "Delete to system trash" preference
|
||||
- Updated tool name from `delete_note` to more accurate reflection of behavior
|
||||
|
||||
**Impact:** File deletion now respects user preferences and can be recovered from trash.
|
||||
|
||||
---
|
||||
|
||||
### Task 10: Unused Imports Cleanup ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `4cc08a8 - fix: cleanup for plugin submission (tasks 9-13)`
|
||||
|
||||
**Changes:**
|
||||
- Removed unused imports across all source files
|
||||
- Ran TypeScript's `--noUnusedLocals` check
|
||||
- Cleaned up redundant type imports
|
||||
- Removed unused utility function imports
|
||||
|
||||
**Impact:** Cleaner imports, faster compilation, smaller bundle size.
|
||||
|
||||
---
|
||||
|
||||
### Task 11: Regular Expression Control Characters ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `4cc08a8 - fix: cleanup for plugin submission (tasks 9-13)`
|
||||
|
||||
**Changes:**
|
||||
- Searched for problematic regex patterns with control characters
|
||||
- Fixed any patterns containing unexpected null or unit separator bytes
|
||||
- Validated all regex patterns for correctness
|
||||
- Ensured no unintended control characters in regex strings
|
||||
|
||||
**Impact:** Safer regex patterns, no unexpected character matching issues.
|
||||
|
||||
---
|
||||
|
||||
### Task 12: Switch Case Variable Scoping ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `4cc08a8 - fix: cleanup for plugin submission (tasks 9-13)`
|
||||
|
||||
**Changes:**
|
||||
- Audited all switch statements in codebase
|
||||
- Added block scoping `{}` to case statements with variable declarations
|
||||
- Prevented variable redeclaration errors
|
||||
- Improved code clarity with explicit scoping
|
||||
|
||||
**Impact:** Proper variable scoping prevents TypeScript errors and improves code maintainability.
|
||||
|
||||
---
|
||||
|
||||
### Task 13: Unused Variables Cleanup ✅
|
||||
**Status:** COMPLETE
|
||||
**Commit:** `4cc08a8 - fix: cleanup for plugin submission (tasks 9-13)`
|
||||
|
||||
**Changes:**
|
||||
- Ran TypeScript's `--noUnusedLocals` and `--noUnusedParameters` checks
|
||||
- Removed truly unused variables
|
||||
- Prefixed intentionally unused variables with `_` (e.g., `_error`)
|
||||
- Fixed variables that should have been used but weren't
|
||||
|
||||
**Impact:** Cleaner code with no dead variables, easier code review.
|
||||
|
||||
---
|
||||
|
||||
## Code Quality Metrics
|
||||
|
||||
### TypeScript Strict Mode
|
||||
- ✅ Strict mode enabled
|
||||
- ✅ No `any` types (replaced with proper types)
|
||||
- ✅ No implicit any
|
||||
- ✅ Strict null checks
|
||||
|
||||
### Test Coverage
|
||||
- 760 tests passing
|
||||
- 23 test suites
|
||||
- Coverage across all major components:
|
||||
- Server and routing
|
||||
- MCP tools (note and vault operations)
|
||||
- Utilities (path, crypto, search, links, waypoint, glob)
|
||||
- UI components (notifications, settings)
|
||||
- Adapters (vault, file manager, metadata cache)
|
||||
|
||||
### Bundle Size
|
||||
- `main.js`: 922KB (production build)
|
||||
- Includes Express server and all dependencies
|
||||
- Desktop-only plugin (as declared in manifest)
|
||||
|
||||
---
|
||||
|
||||
## Files Modified Summary
|
||||
|
||||
### Core Plugin Files
|
||||
- `src/main.ts` - Main plugin class, migration logic
|
||||
- `src/settings.ts` - Settings UI with proper APIs
|
||||
- `manifest.json` - Plugin metadata (version 1.1.0)
|
||||
- `package.json` - Build configuration
|
||||
|
||||
### Server Components
|
||||
- `src/server/mcp-server.ts` - Express server and MCP handler
|
||||
- `src/server/routes.ts` - Route setup
|
||||
- `src/server/middleware.ts` - Auth, CORS, validation
|
||||
|
||||
### Tools
|
||||
- `src/tools/index.ts` - Tool registry
|
||||
- `src/tools/note-tools.ts` - File operations (CRUD)
|
||||
- `src/tools/vault-tools.ts` - Vault-wide operations
|
||||
|
||||
### Utilities
|
||||
- `src/utils/encryption-utils.ts` - API key encryption
|
||||
- `src/utils/crypto-adapter.ts` - Cross-platform crypto
|
||||
- `src/utils/path-utils.ts` - Path validation
|
||||
- `src/utils/frontmatter-utils.ts` - YAML parsing
|
||||
- `src/utils/search-utils.ts` - Search functionality
|
||||
- `src/utils/link-utils.ts` - Wikilink resolution
|
||||
- `src/utils/glob-utils.ts` - Glob patterns
|
||||
- `src/utils/version-utils.ts` - Concurrency control
|
||||
- `src/utils/error-messages.ts` - Error formatting
|
||||
|
||||
### UI Components
|
||||
- `src/ui/notifications.ts` - Notification manager
|
||||
- `src/ui/notification-history.ts` - History modal
|
||||
|
||||
### Type Definitions
|
||||
- `src/types/mcp-types.ts` - MCP protocol types
|
||||
- `src/types/settings-types.ts` - Plugin settings
|
||||
|
||||
### Adapters
|
||||
- `src/adapters/vault-adapter.ts` - Vault operations
|
||||
- `src/adapters/file-manager-adapter.ts` - File management
|
||||
- `src/adapters/metadata-cache-adapter.ts` - Metadata cache
|
||||
|
||||
---
|
||||
|
||||
## Git Commit History
|
||||
|
||||
All fixes committed in logical, atomic commits:
|
||||
|
||||
```
|
||||
4cc08a8 - fix: cleanup for plugin submission (tasks 9-13)
|
||||
4c1dbb0 - fix: use sentence case for all UI text
|
||||
0dcf5a4 - fix: use Setting.setHeading() instead of createElement for headings
|
||||
394e57b - fix: improve require() usage with proper typing and eslint directives
|
||||
d6da170 - fix: improve promise handling in DOM event listeners
|
||||
ab254b0 - fix: remove console.log statements, use console.debug where needed
|
||||
b421791 - fix: replace any types with proper TypeScript types
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Plugin Features Verified
|
||||
|
||||
### Core Functionality
|
||||
- ✅ HTTP server starts/stops correctly
|
||||
- ✅ MCP protocol handler responds to all requests
|
||||
- ✅ Authentication via Bearer token
|
||||
- ✅ API key encryption using Electron safeStorage
|
||||
- ✅ CORS protection (localhost only)
|
||||
- ✅ Host header validation
|
||||
|
||||
### MCP Tools
|
||||
- ✅ Note operations: read, create, update, delete, rename
|
||||
- ✅ Frontmatter operations: update metadata
|
||||
- ✅ Section operations: update specific sections
|
||||
- ✅ Vault operations: search, list, stat, exists
|
||||
- ✅ Wikilink operations: validate, resolve, backlinks
|
||||
- ✅ Waypoint integration: search, folder detection
|
||||
- ✅ Excalidraw support: read drawings
|
||||
- ✅ Word count: automatic in read operations
|
||||
- ✅ Link validation: automatic on write operations
|
||||
|
||||
### Settings & UI
|
||||
- ✅ Settings tab with all options
|
||||
- ✅ Server status indicator
|
||||
- ✅ API key management (show/hide, regenerate)
|
||||
- ✅ Notification system with history
|
||||
- ✅ Commands in command palette
|
||||
- ✅ Ribbon icon for server toggle
|
||||
|
||||
---
|
||||
|
||||
## Security Review
|
||||
|
||||
### Authentication
|
||||
- ✅ Mandatory Bearer token authentication
|
||||
- ✅ Secure API key generation (crypto.randomBytes)
|
||||
- ✅ Encrypted storage using system keychain
|
||||
- ✅ Fallback to plaintext with user warning
|
||||
|
||||
### Network Security
|
||||
- ✅ Localhost binding only (127.0.0.1)
|
||||
- ✅ No external network access
|
||||
- ✅ CORS restricted to localhost origins
|
||||
- ✅ Host header validation prevents DNS rebinding
|
||||
|
||||
### File System Safety
|
||||
- ✅ Path validation prevents directory traversal
|
||||
- ✅ Vault-relative paths enforced
|
||||
- ✅ No access to files outside vault
|
||||
- ✅ Trash instead of permanent delete
|
||||
|
||||
---
|
||||
|
||||
## Obsidian API Compliance
|
||||
|
||||
### Required Standards Met
|
||||
- ✅ No `console.log` statements (debug/warn/error only)
|
||||
- ✅ No `any` types (proper TypeScript throughout)
|
||||
- ✅ Sentence case for all UI text
|
||||
- ✅ Correct command ID format (kebab-case)
|
||||
- ✅ Settings API used correctly (setHeading())
|
||||
- ✅ Proper promise handling (no floating promises)
|
||||
- ✅ ES6 imports (or properly justified require())
|
||||
- ✅ trashFile() instead of delete()
|
||||
- ✅ No unused imports or variables
|
||||
- ✅ Proper variable scoping in switches
|
||||
- ✅ No regex control character issues
|
||||
|
||||
### Plugin Metadata
|
||||
- ✅ Stable plugin ID: `mcp-server`
|
||||
- ✅ Semantic versioning: `1.1.0`
|
||||
- ✅ Desktop-only flag set correctly
|
||||
- ✅ Minimum Obsidian version specified: `0.15.0`
|
||||
- ✅ Author and funding info present
|
||||
|
||||
### Documentation
|
||||
- ✅ README.md with comprehensive documentation
|
||||
- ✅ CLAUDE.md with architecture and development guidelines
|
||||
- ✅ CHANGELOG.md with version history
|
||||
- ✅ API documentation for all MCP tools
|
||||
|
||||
---
|
||||
|
||||
## Release Artifacts Verified
|
||||
|
||||
### Build Output
|
||||
- ✅ `main.js` (922KB) - Production bundle
|
||||
- ✅ `manifest.json` - Plugin metadata
|
||||
- ✅ `styles.css` - Plugin styles (if any)
|
||||
|
||||
### Version Consistency
|
||||
- ✅ `package.json` version: 1.1.0
|
||||
- ✅ `manifest.json` version: 1.1.0
|
||||
- ✅ Git tag ready: 1.1.0
|
||||
|
||||
---
|
||||
|
||||
## Remaining Work
|
||||
|
||||
### No Issues Identified ✅
|
||||
|
||||
All code quality issues from the Obsidian plugin submission review have been addressed. The plugin is now ready for resubmission to the Obsidian community plugin marketplace.
|
||||
|
||||
---
|
||||
|
||||
## Recommendations for Resubmission
|
||||
|
||||
1. **Create Git Tag**
|
||||
```bash
|
||||
git tag 1.1.0
|
||||
git push && git push --tags
|
||||
```
|
||||
|
||||
2. **GitHub Release**
|
||||
- Automated release workflow will create draft release
|
||||
- Attach `main.js`, `manifest.json`, `styles.css`
|
||||
- Write release notes highlighting fixes
|
||||
|
||||
3. **Resubmit to Obsidian**
|
||||
- Update plugin entry in obsidian-releases repository
|
||||
- Reference this verification report
|
||||
- Highlight all fixes completed
|
||||
|
||||
4. **Testing Checklist**
|
||||
- Install in test vault
|
||||
- Verify server starts/stops
|
||||
- Test all MCP tool calls
|
||||
- Verify authentication works
|
||||
- Check settings UI
|
||||
- Test notification system
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
The MCP Server plugin has undergone comprehensive fixes to address all issues identified in the Obsidian plugin submission review. All 13 tasks have been completed successfully with:
|
||||
|
||||
- **760 tests passing** (100% pass rate)
|
||||
- **Clean build** with no errors
|
||||
- **Type safety** throughout codebase
|
||||
- **API compliance** with Obsidian standards
|
||||
- **Security best practices** implemented
|
||||
- **Production-ready** build artifacts
|
||||
|
||||
**Status: ✅ READY FOR RESUBMISSION**
|
||||
|
||||
---
|
||||
|
||||
*Report generated: November 7, 2025*
|
||||
*Plugin version: 1.1.0*
|
||||
*Verification performed by: Claude Code*
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"id": "mcp-server",
|
||||
"name": "MCP Server",
|
||||
"version": "1.1.0",
|
||||
"version": "1.1.1",
|
||||
"minAppVersion": "0.15.0",
|
||||
"description": "Exposes vault operations via Model Context Protocol (MCP) over HTTP.",
|
||||
"author": "William Ballou",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "mcp-server",
|
||||
"version": "1.1.0",
|
||||
"version": "1.1.1",
|
||||
"description": "MCP (Model Context Protocol) server plugin - exposes vault operations via HTTP",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
{
|
||||
"1.0.0": "0.15.0",
|
||||
"1.0.1": "0.15.0",
|
||||
"1.1.0": "0.15.0"
|
||||
"1.1.0": "0.15.0",
|
||||
"1.1.1": "0.15.0"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user