Skip to content

fix(utils.merge_default_create_file_opts): remove hardcoded vertical for opts.split #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
y3owk1n merged 2 commits into from
Apr 11, 2025
Merged

fix(utils.merge_default_create_file_opts): remove hardcoded vertical for opts.split #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0e3e9f
fix(utils.merge_default_create_file_opts): remove hardcoded `vertical…
mtraworld Apr 11, 2025
0e45dd8
chore(build): auto-generate docs from readme
mtraworld Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ Prompt to create and open a new markdown note.
```lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_note(opts)
Expand All @@ -443,7 +443,7 @@ Open/create today’s todo and roll over tasks.
```lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_todo_today(opts)
Expand All @@ -461,7 +461,7 @@ Open/create a journal entry for today.
```lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_journal(opts)
Expand All @@ -479,7 +479,7 @@ Open the central `inbox.md`.
```lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_journal(opts)
Expand Down
8 changes: 4 additions & 4 deletions doc/dotmd.nvim.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ Prompt to create and open a new markdown note.
>lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_note(opts)
Expand All @@ -458,7 +458,7 @@ Open/create today’s todo and roll over tasks.
>lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_todo_today(opts)
Expand All @@ -478,7 +478,7 @@ Open/create a journal entry for today.
>lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_journal(opts)
Expand All @@ -498,7 +498,7 @@ Open the central `inbox.md`.
>lua
---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@param opts? DotMd.CreateFileOpts
require("dotmd").create_journal(opts)
Expand Down
2 changes: 1 addition & 1 deletion lua/dotmd/types.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

---@class DotMd.CreateFileOpts
---@field open? boolean Open the file after creation, default is true
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is `vertical`
---@field split? "vertical" | "horizontal" | "none" Split direction for new or existing files, default is based on `default_split` in config

---@class DotMd.PickOpts
---@field type? "notes" | "todos" | "journal" | "all" Pick type, default is `notes`
Expand Down
4 changes: 1 addition & 3 deletions lua/dotmd/utils.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ local M = {}
function M.merge_default_create_file_opts(opts)
opts = opts or {}
opts.open = opts.open ~= false
opts.split = opts.split
or require("dotmd.config").config.default_split
or "vertical"
opts.split = opts.split or require("dotmd.config").config.default_split
return opts
end

Expand Down
1 change: 0 additions & 1 deletion tests/utils_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ describe("dotmd.utils module", function()
assert.is_true(opts.open)
-- opts.split should be set to either dotmd.config default_split or "vertical"
local expected = require("dotmd.config").config.default_split
or "vertical"
assert.are.equal(expected, opts.split)
end)

Expand Down