summaryrefslogtreecommitdiff
path: root/mac/.config/TheSiahxyz/lua/TheSiahxyz/plugins/obsidian.lua
blob: c5f3a59c0f8315bf98108fee3abede13b006dc9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
return {
	"epwalsh/obsidian.nvim",
	version = "*", -- recommended, use latest release instead of latest commit
	lazy = true,
	ft = "markdown",
	-- Replace the above line with this if you only want to load obsidian.nvim for markdown files in your vault:
	-- event = {
	--   -- If you want to use the home shortcut '~' here you need to call 'vim.fn.expand'.
	--   -- E.g. "BufReadPre " .. vim.fn.expand "~" .. "/my-vault/*.md"
	--   -- refer to `:h file-pattern` for more examples
	--   "BufReadPre path/to/my-vault/*.md",
	--   "BufNewFile path/to/my-vault/*.md",
	-- },
	dependencies = {
		-- Required.
		"nvim-lua/plenary.nvim",
		-- see below for full list of optional dependencies 👇
		"hrsh7th/nvim-cmp",
		"nvim-telescope/telescope.nvim",
		"nvim-treesitter/nvim-treesitter",
		{
			"epwalsh/pomo.nvim",
			dependencies = "nvim-lualine/lualine.nvim",
			config = function()
				require("lualine").setup({
					sections = {
						lualine_x = {
							function()
								local ok, pomo = pcall(require, "pomo")
								if not ok then
									return ""
								end

								local timer = pomo.get_first_to_finish()
								if timer == nil then
									return ""
								end

								return "󰄉 " .. tostring(timer)
							end,
							"encoding",
							"fileformat",
							"filetype",
						},
					},
				})

				require("telescope").load_extension("pomodori")

				vim.keymap.set("n", "<leader>mp", function()
					require("telescope").extensions.pomodori.timers()
				end, { desc = "Manage pomodori" })
			end,
		},
	},
	cmd = {
		"ObsidianOpen",
		"ObsidianNew",
		"ObsidianQuickSwitch",
		"ObsidianFollowLink",
		"ObsidianBacklinks",
		"ObsidianTags",
		"ObsidianToday",
		"ObsidianYesterday",
		"ObsidianTomorrow",
		"ObsidianDailies",
		"ObsidianTemplate",
		"ObsidianSearch",
		"ObsidianLink",
		"ObsidianLinkNew",
		"ObsidianExtractNote",
		"ObsidianWorkspace",
		"ObsidianPasteImg",
		"ObsidianRename",
		"ObsidianToggleCheckbox",
		"ObsidianNewFromTemplate",
		"ObsidianTOC",
	},
	init = function()
		local wk = require("which-key")
		wk.add({
			mode = { "n", "v", "x" },
			{ "<leader>o", group = "Open/Obsidian" },
			{ "<leader>of", group = "Find files (Obsidian)" },
			{ "<leader>on", group = "Notes (Obsidian)" },
			{ "<leader>op", group = "Paste (Obsidian)" },
			{ "<leader>ot", group = "Templates (Obsidian)" },
		})
	end,
	config = function()
		require("obsidian").setup({
			-- A list of workspace names, paths, and configuration overrides.
			-- If you use the Obsidian app, the 'path' of a workspace should generally be
			-- your vault root (where the `.obsidian` folder is located).
			-- When obsidian.nvim is loaded by your plugin manager, it will automatically set
			-- the workspace to the first workspace in the list whose `path` is a parent of the
			-- current markdown file being edited.
			workspaces = {
				{
					name = "personal",
					path = "~/Private/repos/Obsidian/SI",
					-- Optional, override certain settings.
					overrides = {
						notes_subdir = "",
					},
				},
			},

			-- Alternatively - and for backwards compatibility - you can set 'dir' to a single path instead of
			-- 'workspaces'. For example:
			-- dir = "~/vaults/work",

			-- Optional, if you keep notes in a specific subdirectory of your vault.
			notes_subdir = "",

			-- Optional, set the log level for obsidian.nvim. This is an integer corresponding to one of the log
			-- levels defined by "vim.log.levels.*".
			log_level = vim.log.levels.INFO,

			daily_notes = {
				-- Optional, if you keep daily notes in a separate directory.
				folder = "Area/Notes",
				-- Optional, if you want to change the date format for the ID of daily notes.
				date_format = "%Y-%m-%d",
				-- Optional, if you want to change the date format of the default alias of daily notes.
				alias_format = "%B %-d, %Y",
				-- Optional, default tags to add to each new daily note created.
				default_tags = { "daily-notes" },
				-- Optional, if you want to automatically insert a template from your template directory like 'daily.md'
				template = nil,
			},

			-- Optional, completion of wiki links, local markdown links, and tags using nvim-cmp.
			completion = {
				-- Set to false to disable completion.
				nvim_cmp = true,
				-- Trigger completion at 2 chars.
				min_chars = 2,
			},

			-- Optional, configure key mappings. These are the defaults. If you don't want to set any keymappings this
			-- way then set 'mappings = {}'.
			mappings = {
				-- Smart action depending on context, either follow link or toggle checkbox.
				["<cr>"] = {
					action = function()
						return require("obsidian").util.smart_action()
					end,
					opts = { buffer = true, expr = true },
				},
			},

			-- Where to put new notes. Valid options are
			--  * "current_dir" - put new notes in same directory as the current buffer.
			--  * "notes_subdir" - put new notes in the default notes subdirectory.
			new_notes_location = "current_dir",

			-- Optional, customize how note IDs are generated given an optional title.
			---@param title string|?
			---@return string
			note_id_func = function(title)
				-- Create note IDs in a Zettelkasten format with a timestamp and a suffix.
				-- In this case a note with the title 'My new note' will be given an ID that looks
				-- like '1657296016-my-new-note', and therefore the file name '1657296016-my-new-note.md'
				local suffix = ""
				if title ~= nil then
					-- If title is given, transform it into valid file name.
					suffix = title:gsub(" ", "-"):gsub("[^A-Za-z0-9-]", ""):lower()
				else
					-- If title is nil, just add 4 random uppercase letters to the suffix.
					for _ = 1, 4 do
						suffix = suffix .. string.char(math.random(65, 90))
					end
				end
				return suffix
			end,

			-- Optional, customize how note file names are generated given the ID, target directory, and title.
			---@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)
				-- This is equivalent to the default behavior.
				local path = spec.dir / "Contents" / tostring(spec.title)
				return path:with_suffix(".md")
			end,

			-- Optional, customize how wiki links are formatted. You can set this to one of:
			--  * "use_alias_only", e.g. '[[Foo Bar]]'
			--  * "prepend_note_id", e.g. '[[foo-bar|Foo Bar]]'
			--  * "prepend_note_path", e.g. '[[foo-bar.md|Foo Bar]]'
			--  * "use_path_only", e.g. '[[foo-bar.md]]'
			-- Or you can set it to a function that takes a table of options and returns a string, like this:
			wiki_link_func = function(opts)
				return require("obsidian.util").wiki_link_path_prefix(opts)
			end,

			-- Optional, customize how markdown links are formatted.
			markdown_link_func = function(opts)
				return require("obsidian.util").markdown_link(opts)
			end,

			-- Either 'wiki' or 'markdown'.
			preferred_link_style = "wiki",

			-- Optional, boolean or a function that takes a filename and returns a boolean.
			-- `true` indicates that you don't want obsidian.nvim to manage frontmatter.
			disable_frontmatter = false,

			-- -- Optional, alternatively you can customize the frontmatter data.
			-- ---@return table
			-- note_frontmatter_func = function(note)
			-- 	-- Add the title of the note as an alias.
			-- 	if note.title then
			-- 		note:add_alias(note.title)
			-- 	end
			--
			-- 	local out = { id = note.id, aliases = note.aliases, tags = note.tags }
			--
			-- 	-- `note.metadata` contains any manually added fields in the frontmatter.
			-- 	-- So here we just make sure those fields are kept in the frontmatter.
			-- 	if note.metadata ~= nil and not vim.tbl_isempty(note.metadata) then
			-- 		for k, v in pairs(note.metadata) do
			-- 			out[k] = v
			-- 		end
			-- 	end
			--
			-- 	return out
			-- end,

			-- Optional, for templates (see below).
			templates = {
				folder = "Resource/Templates",
				date_format = "%Y-%m-%d",
				time_format = "%H:%M",
				-- A map for custom variables, the key should be the variable and the value a function
				substitutions = {},
			},

			-- Optional, by default when you use `:ObsidianFollowLink` on a link to an external
			-- URL it will be ignored but you can customize this behavior here.
			---@param url string
			follow_url_func = function(url)
				-- Open the URL in the default web browser.
				-- vim.fn.jobstart({ "open", url }) -- Mac OS
				vim.fn.jobstart({ "xdg-open", url }) -- linux
				-- vim.cmd(':silent exec "!start ' .. url .. '"') -- Windows
				-- vim.ui.open(url) -- need Neovim 0.10.0+
			end,

			-- Optional, by default when you use `:ObsidianFollowLink` on a link to an image
			-- file it will be ignored but you can customize this behavior here.
			---@param img string
			follow_img_func = function(img)
				-- vim.fn.jobstart({ "qlmanage", "-p", img }) -- Mac OS quick look preview
				vim.fn.jobstart({ "nsxiv", "-aiop", img }) -- linux
				-- vim.cmd(':silent exec "!start ' .. url .. '"') -- Windows
			end,

			-- Optional, set to true if you use the Obsidian Advanced URI plugin.
			-- https://github.com/Vinzent03/obsidian-advanced-uri
			use_advanced_uri = false,

			-- Optional, set to true to force ':ObsidianOpen' to bring the app to the foreground.
			open_app_foreground = false,

			picker = {
				-- Set your preferred picker. Can be one of 'telescope.nvim', 'fzf-lua', or 'mini.pick'.
				name = "telescope.nvim",
				-- Optional, configure key mappings for the picker. These are the defaults.
				-- Not all pickers support all mappings.
				note_mappings = {
					-- Create a new note from your query.
					new = "<C-x>",
					-- Insert a link to the selected note.
					insert_link = "<C-l>",
				},
				tag_mappings = {
					-- Add tag(s) to current note.
					tag_note = "<C-x>",
					-- Insert a tag at the current location.
					insert_tag = "<C-l>",
				},
			},

			-- Optional, sort search results by "path", "modified", "accessed", or "created".
			-- The recommend value is "modified" and `true` for `sort_reversed`, which means, for example,
			-- that `:ObsidianQuickSwitch` will show the notes sorted by latest modified time
			sort_by = "modified",
			sort_reversed = true,

			-- Set the maximum number of lines to read from notes on disk when performing certain searches.
			search_max_lines = 1000,

			-- Optional, determines how certain commands open notes. The valid options are:
			-- 1. "current" (the default) - to always open in the current window
			-- 2. "vsplit" - to open in a vertical split if there's not already a vertical split
			-- 3. "hsplit" - to open in a horizontal split if there's not already a horizontal split
			open_notes_in = "current",

			-- Optional, define your own callbacks to further customize behavior.
			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,
			},

			-- Optional, configure additional syntax highlighting / extmarks.
			-- This requires you have `conceallevel` set to 1 or 2. See `:help conceallevel` for more details.
			ui = {
				enable = false, -- set to false to disable all additional syntax features
				update_debounce = 200, -- update delay after a text change (in milliseconds)
				max_file_length = 5000, -- disable UI features for files with more than this many lines
				-- Define how various check-boxes are displayed
				checkboxes = {
					-- NOTE: the 'char' value has to be a single character, and the highlight groups are defined below.
					[" "] = { char = "󰄱", hl_group = "ObsidianTodo" },
					["x"] = { char = "", hl_group = "ObsidianDone" },
					[">"] = { char = "", hl_group = "ObsidianRightArrow" },
					["~"] = { char = "󰰱", hl_group = "ObsidianTilde" },
					["!"] = { char = "", hl_group = "ObsidianImportant" },
					-- Replace the above with this if you don't have a patched font:
					-- [" "] = { char = "☐", hl_group = "ObsidianTodo" },
					-- ["x"] = { char = "✔", hl_group = "ObsidianDone" },

					-- You can also add more custom ones...
				},
				-- Use bullet marks for non-checkbox lists.
				bullets = { char = "•", hl_group = "ObsidianBullet" },
				external_link_icon = { char = "", hl_group = "ObsidianExtLinkIcon" },
				-- Replace the above with this if you don't have a patched font:
				-- external_link_icon = { char = "", hl_group = "ObsidianExtLinkIcon" },
				reference_text = { hl_group = "ObsidianRefText" },
				highlight_text = { hl_group = "ObsidianHighlightText" },
				tags = { hl_group = "ObsidianTag" },
				block_ids = { hl_group = "ObsidianBlockID" },
				hl_groups = {
					-- The options are passed directly to `vim.api.nvim_set_hl()`. See `:help nvim_set_hl`.
					ObsidianTodo = { bold = true, fg = "#f78c6c" },
					ObsidianDone = { bold = true, fg = "#89ddff" },
					ObsidianRightArrow = { bold = true, fg = "#f78c6c" },
					ObsidianTilde = { bold = true, fg = "#ff5370" },
					ObsidianImportant = { bold = true, fg = "#d73128" },
					ObsidianBullet = { bold = true, fg = "#89ddff" },
					ObsidianRefText = { underline = true, fg = "#c792ea" },
					ObsidianExtLinkIcon = { fg = "#c792ea" },
					ObsidianTag = { italic = true, fg = "#89ddff" },
					ObsidianBlockID = { italic = true, fg = "#89ddff" },
					ObsidianHighlightText = { bg = "#75662e" },
				},
			},

			-- Specify how to handle attachments.
			attachments = {
				-- The default folder to place images in via `:ObsidianPasteImg`.
				-- If this is a relative path it will be interpreted as relative to the vault root.
				-- You can always override this per image by passing a full path to the command instead of just a filename.
				img_folder = "assets/imgs", -- This is the default

				-- Optional, customize the default name or prefix when pasting images via `:ObsidianPasteImg`.
				---@return string
				img_name_func = function()
					-- Prefix image names with timestamp.
					return string.format("%s-", os.time())
				end,

				-- A function that determines the text to insert in the note when pasting an image.
				-- It takes two arguments, the `obsidian.Client` and an `obsidian.Path` to the image file.
				-- This is the default implementation.
				---@param client obsidian.Client
				---@param path obsidian.Path the absolute path to the image file
				---@return string
				img_text_func = function(client, path)
					path = client:vault_relative_path(path) or path
					return string.format("![%s](%s)", path.name, path)
				end,
			},
		})

		vim.api.nvim_create_autocmd("FileType", {
			pattern = "markdown",
			callback = function()
				vim.keymap.set("n", "gl", function()
					if require("obsidian").util.cursor_on_markdown_link() then
						return "<Cmd>ObsidianFollowLink<cr>"
					else
						return "gl"
					end
				end, { noremap = false, expr = true, desc = "Follow link (Obsidian)" })
			end,
		})
	end,
	keys = {
		{
			"<leader>zb",
			function()
				return require("obsidian").util.toggle_checkbox()
			end,
			buffer = true,
			ft = "markdown",
			desc = "Toggle check box (Obsidian)",
		},
		{
			"<leader>ob",
			function()
				local query = vim.fn.input("Enter query: ")
				if query and #query > 0 then
					vim.cmd("ObsidianOpen " .. query)
				end
			end,
			ft = "markdown",
			desc = "Open note (Obsidian)",
		},
		{
			"<leader>onn",
			function()
				local title = vim.fn.input("Enter title: ")
				if title and #title > 0 then
					vim.cmd("ObsidianNew " .. title)
				end
			end,
			ft = "markdown",
			desc = "New note (Obsidian)",
		},
		{
			"<leader>os",
			"<Cmd>ObsidianQuickSwitch<cr>",
			ft = "markdown",
			desc = "Quick switch (Obsidian)",
		},
		{
			"<leader>oL",
			"<Cmd>ObsidianFollowLink<cr>",
			ft = "markdown",
			desc = "Follow link (Obsidian)",
		},
		{
			"<leader>oH",
			"<Cmd>ObsidianBacklinks<cr>",
			ft = "markdown",
			desc = "Back link (Obsidian)",
		},
		{
			"<leader>oft",
			function()
				local tags = vim.fn.input("Enter tag: ")
				if tags and #tags > 0 then
					vim.cmd("ObsidianTags " .. tags)
				end
			end,
			ft = "markdown",
			desc = "Search tag notes (Obsidian)",
		},
		{
			"<leader>ont",
			function()
				local offset = vim.fn.input("Enter offset: ")
				if offset and #offset > 0 then
					vim.cmd("ObsidianToday " .. offset)
				else
					vim.cmd("ObsidianToday")
				end
			end,
			ft = "markdown",
			desc = "Today note (Obsidian)",
		},
		{
			"<leader>ony",
			"<Cmd>ObsidianYesterday<cr>",
			ft = "markdown",
			desc = "Yesterday note (Obsidian)",
		},
		{
			"<leader>ont",
			"<Cmd>ObsidianTomorrow<cr>",
			ft = "markdown",
			desc = "Tomorrow note (Obsidian)",
		},
		{
			"<leader>ond",
			function()
				local offset = vim.fn.input("Enter offset: ")
				if offset and #offset > 0 then
					vim.cmd("ObsidianDailies " .. offset)
				else
					vim.cmd("ObsidianDailies")
				end
			end,
			ft = "markdown",
			desc = "Daily notes (Obsidian)",
		},
		{
			"<leader>oti",
			"<Cmd>ObsidianTemplate<cr>",
			ft = "markdown",
			desc = "Insert templates (Obsidian)",
		},
		{
			"<leader>ofn",
			function()
				local note = vim.fn.input("Enter note: ")
				if note and #note > 0 then
					vim.cmd("ObsidianSearch " .. note)
				end
			end,
			ft = "markdown",
			desc = "Search note (Obsidian)",
		},
		{
			"<leader>ow",
			function()
				local name = vim.fn.input("Enter name: ")
				if name and #name > 0 then
					vim.cmd("ObsidianWorkspace " .. name)
				end
			end,
			ft = "markdown",
			desc = "Workspace name (Obsidian)",
		},
		{
			"<leader>opi",
			function()
				local image = vim.fn.input("Enter image: ")
				if image and #image > 0 then
					vim.cmd("ObsidianPasteImg " .. image)
				end
			end,
			ft = "markdown",
			desc = "Paste image (Obsidian)",
		},
		{
			"<leader>onr",
			function()
				local name = vim.fn.input("Enter name: ")
				if name and #name > 0 then
					vim.cmd("ObsidianRename " .. name)
				end
			end,
			ft = "markdown",
			desc = "Rename note (Obsidian)",
		},
		{
			mode = "v",
			"<leader>ol",
			function()
				local query = vim.fn.input("Enter query: ")
				if query and #query > 0 then
					vim.cmd("ObsidianLink " .. query)
				else
					vim.cmd("ObsidianLink")
				end
			end,
			ft = "markdown",
			desc = "Link query (Obsidian)",
		},
		{
			mode = "v",
			"<leader>onl",
			function()
				local note = vim.fn.input("Enter note: ")
				if note and #note > 0 then
					vim.cmd("ObsidianLinkNew " .. note)
				else
					vim.cmd("ObsidianLinkNew")
				end
			end,
			ft = "markdown",
			desc = "New link note (Obsidian)",
		},
		{
			mode = "v",
			"<leader>ox",
			function()
				local note = vim.fn.input("Enter note: ")
				if note and #note > 0 then
					vim.cmd("ObsidianExtractNote " .. note)
				else
					vim.cmd("ObsidianExtractNote")
				end
			end,
			ft = "markdown",
			desc = "New extract text (Obsidian)",
		},
		{
			"<leader>otn",
			"<Cmd>ObsidianNewFromTemplate<cr>",
			ft = "markdown",
			desc = "Open new note with template (Obsidian)",
		},
		{
			"<leader>oc",
			"<Cmd>ObsidianTOC<cr>",
			ft = "markdown",
			desc = "Open contents (Obsidian)",
		},
	},
}