github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-26 11:43:44 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
731699a7cf
discourse/lib/plugin/metadata.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

167 lines
3.8 KiB
Ruby
Raw Normal View History

DEV: enable frozen string literal on all files This reduces chances of errors where consumers of strings mutate inputs and reduces memory usage of the app. Test suite passes now, but there may be some stuff left, so we will run a few sites on a branch prior to merging
2019-05-03 06:17:27 +08:00
# frozen_string_literal: true
refactoring the plugin interfaces to allow for better extensible
2013-08-23 14:21:52 +08:00
# loaded really early
module Plugin
end
class Plugin::Metadata
Shorten some very long lines Prevent warnings from already defined constants when reloading
2017-08-12 10:18:04 +08:00
OFFICIAL_PLUGINS ||=
DEV: Apply syntax_tree formatting to `lib/*`
2023-01-09 20:10:19 +08:00
Set.new(
Remove discourse-canned-replies from official list (#22932) This plugin is no longer supported, and so we no longer need to run its tests in CI (removing the comment and the 'Canned Replies' value from the array caused syntax_tree to change to the `%w` syntax)
2023-08-02 19:48:20 +08:00
%w[
discourse-adplugin
discourse-affiliate
discourse-ai
discourse-akismet
discourse-algolia
discourse-apple-auth
discourse-assign
discourse-auto-deactivate
discourse-automation
discourse-bbcode
discourse-bbcode-color
discourse-bcc
discourse-cakeday
discourse-calendar
discourse-categories-suppressed
discourse-category-experts
discourse-characters-required
discourse-chat-integration
discourse-code-review
discourse-crowd
discourse-data-explorer
discourse-details
discourse-docs
discourse-encrypt
discourse-follow
discourse-fontawesome-pro
discourse-gamification
DEV: add geoblocking and tag-by-group plugins (#23255)
2023-08-25 16:22:54 +08:00
discourse-geoblocking
Remove discourse-canned-replies from official list (#22932) This plugin is no longer supported, and so we no longer need to run its tests in CI (removing the comment and the 'Canned Replies' value from the array caused syntax_tree to change to the `%w` syntax)
2023-08-02 19:48:20 +08:00
discourse-github
discourse-gradle-issue
discourse-graphviz
discourse-group-tracker
discourse-invite-tokens
DEV: Add jira plugin to official list of plugins (#22997) https://github.com/discourse/discourse-jira
2023-08-10 18:25:22 +08:00
discourse-jira
Remove discourse-canned-replies from official list (#22932) This plugin is no longer supported, and so we no longer need to run its tests in CI (removing the comment and the 'Canned Replies' value from the array caused syntax_tree to change to the `%w` syntax)
2023-08-02 19:48:20 +08:00
discourse-lazy-videos
discourse-local-dates
discourse-login-with-amazon
discourse-logster-rate-limit-checker
discourse-logster-transporter
discourse-lti
discourse-math
discourse-moderator-attention
discourse-narrative-bot
discourse-newsletter-integration
discourse-no-bump
discourse-oauth2-basic
discourse-openid-connect
discourse-patreon
discourse-perspective-api
discourse-linkedin-auth
discourse-microsoft-auth
discourse-policy
discourse-post-voting
discourse-presence
discourse-prometheus
discourse-prometheus-alert-receiver
discourse-push-notifications
discourse-reactions
discourse-restricted-replies
discourse-rss-polling
discourse-salesforce
discourse-saml
discourse-saved-searches
discourse-shared-edits
discourse-signatures
discourse-sitemap
discourse-solved
discourse-staff-alias
discourse-steam-login
discourse-subscriptions
DEV: add geoblocking and tag-by-group plugins (#23255)
2023-08-25 16:22:54 +08:00
discourse-tag-by-group
Remove discourse-canned-replies from official list (#22932) This plugin is no longer supported, and so we no longer need to run its tests in CI (removing the comment and the 'Canned Replies' value from the array caused syntax_tree to change to the `%w` syntax)
2023-08-02 19:48:20 +08:00
discourse-teambuild
discourse-templates
discourse-tooltips
discourse-topic-voting
discourse-translator
discourse-user-card-badges
discourse-user-notes
discourse-vk-auth
discourse-whos-online
discourse-yearly-review
discourse-zendesk-plugin
discourse-zoom
docker_manager
chat
poll
styleguide
checklist
DEV: Remove core plugins from plugin metadata file (#24070) * DEV: Remove core plugins from plugin metadata file * Add new plugin names
2023-10-24 05:26:59 +08:00
footnote
spoiler-alert
DEV: Apply syntax_tree formatting to `lib/*`
2023-01-09 20:10:19 +08:00
],
)
FEATURE: split JavaScript application bundle, so plugins live in own file This adds plugin.js and plugin_third_party.js files
2016-11-15 08:42:55 +08:00
DEV: Add meta_topic_id plugin metadata (#23838) For the admin plugin list we want to be able to link to a meta topic for plugins, but we have no standard way to do this at the moment. This adds support for meta_topic_id alongside other plugin metadata like authors, URL etc, that gets built into a Meta topic URL in the serializer.
2023-10-10 08:16:13 +08:00
FIELDS ||= %i[
name
about
version
authors
contact_emails
url
required_version
transpile_js
meta_topic_id
FIX: Further improvements for plugin list (#24622) Followup e37fb3042d6f56a27a01614e57bc7029f472b0c9 * Automatically remove the prefix `Discourse ` from all the plugin titles to avoid repetition * Remove the :discourse_dev: icon from the author. Consider a "By Discourse" with no labels as official * We add a `label` metadata to plugin.rb * Only plugins made by us in `discourse` and `discourse-org` GitHub organizations will show these in the list * Make the plugin author font size a little smaller * Make the commit sha look like a link so it's more obvious it goes to the code Also I added some validation and truncation for plugin metadata parsing since currently you can put absolutely anything in there and it will show on the plugin list.
2023-11-30 08:53:17 +08:00
label
DEV: Add meta_topic_id plugin metadata (#23838) For the admin plugin list we want to be able to link to a meta topic for plugins, but we have no standard way to do this at the moment. This adds support for meta_topic_id alongside other plugin metadata like authors, URL etc, that gets built into a Meta topic URL in the serializer.
2023-10-10 08:16:13 +08:00
]
FEATURE: split JavaScript application bundle, so plugins live in own file This adds plugin.js and plugin_third_party.js files
2016-11-15 08:42:55 +08:00
attr_accessor(*FIELDS)
refactoring the plugin interfaces to allow for better extensible
2013-08-23 14:21:52 +08:00
FIX: Further improvements for plugin list (#24622) Followup e37fb3042d6f56a27a01614e57bc7029f472b0c9 * Automatically remove the prefix `Discourse ` from all the plugin titles to avoid repetition * Remove the :discourse_dev: icon from the author. Consider a "By Discourse" with no labels as official * We add a `label` metadata to plugin.rb * Only plugins made by us in `discourse` and `discourse-org` GitHub organizations will show these in the list * Make the plugin author font size a little smaller * Make the commit sha look like a link so it's more obvious it goes to the code Also I added some validation and truncation for plugin metadata parsing since currently you can put absolutely anything in there and it will show on the plugin list.
2023-11-30 08:53:17 +08:00
MAX_FIELD_LENGTHS ||= {
name: 75,
about: 350,
authors: 200,
contact_emails: 200,
url: 500,
label: 20,
}
def meta_topic_id=(value)
@meta_topic_id =
begin
Integer(value)
rescue StandardError
nil
end
end
refactoring the plugin interfaces to allow for better extensible
2013-08-23 14:21:52 +08:00
def self.parse(text)
metadata = self.new
text.each_line { |line| break unless metadata.parse_line(line) }
metadata
end
FEATURE: split JavaScript application bundle, so plugins live in own file This adds plugin.js and plugin_third_party.js files
2016-11-15 08:42:55 +08:00
def official?
OFFICIAL_PLUGINS.include?(name)
end
refactoring the plugin interfaces to allow for better extensible
2013-08-23 14:21:52 +08:00
def parse_line(line)
line = line.strip
unless line.empty?
return false unless line[0] == "#"
FIX: Further improvements for plugin list (#24622) Followup e37fb3042d6f56a27a01614e57bc7029f472b0c9 * Automatically remove the prefix `Discourse ` from all the plugin titles to avoid repetition * Remove the :discourse_dev: icon from the author. Consider a "By Discourse" with no labels as official * We add a `label` metadata to plugin.rb * Only plugins made by us in `discourse` and `discourse-org` GitHub organizations will show these in the list * Make the plugin author font size a little smaller * Make the commit sha look like a link so it's more obvious it goes to the code Also I added some validation and truncation for plugin metadata parsing since currently you can put absolutely anything in there and it will show on the plugin list.
2023-11-30 08:53:17 +08:00
attribute, *value = line[1..-1].split(":")
refactoring the plugin interfaces to allow for better extensible
2013-08-23 14:21:52 +08:00
FIX: Further improvements for plugin list (#24622) Followup e37fb3042d6f56a27a01614e57bc7029f472b0c9 * Automatically remove the prefix `Discourse ` from all the plugin titles to avoid repetition * Remove the :discourse_dev: icon from the author. Consider a "By Discourse" with no labels as official * We add a `label` metadata to plugin.rb * Only plugins made by us in `discourse` and `discourse-org` GitHub organizations will show these in the list * Make the plugin author font size a little smaller * Make the commit sha look like a link so it's more obvious it goes to the code Also I added some validation and truncation for plugin metadata parsing since currently you can put absolutely anything in there and it will show on the plugin list.
2023-11-30 08:53:17 +08:00
value = value.join(":")
Allow plugins to specify a minimum `requires version`
2015-04-28 01:06:53 +08:00
attribute = attribute.strip.gsub(/ /, "_").to_sym
refactoring the plugin interfaces to allow for better extensible
2013-08-23 14:21:52 +08:00
FIX: Further improvements for plugin list (#24622) Followup e37fb3042d6f56a27a01614e57bc7029f472b0c9 * Automatically remove the prefix `Discourse ` from all the plugin titles to avoid repetition * Remove the :discourse_dev: icon from the author. Consider a "By Discourse" with no labels as official * We add a `label` metadata to plugin.rb * Only plugins made by us in `discourse` and `discourse-org` GitHub organizations will show these in the list * Make the plugin author font size a little smaller * Make the commit sha look like a link so it's more obvious it goes to the code Also I added some validation and truncation for plugin metadata parsing since currently you can put absolutely anything in there and it will show on the plugin list.
2023-11-30 08:53:17 +08:00
if FIELDS.include?(attribute)
self.public_send(
"#{attribute}=",
value.strip.truncate(MAX_FIELD_LENGTHS[attribute] || 1000),
)
end
refactoring the plugin interfaces to allow for better extensible
2013-08-23 14:21:52 +08:00
end
true
end
end
Reference in New Issue Copy Permalink