I want to make a plugin that needs its own tables. So its a good idea to have migration and model generators, because manually copying them from the main app dir will lead to errors and is just not very convenient. So I started making my own generators. I started with the migration generator: https://github.com/spirobel/discourse/commit/3ba8190286b5c40eeace1b58238cbf5075db597e I could move on now and do the same for models and controllers. But now I started to read this Getting Started with Engines — Ruby on Rails Guides and now it seems to me that all of this might be a duplication of efforts. Why does the discourse plugin generator diverge so much from the rails plugin generator? The rails plugin generator makes a plugin specific bin/rails that enables the plugin specific migration and model generators. It would be nice to have something like this as well. I tried to make something like this as well but I could not get it to work, so I went the other route and just started creating these special snowflake generators. If I understood better what the differences between the rails and the discourse way of making plugins is, I might be able to go this other route which might save time. Maybe someone can expand on this. Why are discourse and rails plugins something different and why do they not build on each other?

Rails plugins are different from Discourse plugins due to many reasons. Discourse plugins need to have a specific folder structure, they can extend/override the ember code of the core discourse etc. I think the rails side of a discourse plugin would be closer to a generic rails plugin but they aren’t the same things. Moreover, one should only create new tables if they’re really needed. Discourse already has ~150 tables and its not too often that your job isn’t done using one or a couple of them. But, moving forward, I personally would wish and like to see that happen. It would mean people are building huge and more exciting plugins and getting more creative with what could be done with Discourse.

[image] fzngagan: Moreover, one should only create new tables if they’re really needed. Discourse already has ~150 tables and its not too often that your job isn’t done using one or a couple of them. I need them. Even basic functionality needs tables. I think its really annoying that there is no clear documented way on how to do this. For example the poll plugin uses its own tables, but I cant find the generator for how to make them. discourse/plugins/poll at main · discourse/discourse · GitHub Another benefit from documenting is that there will be conventions on table/migration namespacing. (I saw some really hacky solutions recommended here in the forums on how to add migrations to a plugin) [image] fzngagan: But, moving forward, I personally would wish and like to see that happen. It would mean people are building huge and more exciting plugins and getting more creative with what could be done with Discourse. Nice! So which way to go? moving closer to the rails plugin generator with own bin/rails in the plugin folder, or own versions for all the generators (migrations/models/controllers) ?

You need to read the plugin development howto topics here. For most plugins you can use existing tables (like post custom field). There are times that you need more tables, but you’d probably do well to start with something less difficult to start.

[image] pfaffman: You need to read the plugin development howto topics here. I read the beginners plugin guide and this . Is there something else? I also looked at the code of some plugins. I just know that I need tables. And there are other plugins as well that use their own tables. Why is there this obsession with not creating new tables? Is there a big cost involved with creating new tables? Especially if they are namespaced with the plugin name at the beginning I really dont see the downside.

https://meta.discourse.org/t/creating-routes-in-discourse-and-showing-data/48827/19?u=fzngagan [image] How can I make my own Discourse plugins? Development I’ve only just started but here’s my ‘starter for 10’ to get you going: Read: these this Try and read the code on the simplest, but popular plugins and see if you can understand what they are doing (this is not always easy, especially with the complexity of dealing with multiple files and the sometimes brutal functional brevity of javasctipt, but persevere) You need to learn: Lots of Javascript (look no further than @mpj’s Fun Fun Function excellent & fun (!) videos (thanks man!)) Lots of … These ones here. I highly recommend these ones hands on before making any comment about anything related to dev. Not to say you might not need custom tables ever but these are must anyway.

app/models/plugin_store.rb 888e68a16 # frozen_string_literal: true # API to wrap up plugin store rows class PluginStore attr_reader :plugin_name def initialize(plugin_name) @plugin_name = plugin_name end def get(key) self.class.get(plugin_name, key) end def get_all(keys) self.class.get_all(plugin_name, keys) end def set(key, value) self.class.set(plugin_name, key, value) This file has been truncated. show original this thing is just a basic key value store. I cant store relations between tables there. I like SQL. And I need to use it for the plugin I want to create. [image] How to create migration files? Development Note that if you are developing a plugin, discourse provides a PluginStore to help you avoid migrations, since undoing then when the plugin gets uinstalled is a open problem. I can understand this problem applies to people that want to create plugins that “non technical people” can install and uninstall. I am not one of those people. So I would be glad if we could go back to the topic.

[image] spirobel: I can understand this problem applies to people that want to create plugins that “non technical people” can install and uninstall. I am not one of those people. If the intent is to create something only you yourself will be using, IMHO it would likely be better to write a browser extension or a desktop app instead of a plugin. Any reason this must be a plugin?

Here’s an interesting related discussion: [image] Adding jsonb columns for custom fields Development Often times when developing plugins, I’ve had to use the CustomField or PluginRowStore tables to store arbitrary data related to the plugin (for example, retort stores a string representation of reactions to a particular post as a PostCustomField) This works well for simple data, but for anything a bit more complex, I’ve found myself wanting access to more than a postgres text-valued column can provide. Postgres has supported the jsonb column type for several versions now (since 9.4), which pro…

Rails plugins vs discourse plugins - what is the difference?

Development

merefield (Robert) August 30, 2019, 6:14pm 9

Here’s an interesting related discussion:

Topic		Replies	Views
Rails plugin generator Announcements	49	13967	August 20, 2021
Issues generating models for plugin Development	2	551	July 26, 2022
Creating a plugin Development	0	971	January 28, 2019
Developing Discourse Plugins - Part 1 - Create a basic plugin Developer Guides plugin-guides , tutorial	32	85499	July 8, 2025
Discourse Plugins and Rails 6 config/initializers Question Development	22	3480	November 22, 2020

Rails plugins vs discourse plugins - what is the difference?

Related topics