开发Discourse插件 - 第1部分 - 创建一个基本插件

文档 开发者指南
,
109

Hmmmm. That’s a tricky one, because the symlink needed to be deleted, otherwise the Docker mount fails (as it cannot overwrite the existing file).

I had a bit of a google around for solutions, and found an interesting solution which would dereference the symlink and copy the symlink’s target into the specified directory, but couldn’t find anything that would create a Docker volume mount, thus preserving the dynamic link and bi-directional synchronisation. Happy to be steered towards a solution as this would be a neat feature to have.

111

Tell me how to add your validation to the app/models /user.rb model?
https://github.com/discourse/discourse/blob/8c2e27790cf7c5fcc883489a7bdf36008fda88ac/app/models/user.rb#L99-L110

1 个赞
112

You can use regular Ruby code to do this in your plugin.rb:

class ::User < ActiveRecord::Base
  validates_presence_of :your_attribute
end
6 个赞
113

Just starting on my first small plugin :blush: I have a few questions I hope someone can help with…

First question is does it matter if we use what’s in this guide or should we really be aiming to use the plugin generator?

It wasn’t covered in this guide, but how can we make data available to our templates from the plugin.rb file?

Let’s say for example I want to display a random welcome message at the plugin-outlet topic-above-posts whenever somebody visits a topic, with the message being randomly selected from an array in plugin.rb… how would I send that data to the template? Which I also presume would go here:

plugins/my_new_plugin/assets/javascripts/discourse/templates/connectors/topic-above-posts/my_new_plugin.hbs (Is this correct?)

Any tips greatly appreciated :blush:

2 个赞
114

Using the plugin generator is generally a great way to get started and see how a plugin should be structured. I recommend it.

Now, regarding how to get ruby code into the front end: those are two different applications. The front end application (Ember) will have to request it from the server (Rails) somehow. Normally we do this via an AJAX call, but you could also do something like add to the SiteSerializer so that it’s sent automatically as part of the forum data.

Otherwise you will have to look up how to add a route/controller in rails and send the messages as JSON.

8 个赞
115

Thanks Robin!

Would you know if there are any tutorials on this? Or, is there a simple plugin (or even a dummy plugin) we can look at that points us in the right direction? (If not, is this something you could quickly put up for us somewhere please? I think it’ll help a lot of people :blush:)

Plus… any more thoughts on writing a book? I can put you in touch with someone if you fancy it :smiley:

1 个赞
116

Thanks for the compliment but I’m definitely far too busy to consider writing a book. Plus tech books have SUPER limited range. Those I know who have written them say you do it for yourself, not for the money :slight_smile:

I can’t think of simple plugin for returning something from the server side. discourse-tooltips adds a route and then uses that to get previews of topics as you mouseover so that might be helpful.

8 个赞
118

Soon, I will start plugin development…

Question:

Is there a list of hooks where we actually can plugin?

For example, say we want to write a plugin to process the cooked data in a post before it is displayed, we would expect there to be at least one hook at the beginning and one at the end, like (for example):

  • display_post_start

  • display_post_complex

Then, our plugin would hook into the code at the hook location of our choice above.

Is there a list of these plugin hooks and what are these plugin hooks called in DiscourseWorld?

Update: Found this:

git grep "plugin-outlet" -- "*.hbs"

But there was no outlet for modifying cooked post content, that I can see.

Is there a tutorial on creating our own outlets, for example, an outlet to modify the cooked part of posts?

2 个赞
119

You’re looking for this guide, section decorateCooked():

5 个赞
133

我为自定义插件使用了这个骨架。我需要为即将到来的 Ember 5 过渡做任何更改吗？

我猜不用？虽然这只是一个 linter？

1 个赞
134

该骨架与 Ember 5 兼容。但如果您添加了任何 JavaScript 代码或 hbs 模板，则需要按照公告中的说明检查弃用情况。

是的，package.json 中的内容仅与 linting 相关，它不会影响插件的功能或兼容性。

3 个赞
136

请添加到这个

rake plugin:create[plugin-name]

我今天花了太长时间才找到 Automating Discourse Plugin Setup with `create-discourse-plugin` gem （不知道为什么我记不起这是 rake 任务的名称？！ :person_shrugging: ）

5 个赞
141

我也想在 Docker 设置中添加一个注释，因为上面的说明在尝试创建插件时会因类似以下错误而失败：

ambientimpact:~/.../Discourse/discourse$ d/rake plugin:create[neurocracy-date-rewrite]
Cloning 'https://github.com/discourse/discourse-plugin-skeleton' to '/src/plugins/neurocracy-date-rewrite'...
Initializing git repository...
Initialized empty Git repository in /src/plugins/neurocracy-date-rewrite/.git/
Author identity unknown

*** Please tell me who you are.

Run

  git config --global user.email "you@example.com"
  git config --global user.name "Your Name"

to set your account's default identity.
Omit --global to set the identity only in this repository.

fatal: empty ident name (for <discourse@localhost>) not allowed
rake aborted!
Command failed with exit 128: git
/src/lib/tasks/plugin.rake:354:in `system'
/src/lib/tasks/plugin.rake:354:in `block (2 levels) in <main>'
/src/lib/tasks/plugin.rake:344:in `chdir'
/src/lib/tasks/plugin.rake:344:in `block in <main>'
Tasks: TOP => plugin:create
(See full trace by running task with --trace)

在尝试创建插件之前，您需要先在容器中设置您的 .gitconfig（根据需要更改电子邮件和姓名）：

d/exec git config --global user.email "you@example.com"
d/exec git config --global user.name "Your Name"
d/rake plugin:create[plugin-name]