Installation with src directory

Question

Installation with src directory

mahoromax opened this issue 2 years ago · comments

I installed this plugin with BRAT (cause I didn't find the correct .json or .js files on first glance)

When I tried to run the plugin (I could enable it and use settings just fine) I noticed an error in the terminal about a file in the src folder, which was not present in the plugin folder.

I suspect that this behaviour might carry over to the installation when the plugin if accepted to community plugins.

ENOENT: no such file or directory, open 'C:\git\Obsidian\Work\.obsidian\plugins\obsidian-gitlab-issues\src\default-template.md.hb'

I did not specify my own template, so it tried to use the default, which wasn't present.

I have no idea how to resolve this generally (local I just copied the folder from the repo).

Ben Roberts · Answer 1 · Fri Oct 28 2022 22:29:59 GMT+0800 (China Standard Time)

I'm still waiting for approval to get onto the official community plugins list. I guess the developers have been busy with the 1.0 release recently.

Unless I'm mistaken, the src folder is not delivered to the local Obsidian installation when the plugin is installed through the normal way, so I'm not sure your error is anything to worry about. Obsidian will only get the compiled output from the dist directory.

In any case, what's the exact console error you are getting?

M. Hock · Answer 2 · Sat Oct 29 2022 00:29:55 GMT+0800 (China Standard Time)

Hey, I guess I edited in the error after you replied :-/

I do believe that not having the src folder delivered is exactly the problem, because the plugin defaults to a template located inside?

Ben Roberts · Answer 3 · Sun Oct 30 2022 20:09:35 GMT+0800 (China Standard Time)

This should now be resolved in 0.1.4.

M. Hock · Answer 4 · Mon Oct 31 2022 16:52:38 GMT+0800 (China Standard Time)

I think the problem has moved. It is not looking for a template in the 'src' folder anymore, but there is still no template installed (I did a fresh install using BRAT).
There was no template file present inside the plugin folder after install.

Gitlab Issues: ENOENT: no such file or directory, open 'C:\git\Obsidian\Work\.obsidian\plugins\obsidian-gitlab-issues\default-template.md.hb'

Ben Roberts · Answer 5 · Mon Oct 31 2022 17:56:41 GMT+0800 (China Standard Time)

How does BRAT do the install?

The template is in the zip file which is part of the release: https://github.com/benr77/obsidian-gitlab-issues/releases/download/0.1.4/obsidian-gitlab-issues-0.1.4.zip

If it doesn't use the zip file I'll have to add it as a separate file.

M. Hock · Answer 6 · Mon Oct 31 2022 20:46:41 GMT+0800 (China Standard Time)

I was assuming that BRAT uses the same method that the "released" community plugins would use.
And their documentation supports this:
https://github.com/TfTHacker/obsidian42-brat/blob/main/help/developers.md

Once a matching release is found based on that version number, the main.js, manifest.json and styles.css are downloaded by Obsidian and installed into your vault.

I kind of doubt that is a complete description, but comparing your release with another plugin (Dataview) I notice that they don't bundle the files (main.json) into a zip, so yeah, I think there's no need for a zip, only the files themselves are needed.

Ben Roberts · Answer 7 · Tue Nov 01 2022 22:22:52 GMT+0800 (China Standard Time)

OK so I have found out that Obsidian will ONLY install the three files for a plugin - main.js, styles.css and manifest.json. This means we need to incorporate the default template into the source code itself.

I'll try and sort this today or tomorrow.

Ben Roberts · Answer 8 · Tue Nov 01 2022 23:03:27 GMT+0800 (China Standard Time)

This should now be fixed in 0.1.6. @mahoromax please can you test on your install thanks.

M. Hock · Answer 9 · Fri Nov 11 2022 17:26:09 GMT+0800 (China Standard Time)

Sorry for the wait.

I can confirm that with the latest (0.1.7) this error is resolved.