Accessing Joplin model from CodeMirror plugin

roman_r_m · 2021-01-09T00:09:40.552Z

I am writing a plugin that installs a CodeMirror content script (for inline tags). From the content script I need to get the list of all tags. Is there any way to achieve this?

CalebJohn · 2021-01-09T18:14:44.317Z

I don't think there currently is (but there is a placeholder for passing data to content scripts).

What are you looking to do in the content script? I might be able to help you find a work around.

roman_r_m · 2021-01-09T20:39:06.510Z

I was hoping to make a plugin that'd allow the user to add tags by typing # and either selecting an existing tag from the list or creating a new one.
Got CodeMirror to show autocomplete popup:

and then I realized there does not seem to be a way to get the list of all tags, add a tag to the current note, and create a new tag.

The only way I can think of is call into clipper API over http but this seems like a terrible solution, and I am not going to do this.

roman_r_m · 2021-01-09T20:43:07.244Z

Similarly, I was thinking of another plugin that could benefit from having access to data API.
This time a MarkdownIt plugin allowing the user to write something like
'''search:
''' (but with 3 backticks - can't figure out how to escape them)
and have it rendered as a list of links to the notes matching the query.

JackGruber · 2021-01-09T20:53:31.945Z

Posible you can use the GET /tags Data API in the script and not the plugin API?
https://joplinapp.org/api/references/rest_api/#get-tags-id

dow, I see you have you have mentioned this ...

tessus · 2021-01-09T20:56:00.434Z

It would also help with this feature:

Syntax to link notes Features

We had this discussion a few times before. It’s also on my wishlist, but there are so many other things to tackle first. My solution would look like this: when you typed [[ a popup next to the cursor would appear and you could search for a note (similar to the goto anything element - or actually we could even use the same code). Then the [[ would be replaced by the proper link [note title](:/hash).

CalebJohn · 2021-01-09T20:57:34.594Z

I see, this is a really good use case for passing data. I think we should wait to see what @laurent says about it.

Personally, I don't see using the data api to be much of an issue, but it would be good to have an official stance in either case.

roman_r_m · 2021-01-09T21:07:34.282Z

CalebJohn:

Personally, I don't see using the data api to be much of an issue, but it would be good to have an official stance in either case.

Somewhat offtopic, but I find the idea of one function calling another function in the same process over http a little ridiculous, it's like microservices taken to the extreme.

laurent · 2021-01-09T23:13:47.227Z

The ideal solution would be to be able to post messages between the content script and the plugin. That way you indirectly have access to the whole API, and also can pass messages whenever needed.

The issue with ipc calls though is that they are always async. So I'm wondering, in the tag example above, would it be possible to get it working with async calls? I'm not very familiar with the way CodeMirror works, but I guess most calls are sync? Basically I'm wondering if it's even worth looking at posting messages if it doesn't end up solving the issue.

roman_r_m · 2021-01-10T08:54:06.873Z

I believe CodeMirror supports async calls for autocomplete. I couldn't get it to work in the 1st attempt though and haven't tried since.

roman_r_m · 2021-01-10T12:19:04.320Z

I've just realized - I can't even use http API. It requires the port and API token but there's no way for a content script to get them (except maybe reading the database directly).

laurent · 2021-01-10T23:59:35.878Z

@roman_r_m or @CalebJohn, do you have a simple CodeMirror content script example I could use to test posting messages?

CalebJohn · 2021-01-11T18:28:51.205Z

Sorry, I don't have anything that needs it yet. You can use the math plugin as a base. line 344 shows the plugin setup.