Merge branch 'main' into dependabot/github_actions/github/codeql-action-4

Author: philoserf

.claude.md

@@ -0,0 +1,42 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+- **Build for production**: `bun build.mjs production`
+- **Development build with watch**: `bun dev` (builds to test-vault/.obsidian/plugins/ for testing)
+- **Format code**: `bun format`
+- **Lint code**: `bun lint`
+- **Build**: `bun build`
+
+Always run format, lint, and build commands after making changes.
+
+## Architecture Overview
+
+This is an Obsidian plugin that tracks file modifications and maintains a chronological changelog. The architecture consists of:
+
+### Core Components
+
+- **ChangelogPlugin** (`src/main.ts`): Main plugin class handling file system events, debounced change detection, and changelog generation
+- **ChangelogSettingsTab** (`src/settings.ts`): Settings UI with path autocompletion and folder exclusion management
+- **PathSuggest** (`src/suggest.ts`): File/folder path autocompletion component
+
+### Key Plugin Behaviors
+
+- Uses debounced file system event listeners (modify, delete, rename) to trigger changelog updates
+- Generates markdown-formatted entries with timestamps using Moment.js
+- Filters files by exclusion rules and limits results to configurable maximum
+- Completely overwrites the changelog file on each update
+- Supports both manual commands and automatic updates
+
+### Development Setup
+
+- Built with Bun as the build tool and package manager
+- Uses custom `build.mjs` script that handles both production and development builds
+- Development builds copy files to `test-vault/.obsidian/plugins/` for local testing
+- TypeScript with strict mode enabled and modern ESNext target
+
+### Testing Environment
+
+The `test-vault/` directory serves as a local Obsidian vault for plugin development and testing.

CHANGELOG.md

@@ -2,24 +2,33 @@
 
 ## Unreleased
 
+## 1.2.0
+
 ### Added
 
 - Test vault for easier development and testing
 - Hot-reload plugin to test vault for seamless development
+- "Use wiki-links" setting to optionally disable wiki-link formatting (addresses #9)
+- "Changelog heading" setting to optionally prepend a heading to the changelog (addresses #4)
 
 ### Changed
 
 - Moved styles to external CSS file
 - Restructured documentation into separate files following GitHub standards
+- Improved README with use cases, intent description, and alternatives section (addresses #46)
 
 ### Maintenance
 
 - Improved internal documentation
 - Added Dependabot configuration for GitHub Actions
-- Updated development dependencies:
-  - TypeScript from 5.7.3 to 5.8.2
-  - TypeScript ESLint parser from 8.25.0 to 8.26.0
-  - TypeScript ESLint plugin to 8.26.0
+- Updated all development dependencies to latest versions:
+  - TypeScript 5.7.3 → 5.9.3
+  - TypeScript ESLint parser 8.25.0 → 8.46.0
+  - TypeScript ESLint plugin 8.25.0 → 8.46.0
+  - ESLint 9.22.0 → 9.37.0
+  - Prettier 3.5.3 → 3.6.2
+  - eslint-config-prettier 10.1.1 → 10.1.8
+  - Obsidian API 1.8.7 → 1.10.0
 
 ## 1.1.0
 

README.md

@@ -2,11 +2,29 @@
 
 A plugin to maintain a change log of recently edited files in your Obsidian vault. Updates can be triggered manually or automatically.
 
+## Why Use This Plugin?
+
+**Vault Changelog** is ideal if you want:
+- **A persistent, text-based record** of recently edited files that survives vault moves and syncing
+- **Simple configuration** with a single command to update your changelog
+- **Minimal overhead** without needing to learn query syntax or manage complex workflows
+- **Embeddable output** that can be referenced from other notes (e.g., a dashboard or index)
+- **Clean graph view option** by disabling wiki-links to avoid cluttering your graph
+
+### Use Cases
+
+- **Personal knowledge base**: Track your daily writing and review what you've been working on
+- **Team collaboration**: Share a changelog of recent edits with collaborators
+- **Obsidian Publish**: Display a nicely formatted list of recent updates on your published site
+- **Daily/weekly reviews**: Embed the changelog in periodic notes to reflect on your work
+- **Project tracking**: Monitor activity in specific folders (using excluded folders feature)
+
 ## Features
 
 - Tracks recently edited notes in a centralized changelog.
 - Supports both manual and automatic updates.
 - Customizable file paths, timestamps, and entry limits.
+- Optional wiki-links and heading configuration.
 
 ## Important
 
@@ -36,19 +54,66 @@ On behalf of the Obsidian community, we extend our gratitude to Badr for this va
 
 ## Example Output
 
+With wiki-links enabled (default):
 ```markdown
 - 2024-01-28T14:30 · [[Note Title]]
 - 2024-01-28T14:25 · [[Another Note]]
 ```
 
+With wiki-links disabled:
+```markdown
+- 2024-01-28T14:30 · Note Title
+- 2024-01-28T14:25 · Another Note
+```
+
+With a heading configured:
+```markdown
+# Changelog
+
+- 2024-01-28T14:30 · [[Note Title]]
+- 2024-01-28T14:25 · [[Another Note]]
+```
+
 ## Settings
 
 - **Auto update**: Enable automatic updates (`false` by default).
 - **Changelog path**: File location for the changelog (`Changelog.md` by default).
 - **Datetime format**: Moment.js format string (`YYYY-MM-DD[T]HHmm` by default).
 - **Max recent files**: Number of tracked files (`25` by default).
+- **Use wiki-links**: Format filenames as wiki-links `[[note]]` instead of plain text (`true` by default).
+- **Changelog heading**: Optional heading to prepend to the changelog (empty by default). Example: `# Changelog`
 - **Excluded folders**: Folders to exclude from the changelog (empty by default).
 
+## Alternatives
+
+While **Vault Changelog** provides a simple, persistent changelog, you might prefer alternatives depending on your needs:
+
+### Other Plugins
+
+- **[List Modified](https://github.com/franciskafieh/obsidian-list-modified)**: A more advanced changelog plugin that links modified files to daily, weekly, or monthly notes. Best for users who want changelog entries integrated into periodic notes rather than a single standalone file.
+
+- **[Recent Files](https://github.com/tgrosinger/recent-files-obsidian)**: Adds a sidebar pane showing recently opened (not edited) files. Great for quick navigation but doesn't create a persistent text record.
+
+- **[Obsidian Git](https://github.com/denolehov/obsidian-git)**: For detailed version control and change history. Overkill if you only need a simple list of recently edited files, but essential for tracking actual content changes and collaboration.
+
+### Dataview Alternative
+
+If you already use the **[Dataview](https://github.com/blacksmithgu/obsidian-dataview)** plugin, you can achieve similar results with a query:
+
+````markdown
+```dataview
+TABLE dateformat(file.mtime, "yyyy-MM-dd HH:mm") AS "Last Modified"
+FROM ""
+SORT file.mtime DESC
+LIMIT 25
+```
+````
+
+**Dataview pros**: Dynamic queries, no plugin needed if you already use Dataview, can filter by folders/tags
+**Dataview cons**: Requires learning query syntax, queries don't work in all contexts (e.g., mobile widgets, some themes)
+
+**Vault Changelog pros**: Simple one-command update, works everywhere (embeds, Obsidian Publish, mobile), persistent text output, no query syntax needed
+
 ## Documentation
 
 - [Changelog](CHANGELOG.md)