Merge branch 'obsidian-nvim:main' into main

Author: andrewinci

.github/CONTRIBUTING.md

@@ -3,7 +3,7 @@ name: Docs
 on:
   pull_request:
     branches:
-      - '*'
+      - "*"
   push:
     branches: [main]
   workflow_dispatch:
@@ -14,8 +14,6 @@ concurrency:
 
 env:
   runtime: ~/.local/share/nvim/site/pack/vendor/start
-  minidoc-git: https://github.com/echasnovski/mini.doc
-  minidoc-path: ~/.local/share/nvim/site/pack/vendor/start/mini.doc
   nvim_url: https://github.com/neovim/neovim/releases/download/nightly/nvim-linux-x86_64.tar.gz
 
 jobs:
@@ -38,7 +36,6 @@ jobs:
           mkdir -p ${{ env.runtime }}
           mkdir -p _neovim
           curl -sL ${{ env.nvim_url }} | tar xzf - --strip-components=1 -C "${PWD}/_neovim"
-          git clone --depth 1 ${{ env.minidoc-git }} ${{ env.minidoc-path }}
           ln -s $(pwd) ${{ env.runtime }}
 
       - name: Generate API docs
@@ -74,5 +71,5 @@ jobs:
         if: github.event_name != 'pull_request'
         with:
           commit_user_name: github-actions[bot]
-          commit_message: 'chore(docs): auto generate docs'
+          commit_message: "chore(docs): auto generate docs"
           branch: ${{ github.head_ref }}

.github/workflows/docs.yml

@@ -3,21 +3,43 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) with respect to the public API, which currently includes the installation steps, dependencies, configuration, keymappings, commands, and other plugin functionality. At the moment this does *not* include the Lua `Client` API, although in the future it will once that API stabilizes.
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) with respect to the public API, which currently includes the installation steps, dependencies, configuration, keymappings, commands, and other plugin functionality. At the moment this does _not_ include the Lua `Client` API, although in the future it will once that API stabilizes.
 
 ## Unreleased
 
 ### Added
 
+- Added default `image_name_func` similar to Obsidian's.
+- Added support `text/uri-list` to `ObsidianPasteImg`.
+
+### Changed
+
+- `ObsidianToggleCheckbox` now works in visual mode for multiline toggle
+- `ObsidianRename` input field is pre-filled filled with the current note id to ease renaming
+- Improved type annotations for user commands: add `CommandArgs` type.
+
+### Fixed
+
+- Enhanced completion menu to correctly display and handle non-English (ex. Korean) file names and tags in link, fixing Unicode encoding issues
+
+## [v3.10.0](https://github.com/obsidian-nvim/obsidian.nvim/releases/tag/v3.10.0) - 2025-04-12
+
+### Added
+
 - Added `opts.follow_img_func` option for customizing how to handle image paths.
 - Added better handling for undefined template fields, which will now be prompted for.
 - Added support for the [`snacks.picker`](https://github.com/folke/snacks.nvim/blob/main/docs/picker.md) picker
 - Added support for the [`blink.cmp`](https://github.com/Saghen/blink.cmp) completion plugin.
+- Added health check module
+- Added a minimal sandbox script `minimal.lua`
 
 ### Changed
 
 - Renamed `opts.image_name_func` to `opts.attachments.img_name_func`.
 - Default to not activate ui render when `render-markdown.nvim` or `markview.nvim` is present
+- `smart_action` shows picker for tags (`ObsidianTag`) when cursor is on a tag
+- `ObsidianToggleCheckbox` now works with numbered lists
+- `Makefile` is friendlier: self-documenting and automatically gets dependencies
 
 ### Fixed
 
@@ -196,11 +218,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 There's a lot of new features and improvements here that I'm really excited about 🥳 They've improved my workflow a ton and I hope they do for you too. To highlight the 3 biggest additions:
 
 1. 🔗 Full support for header anchor links and block links! That means both for following links and completion of links. Various forms of anchor/block links are support. Here are a few examples:
-    - Typical Obsidian-style wiki links, e.g. `[[My note#Heading 1]]`, `[[My note#Heading 1#Sub heading]]`, `[[My note#^block-123]]`.
-    - Wiki links with a label, e.g. `[[my-note#heading-1|Heading 1 in My Note]]`.
-    - Markdown links, e.g. `[Heading 1 in My Note](my-note.md#heading-1)`.
 
-    We also support links to headers within the same note, like for a table of contents, e.g. `[[#Heading 1]]`, `[[#heading-1|Heading]]`, `[[#^block-1]]`.
+   - Typical Obsidian-style wiki links, e.g. `[[My note#Heading 1]]`, `[[My note#Heading 1#Sub heading]]`, `[[My note#^block-123]]`.
+   - Wiki links with a label, e.g. `[[my-note#heading-1|Heading 1 in My Note]]`.
+   - Markdown links, e.g. `[Heading 1 in My Note](my-note.md#heading-1)`.
+
+   We also support links to headers within the same note, like for a table of contents, e.g. `[[#Heading 1]]`, `[[#heading-1|Heading]]`, `[[#^block-1]]`.
 
 2. 📲 A basic callback system to let you easily customize obisidian.nvim's behavior even more. There are currently 4 events: `post_setup`, `enter_note`, `pre_write_note`, and `post_set_workspace`. You can define a function for each of these in your config.
 3. 🔭 Improved picker integrations (especially for telescope), particular for the `:ObsidianTags` command. See <https://github.com/epwalsh/obsidian.nvim/discussions/450> for a demo.
@@ -211,44 +234,44 @@ Full changelog below 👇
 
 - Added a configurable callback system to further customize obsidian.nvim's behavior. Callbacks are defined through the `callbacks` field in the config:
 
-    ```lua
-    callbacks = {
-      -- Runs at the end of `require("obsidian").setup()`.
-      ---@param client obsidian.Client
-      post_setup = function(client) end,
-
-      -- Runs anytime you enter the buffer for a note.
-      ---@param client obsidian.Client
-      ---@param note obsidian.Note
-      enter_note = function(client, note) end,
-
-      -- Runs anytime you leave the buffer for a note.
-      ---@param client obsidian.Client
-      ---@param note obsidian.Note
-      leave_note = function(client, note) end,
-
-      -- Runs right before writing the buffer for a note.
-      ---@param client obsidian.Client
-      ---@param note obsidian.Note
-      pre_write_note = function(client, note) end,
-
-      -- Runs anytime the workspace is set/changed.
-      ---@param client obsidian.Client
-      ---@param workspace obsidian.Workspace
-      post_set_workspace = function(client, workspace) end,
-    }
-    ```
+  ```lua
+  callbacks = {
+    -- Runs at the end of `require("obsidian").setup()`.
+    ---@param client obsidian.Client
+    post_setup = function(client) end,
+
+    -- Runs anytime you enter the buffer for a note.
+    ---@param client obsidian.Client
+    ---@param note obsidian.Note
+    enter_note = function(client, note) end,
+
+    -- Runs anytime you leave the buffer for a note.
+    ---@param client obsidian.Client
+    ---@param note obsidian.Note
+    leave_note = function(client, note) end,
+
+    -- Runs right before writing the buffer for a note.
+    ---@param client obsidian.Client
+    ---@param note obsidian.Note
+    pre_write_note = function(client, note) end,
+
+    -- Runs anytime the workspace is set/changed.
+    ---@param client obsidian.Client
+    ---@param workspace obsidian.Workspace
+    post_set_workspace = function(client, workspace) end,
+  }
+  ```
 
 - Added configuration option `note_path_func(spec): obsidian.Path` for customizing how file names for new notes are generated. This takes a single argument, a table that looks like `{ id: string, dir: obsidian.Path, title: string|? }`, and returns an `obsidian.Path` object. The default behavior is equivalent to this:
 
-    ```lua
-    ---@param spec { id: string, dir: obsidian.Path, title: string|? }
-    ---@return string|obsidian.Path The full path to the new note.
-    note_path_func = function(spec)
-      local path = spec.dir / tostring(spec.id)
-      return path:with_suffix(".md")
-    end
-    ```
+  ```lua
+  ---@param spec { id: string, dir: obsidian.Path, title: string|? }
+  ---@return string|obsidian.Path The full path to the new note.
+  note_path_func = function(spec)
+    local path = spec.dir / tostring(spec.id)
+    return path:with_suffix ".md"
+  end
+  ```
 
 - Added config option `picker.tag_mappings`, analogous to `picker.note_mappings`.
 - Added `log` field to `obsidian.Client` for easier access to the logger.
@@ -498,7 +521,7 @@ Minor internal improvements.
 
 ### Added
 
-- Added extmarks that conceal "-", "*", or "+" with "•" by default. This can turned off by setting `.ui.bullets` to `nil` in your config.
+- Added extmarks that conceal "-", "\*", or "+" with "•" by default. This can turned off by setting `.ui.bullets` to `nil` in your config.
 
 ### Fixed
 
@@ -554,26 +577,26 @@ Minor internal improvements.
 - Added Lua API methods `Client:set_workspace(workspace: obsidian.Workspace)` and `Client:switch_workspace(workspace: string|obsidian.Workspace)`.
 - Added the ability to override settings per workspace by providing the `overrides` field in a workspace definition. For example:
 
-    ```lua
-    require("obsidian").setup({
-      workspaces = {
-        {
-          name = "personal",
-          path = "~/vaults/personal",
-        },
-        {
-          name = "work",
-          path = "~/vaults/work",
-          -- Optional, override certain settings.
-          overrides = {
-            notes_subdir = "notes",
-          },
+  ```lua
+  require("obsidian").setup {
+    workspaces = {
+      {
+        name = "personal",
+        path = "~/vaults/personal",
+      },
+      {
+        name = "work",
+        path = "~/vaults/work",
+        -- Optional, override certain settings.
+        overrides = {
+          notes_subdir = "notes",
         },
       },
+    },
 
-      -- ... other options ...
-    })
-    ```
+    -- ... other options ...
+  }
+  ```
 
 ### Fixed
 
@@ -905,7 +928,7 @@ Major internal refactoring to bring performance improvements through async execu
 ### Added
 
 - Added support for [fzf-lua](https://github.com/ibhagwan/fzf-lua) as one of the possible fallbacks for the `:ObsidianQuickSwitch` command.
-- Added `:ObsidianQuickSwitch` to fuzzy-find a note by name in telescope/fzf *a la* <C-O> in Obsidian.
+- Added `:ObsidianQuickSwitch` to fuzzy-find a note by name in telescope/fzf _a la_ <C-O> in Obsidian.
 - Added support for [fzf-lua](https://github.com/ibhagwan/fzf-lua) as one of the possible fallbacks for the `:ObsidianSearch` command.
 - Added `:ObsidianFollowLink` and companion function `util.cursor_on_markdown_link`
 - Added `:ObsidianLink` and `:ObsidianLinkNew` commands.

CHANGELOG.md

@@ -0,0 +1,91 @@
+# Contributing to `obsidian.nvim`
+
+Thanks for considering contributing!
+Please read this document to learn the various steps you should take before submitting a pull request.
+
+## TL;DR
+
+- Start an issue to discuss the planned changes
+- To submit a pull request
+  - Start developing your feature in a branch
+  - Make sure that your codes complies the `obsidian.nvim` code style, run
+    `make chores`
+  - The PR should contain
+    - The code changes
+    - Tests for the code changes
+    - Documentation for the code changes (in the code itself and in the `README.md`)
+    - `CHANGELOG.md` entry for the code changes
+
+## Details
+
+Note: we automate tedious tasks using a `Makefile` in the root of the repository.
+Just call `make` to see what you can do, or `make chores` to run the most important tasks on your code.
+You can override some parts of the `Makefile` by setting env variables.
+
+### Local development with LuaLS and `plenary.nvim`
+
+If you're using the [Lua Language Server](https://luals.github.io) (LuaLS) you'll probably want to add `plenary.nvim` as a workspace library since we rely heavily on plenary throughout the codebase.
+You can do this by adding a `.luarc.json` configuration file that looks like this:
+
+```json
+{
+  "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
+  "workspace.library": ["~/.local/share/nvim/lazy/plenary.nvim/"],
+  "runtime.version": "Lua 5.1"
+}
+```
+
+Make sure that the path there to plenary is correct for you.
+
+### Keeping the `CHANGELOG.md` up-to-date
+
+This project tries hard to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and we maintain a [`CHANGELOG`](https://github.com/obsidian-nvim/obsidian.nvim/blob/main/CHANGELOG.md)
+with a format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+If your PR addresses a bug or makes any other substantial change,
+please be sure to add an entry under the "Unreleased" section at the top of `CHANGELOG.md`.
+Entries should always be in the form of a list item under a level-3 header of either "Added", "Fixed", "Changed", or "Removed" for the most part.
+If the corresponding level-3 header for your item does not already exist in the "Unreleased" section, you should add it.
+
+### Formatting code
+
+TL;DR: `make style`
+
+Lua code should be formatted using [StyLua](https://github.com/JohnnyMorganz/StyLua).
+Once you have StyLua installed, you can run `make style` to automatically apply styling to all of the Lua files in this repo.
+
+### Linting code
+
+TL;DR: `make lint`
+
+We use [luacheck](https://github.com/mpeterv/luacheck) to lint the Lua code.
+Once you have `luacheck` installed, you can run `make lint` to get a report.
+
+### Running tests
+
+TL;DR: `make test`
+
+Tests are written in the `test/` folder and are run using the [Plenary](https://github.com/nvim-lua/plenary.nvim) test harness.
+Since Plenary is a dependency of `obsidian.nvim`, you probably already have it installed somewhere.
+To run the tests locally you'll need to know where it's installed, which depends on your plugin manager.
+In my case I use `Lazy.nvim` which puts Plenary at `~/.local/share/nvim/lazy/plenary.nvim/`.
+
+### Building the vim user documentation
+
+TL;DR: `make user-docs`
+
+The Vim documentation lives at `doc/obsidian.txt`, which is automatically generated from the `README.md` using [panvimdoc](https://github.com/kdheepak/panvimdoc).
+**Please only commit documentation changes to the `README.md`, not `doc/obsidian.txt`.**
+
+However you can test how changes to the README will affect the Vim doc by running `panvimdoc` locally.
+To do this you'll need install `pandoc` (e.g. `brew install pandoc` on Mac)
+and clone [panvimdoc](https://github.com/kdheepak/panvimdoc) (e.g. `git clone [email protected]:kdheepak/panvimdoc.git ../panvimdoc`).
+
+This will build the Vim documentation to `/tmp/obsidian.txt`.
+
+### Building the vim API documentation
+
+TL;DR: `make api-docs`
+
+The API docs lives in `doc/obsidian_api.txt` and is generated from the source code using [`mini.docs`](https://github.com/echasnovski/mini.doc).
+It is automatically generated via CI.