feature: add support for cookies #166

lukas-reineke · 2021-11-30T15:17:02Z

Adds support for cookies in headlines and lists

https://orgmode.org/manual/Checkboxes.html

Add [/] or [%] to a headline or list with sub-items, and it should display the cookie.
It needs this to work emiasims/tree-sitter-org#11

fix #81

orgmode also supports this for TODO states if the cookie is in the headline. This PR does not cover that.

lukas-reineke · 2021-11-30T15:19:02Z

lua/orgmode/org/syntax.lua

+    local closest_parent = utils.get_closest_parent_of_type(checkbox, parent_type)
+    if closest_parent and closest_parent == parent then -- only count direct children


it would be nicer if the query could do this directly, but I don't know if that is possible.

I'm thinking (I could be wrong, didn't try it) that this section could be done with an iter_children and some recursion. Basically, you find all checkboxes as a single list, iterate through them, check their children, and do a recursion if they have it. It might end up as more code, but I think it would be faster and easier to understand.

it doesn't need recursion. It should only check the first level of checkboxes. The treesitter query finds all nested ones as well, so I had to do this hacky check.

The implementation with just iter_children isn't super pretty either, but you are probably right, it's easier to understand and faster

local function _get_cookie_checked_and_total(parent) local checked, total = 0, 0 for child in parent:iter_children() do if child:type() == 'listitem' then for listitem_child in child:iter_children() do if listitem_child:type() == 'checkbox' then local checkbox_text = vim.treesitter.get_node_text(listitem_child, 0) if checkbox_text:match('%[[x|X]%]') then checked = checked + 1 end total = total + 1 end end end end return checked, total end

kristijanhusak · 2021-11-30T15:49:24Z

orgmode also supports this for TODO states if the cookie is in the headline. This PR does not cover that.

Can you give an example of this? I don't understand it.

lukas-reineke · 2021-12-01T00:57:39Z

and we check the last box, then TODO will be converted to DONE automatically

No, this is not what I mean.
TODO and DONE headlines can also be the source for cookies.
Like this:

* TODO bake a cake [3/6]
** DONE buy ingredients
** DONE start cooking
** DONE realize you forgot eggs, dammit
** TODO drive back to the store and buy eggs
** TODO wait, I needed THREE sticks of butter?
** TODO drive back to the store and just buy a damn cake

This is from the documentation

In a headline, a cookie can count either checkboxes below the heading or TODO states of children, and it displays whatever was changed last. Set the property ‘COOKIE_DATA’ to either ‘checkbox’ or ‘todo’ to resolve this issue.

And this PR only handles checkbox, not todo

kristijanhusak · 2021-12-01T09:03:41Z

lua/orgmode/org/syntax.lua

+      text = '[0%]'
+    end
+  end
+  vim.api.nvim_buf_set_extmark(0, cookie_namespace, row, column + (leading_spaces or 0), {


Emacs orgmode is actually modifying the content for this instead of using something like virtual text. That's why they require [/] to be added to the end. I'd love to propose 2 solutions to this:

Do the same thing that emacs does (Really replace the text)

Implement this as a virtual text without a need for a user to type [/]

Current solution is kind of a hybrid, and I think having empty [/] as a content will cause confusion.
I'd love to go with 1st solution, since it copies the emacs orgmode functionality which I'm trying to achieve most of the time.
I know that 2nd solution is simpler, and we could have it enabled by default, and to allow it to be disabled through config.
If first one is too complicated, we can go with 2nd one.

👍 I didn't know emacs modifies the file.
shouldn't be that hard to do.

Updating the text in the buffer is very expensive.. it gets very slow even with only a couple cookies.
Maybe we use virtual text and only update the actual text on save?

@lukas-reineke how are you updating it? It should update only when you check/uncheck something, maybe you are triggering it more often. Maybe if you have file with several thousand lines, but even than shouldn't cause that many issues.

I was updating all of them before, but yeah without virt text it makes much more sense to only trigger this on checkbox toggle.
I rewrote the logic to do this.
Added bonus, checkboxes update their parents now as well.

fix nvim-orgmode#81

kristijanhusak · 2021-12-01T16:11:30Z

lua/orgmode/org/syntax.lua

@@ -36,7 +41,115 @@ local function add_todo_keywords_to_spellgood()
  end
 end

+local function _get_cookie_checked_and_total(parent)


Lets move this thing to a separate file, it's fairly big at this point.

kristijanhusak · 2021-12-02T11:41:45Z

This looks ok to me for now. I'll wait for the upstream tree-sitter-org PR to get merged to test this. I'm just not sure why tests started to fail.

lukas-reineke · 2021-12-02T12:23:02Z

The treesitter queries will need to be updated anyway after the change in tree-sitter-org.

I'll take a look at the tests then.

Do you want to keep support for 0.5 now that 0.6 is released? I think I used some 0.6 APIs.
Other plugins like nvim-lspconfig have already dropped support for 0.5, and it would make it easier. But I can try to make it work in 0.5 as well.

kristijanhusak · 2021-12-02T12:25:06Z

Do you know what exactly did you use from 0.6? I would love to keep 0.5 support, but if it complicates things drastically, we could have a release before merging it.

lukas-reineke · 2021-12-02T12:35:29Z

Oh maybe I didn't. I thought vim.treesitter.get_node_text and tsnode:named_child were 0.6, but I just checked and they are 0.5.
Maybe it's fine then. I'll write tests for this anyway, then we'll know for sure.

YuCao16 · 2022-03-13T00:56:52Z

Is there any progress on this feature? Other than that, I think it might be useful if the concept of weights could be introduced.

Thanks for you work, enjoy this Plug so much!

lukas-reineke · 2022-03-13T01:47:35Z

I am waiting on this emiasims/tree-sitter-org#13

Once that is done I can update this PR.

Is weights a native org feature?

YuCao16 · 2022-03-13T09:55:18Z

I am waiting on this emiasims/tree-sitter-org#13

Once that is done I can update this PR.

Is weights a native org feature?

No, as far as I know it isn't. But weights can be very useful if you can prioritize checkboxes. But this is just an idea :D

lukas-reineke · 2022-03-13T13:06:15Z

I agree it could be useful, but if it is not in org, it will most likely also not make it in this repo.

YuCao16 · 2022-03-13T13:09:51Z

I agree it could be useful, but if it is not in org, it will most likely also not make it in this repo.

I totally understand and look forward to the cookie going merge soon, thank you for your work.

PhosCity · 2022-04-09T02:37:18Z

I am waiting on this milisims/tree-sitter-org#13

Once that is done I can update this PR.

milisims/tree-sitter-org#13 has been closed. Will there be any update to this? It would be wonderful to have this feature in the plugin.

lukas-reineke · 2022-04-11T03:07:13Z

I will finish this. Just have to see when I can find some time.

gerazov · 2022-04-15T12:55:55Z

This is awesome 😎

I saw it's mentioned but atm will it also work with TODO/DONE cookies as well?

kristijanhusak · 2022-05-10T13:23:52Z

Closing in favor of #287

lukas-reineke commented Nov 30, 2021

View reviewed changes

kristijanhusak reviewed Dec 1, 2021

View reviewed changes

lukas-reineke force-pushed the feature/cookies branch from 72fef86 to 5f75eb6 Compare December 1, 2021 14:27

feature: add support for cookies

89a9ac7

fix nvim-orgmode#81

lukas-reineke force-pushed the feature/cookies branch from 5f75eb6 to 89a9ac7 Compare December 1, 2021 14:28

kristijanhusak reviewed Dec 1, 2021

View reviewed changes

lukas-reineke added 5 commits December 2, 2021 10:40

fixup! feature: add support for cookies

cd402ce

fixup! feature: add support for cookies

41b0ade

fixup! feature: add support for cookies

6efef32

fixup! feature: add support for cookies

81589e1

fixup! feature: add support for cookies

9d1f707

TravonteD mentioned this pull request May 10, 2022

Add support for list-item cookies #287

Merged

kristijanhusak closed this May 10, 2022

		local closest_parent = utils.get_closest_parent_of_type(checkbox, parent_type)
		if closest_parent and closest_parent == parent then -- only count direct children

Uh oh!

feature: add support for cookies #166

feature: add support for cookies #166

Uh oh!

Conversation

lukas-reineke commented Nov 30, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kristijanhusak commented Nov 30, 2021

Uh oh!

lukas-reineke commented Dec 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kristijanhusak commented Dec 2, 2021

Uh oh!

lukas-reineke commented Dec 2, 2021

Uh oh!

kristijanhusak commented Dec 2, 2021

Uh oh!

lukas-reineke commented Dec 2, 2021

Uh oh!

YuCao16 commented Mar 13, 2022

Uh oh!

lukas-reineke commented Mar 13, 2022

Uh oh!

YuCao16 commented Mar 13, 2022

Uh oh!

lukas-reineke commented Mar 13, 2022

Uh oh!

YuCao16 commented Mar 13, 2022

Uh oh!

PhosCity commented Apr 9, 2022

Uh oh!

lukas-reineke commented Apr 11, 2022

Uh oh!

gerazov commented Apr 15, 2022

Uh oh!

kristijanhusak commented May 10, 2022

Uh oh!

Uh oh!

lukas-reineke commented Dec 1, 2021 •

edited

Loading