Communicate MarkdownItPlugin with plugin

DanteCoder · 15 October 2021 19:13

Hi everyone!

Im buliding a plugin to parse a bible cite and displaying the text on the view.

I already made it work with a markdownItPlugin content script, but here is the problem I'm having:

The contentScriptMarkdown requires the fs library from Node js to open a xml file, and the fs library requires the path to the file to open it. I hard coded the path to the file on my computer (the fs library only supports absolute paths), but I would like to make it dynamic, so a normal user can select the path from the plugin settings.

The problem is the markdownItPlugin can't retrieve the settings values, unlike in the index.ts script where I can use the await joplin.settings.value('Setting'); function.

My idea was to communicate somehow the content script with the plugin. I found in the doc that I can communicate with the plugin from the content script, but I already struggled enough with it and I can't get it to work. The most I could do was to print the response from the plugin on the console (just as the postMessage demo).

If you have an idea or something to help I'll be gratefull.

My current code in the MarkdownItPlugin is the following (the hard coded path is in line 7):

github.com

DanteCoder/JoplinBibleQuote/blob/main/src/markdownItPlugin.ts

import bibleIndex from './bibles/bible_index';
const bcv_parser = require('bible-passage-reference-parser/js/es_bcv_parser').bcv_parser;
const bcv = new bcv_parser;
const parseXmlString = require('xml2js').parseString;
const fs = require('fs');

let bible_path = 'D:\\Dante Gamaliel\\Coding\\PersonalProjects\\JoplinPlugins\\JoplinBibleQuote\\src\\bibles\\OSIS\\Reina-Valera 1960.xml';
const jsonBible = (XmmBible2Js(bible_path)).osis.osisText[0];
const bibleInfo = bcv.translation_info();

export default function () {
	return {
		plugin: function (markdownIt, _options) {
			const defaultRender = markdownIt.renderer.rules.fence || function (tokens, idx, options, env, self) {
				return self.renderToken(tokens, idx, options, env, self);
			};

			markdownIt.renderer.rules.fence = function (tokens, idx, options, env, self) {
				const token = tokens[idx];

This file has been truncated. show original

tessus · 16 October 2021 00:02

You might be able to find the aolution in the code of the backup plugin. afaik one can specify the location of the backup file.
@JackGruber played around with relative file paths for a while I think. Not sure if he ever made relative paths work though.

DanteCoder · 16 October 2021 01:21

Thank you tessus.

I found a way around this problem using the localStorage property. I don't know if it's a good practice but at least it works.

You can see what I did here and here.

Topic		Replies	Views
How can I refer the plugin settings from contentScript? Development	19	1799	3 November 2023
Async Markdown-It plugin Plugins	7	143	7 October 2024
dataDir needed for markdownIt plugin Plugins	6	689	22 October 2021
Pass data TO content script Plugins	8	1116	11 January 2021
How to read html files from a plugin Development	2	503	17 June 2021

Communicate MarkdownItPlugin with plugin

Related topics