From d0c3f3b8fe6905e7e33ae4944cdf44c11ccc0df6 Mon Sep 17 00:00:00 2001 From: Keegan George Date: Thu, 3 Oct 2024 05:41:51 +0900 Subject: [PATCH] DEV: Remove FontAwesome 5 references (#29060) Recently we updated the icon library from Font Awesome `5` to `6.6.0`. Since we were running Font Awesome 5 for a long time while 6 had already been released, we often specified in the codebase with the text _"FontAwesome 5"_. However, now that we are in the latest version, there is no need for our API's/comments to keep specifying for version 5. This PR updates all instances of FontAwesome 5 or FA5 and removes the version number to be the more generic: "FontAwesome" --- .../javascripts/discourse/app/lib/plugin-api.gjs | 10 +++++----- .../app/lib/sidebar/custom-community-section-links.js | 2 +- .../discourse/tests/unit/lib/icon-library-test.js | 4 ++-- config/locales/server.en.yml | 2 +- docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md | 4 ++++ 5 files changed, 13 insertions(+), 9 deletions(-) diff --git a/app/assets/javascripts/discourse/app/lib/plugin-api.gjs b/app/assets/javascripts/discourse/app/lib/plugin-api.gjs index 1cc160fd546..77310b8cdbb 100644 --- a/app/assets/javascripts/discourse/app/lib/plugin-api.gjs +++ b/app/assets/javascripts/discourse/app/lib/plugin-api.gjs @@ -3,7 +3,7 @@ // docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md whenever you change the version // using the format described at https://keepachangelog.com/en/1.0.0/. -export const PLUGIN_API_VERSION = "1.37.1"; +export const PLUGIN_API_VERSION = "1.37.2"; import $ from "jquery"; import { h } from "virtual-dom"; @@ -2646,7 +2646,7 @@ class PluginApi { /** * Changes the lock icon used for a sidebar category section link to indicate that a category is read restricted. * - * @param {String} Name of a FontAwesome 5 icon + * @param {String} Name of a FontAwesome icon */ registerCustomCategorySectionLinkLockIcon(icon) { return registerCustomCategoryLockIcon(icon); @@ -2670,7 +2670,7 @@ class PluginApi { * @param {string} arg.categoryId - The id of the category * @param {string} arg.prefixType - The type of prefix to use. Can be "icon", "image", "text" or "span". * @param {string} arg.prefixValue - The value of the prefix to use. - * For "icon", pass in the name of a FontAwesome 5 icon. + * For "icon", pass in the name of a FontAwesome icon. * For "image", pass in the src of the image. * For "text", pass in the text to display. * For "span", pass in an array containing two hex color values. Example: `[FF0000, 000000]`. @@ -2706,7 +2706,7 @@ class PluginApi { * * @param {Object} arg - An object * @param {string} arg.tagName - The name of the tag - * @param {string} arg.prefixValue - The name of a FontAwesome 5 icon. + * @param {string} arg.prefixValue - The name of a FontAwesome icon. * @param {string} arg.prefixColor - The color represented using hexadecimal to use for the prefix. Example: "#FF0000" or "#FFF". */ registerCustomTagSectionLinkPrefixIcon({ @@ -3002,7 +3002,7 @@ class PluginApi { * return class extends UserMenuTab { * id = "custom-tab-id"; * panelComponent = MyCustomPanelGlimmerComponent; - * icon = "some-fa5-icon"; + * icon = "some-fa-icon"; * * get shouldDisplay() { * return this.siteSettings.enable_custom_tab && this.currentUser.admin; diff --git a/app/assets/javascripts/discourse/app/lib/sidebar/custom-community-section-links.js b/app/assets/javascripts/discourse/app/lib/sidebar/custom-community-section-links.js index 38be61a3f06..40e14006362 100644 --- a/app/assets/javascripts/discourse/app/lib/sidebar/custom-community-section-links.js +++ b/app/assets/javascripts/discourse/app/lib/sidebar/custom-community-section-links.js @@ -16,7 +16,7 @@ export let secondaryCustomSectionLinks = []; * @param {string} [args.route] - The Ember route name to generate the href attribute for the link. * @param {string} [args.href] - The href attribute for the link. * @param {string} [args.title] - The title attribute for the link. - * @param {string} [args.icon] - The FontAwesome 5 icon to display for the link. + * @param {string} [args.icon] - The FontAwesome icon to display for the link. * @param {Boolean} [secondary] - Determines whether the section link should be added to the main or secondary section in the "More..." links drawer. */ export function addSectionLink(args, secondary) { diff --git a/app/assets/javascripts/discourse/tests/unit/lib/icon-library-test.js b/app/assets/javascripts/discourse/tests/unit/lib/icon-library-test.js index e869b8fd0f2..006dfbced34 100644 --- a/app/assets/javascripts/discourse/tests/unit/lib/icon-library-test.js +++ b/app/assets/javascripts/discourse/tests/unit/lib/icon-library-test.js @@ -22,8 +22,8 @@ module("Unit | Utility | icon-library", function (hooks) { }); test("convert icon names", function (assert) { - const fa5Icon = convertIconClass("fab fa-facebook"); - assert.ok(iconHTML(fa5Icon).includes("fab-facebook"), "FA 5 syntax"); + const faIcon = convertIconClass("fab fa-facebook"); + assert.ok(iconHTML(faIcon).includes("fab-facebook"), "FA syntax"); const iconC = convertIconClass(" fab fa-facebook "); assert.ok(!iconHTML(iconC).includes(" "), "trims whitespace"); diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml index 94c3b9280ee..2b4c8487639 100644 --- a/config/locales/server.en.yml +++ b/config/locales/server.en.yml @@ -2484,7 +2484,7 @@ en: auto_handle_queued_age: "Automatically handle records that are waiting to be reviewed after this many days. Flags will be ignored. Queued posts and users will be rejected. Set to 0 to disable this feature." penalty_step_hours: "Default penalties for silencing or suspending users in hours. First offense defaults to the first value, second offense defaults to the second value, etc." penalty_include_post_message: "Automatically include offending post message in email message template when silencing or suspending a user" - svg_icon_subset: "Add additional FontAwesome 5 icons that you would like to include in your assets. Use prefix 'fa-' for solid icons, 'far-' for regular icons and 'fab-' for brand icons." + svg_icon_subset: "Add additional FontAwesome icons that you would like to include in your assets. Use prefix 'fa-' for solid icons, 'far-' for regular icons and 'fab-' for brand icons." max_prints_per_hour_per_user: "Maximum number of /print page impressions (set to 0 to disable printing)" full_name_required: "Full name is a required field of a user's profile." diff --git a/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md b/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md index 08d1b943cc2..b895a5cc099 100644 --- a/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md +++ b/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md @@ -7,6 +7,10 @@ in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.37.2] - 2024-10-02 + +- Fixed comments and text references to Font Awesome 5 in favor of the more generic Font Awesome due to core now having the latest version and no longer needing to specify version 5. + ## [1.37.1] - 2024-08-21 - Added support for `shortcut` in `addComposerToolbarPopupMenuOption` which allows to add a keyboard shortcut to the popup menu option.