Move tributejs to new workflow

client/package.json

@@ -8,7 +8,8 @@
   },
   "dependencies": {
     "@sentry/browser": "8.33.1",
-    "jquery": "3.7.1"
+    "jquery": "3.7.1",
+    "tributejs": "5.1.3"
   },
   "devDependencies": {
     "terser-webpack-plugin": "5.3.10",

client/src/tribute.js

@@ -0,0 +1,7 @@
+// Copyright © Michal Čihař <[email protected]>
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+import Tribute from "tributejs";
+
+window.Tribute = Tribute;

client/webpack.config.js

@@ -33,18 +33,25 @@ SPDX-License-Identifier: ${licenses}
 `;
 }
 // REUSE-IgnoreEnd
-
 function mainLicenseTransform(packages) {
-  return genericTransform(packages, (pkg) => !pkg.name.startsWith("@sentry"));
+  const excludePrefixes = ["@sentry", "tributejs"];
+  return genericTransform(
+    packages,
+    (pkg) => !excludePrefixes.some((prefix) => pkg.name.startsWith(prefix)),
+  );
 }
 function sentryLicenseTransform(packages) {
   return genericTransform(packages, (pkg) => pkg.name.startsWith("@sentry"));
 }
+function tributeLicenseTransform(packages) {
+  return genericTransform(packages, (pkg) => pkg.name.startsWith("tributejs"));
+}
 
 module.exports = {
   entry: {
     main: "./src/main.js",
     sentry: "./src/sentry.js",
+    tribute: "./src/tribute.js",
   },
   mode: "production",
   optimization: {
@@ -65,6 +72,7 @@ module.exports = {
       additionalFiles: {
         "main.js.license": mainLicenseTransform,
         "sentry.js.license": sentryLicenseTransform,
+        "tribute.js.license": tributeLicenseTransform,
       },
     }),
   ],

client/yarn.lock

@@ -819,6 +819,11 @@ terser@^5.26.0:
     commander "^2.20.0"
     source-map-support "~0.5.20"
 
+tributejs@^5.1.3:
+  version "5.1.3"
+  resolved "https://registry.yarnpkg.com/tributejs/-/tributejs-5.1.3.tgz#980600fc72865be5868893078b4bfde721129eae"
+  integrity sha512-B5CXihaVzXw+1UHhNFyAwUTMDk1EfoLP5Tj1VhD9yybZ1I8DZJEv8tZ1l0RJo0t0tk9ZhR8eG5tEsaCvRigmdQ==
+
 undici-types@~6.19.2:
   version "6.19.8"
   resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.19.8.tgz#35111c9d1437ab83a7cdc0abae2f26d88eda0a02"

docs/contributing/frontend.rst

@@ -52,9 +52,12 @@ Then, there are two ways to import the library:
 
 2. If it is page-specific library (library is used in a specific page or template):
     - Create a new file named ``src/<lib-name>.js``.
-    - Import the library in it.
+    - Import the library in it. Then inject it into the ``window`` object to be globally accessible.
     - Add an entry in ``webpack.config.js``:
       ``<lib-name>: "src/<lib-name>.js"``.
+    - Add library name in ``excludePrefixes`` array in ``mainLicenseTransform`` in ``webpack.config.js``.
+    - Add license file name in ``additionalFiles`` in ``LicensePlugin`` in ``plugins`` array in ``webpack.config.js``.
+    - Create a ``<lib-name>LicenseTransfrom`` function for the license file introduced in the previous steps and use it.
 
    Note: Replace ``<lib-name>`` with the actual name of the 3rd party library.
 

scripts/yarn-update

@@ -20,9 +20,6 @@ cp node_modules/mousetrap/mousetrap.js ../../weblate/static/vendor/
 # Mousetrap global bind
 cp node_modules/mousetrap-global-bind/mousetrap-global-bind.js ../../weblate/static/vendor/
 
-# Tribute
-cp node_modules/tributejs/dist/tribute.js ../../weblate/static/vendor/
-
 # Prismjs
 cp node_modules/prismjs/components/prism-core.js ../../weblate/static/vendor/prism/
 cp node_modules/prismjs/components/prism-markup.js ../../weblate/static/vendor/prism/

scripts/yarn/package.json

@@ -13,7 +13,6 @@
     "prismjs": "1.29.0",
     "slugify": "1.6.6",
     "source-code-pro": "2.38.0",
-    "source-sans": "3.46.0",
-    "tributejs": "5.1.3"
+    "source-sans": "3.46.0"
   }
 }

scripts/yarn/yarn.lock

@@ -64,8 +64,3 @@ [email protected]:
   version "3.46.0"
   resolved "https://registry.yarnpkg.com/source-sans/-/source-sans-3.46.0.tgz#6af0a47ead682fa8971f0c83e9692e75ef3cbb86"
   integrity sha512-bVC2YX4VNiv5vMcy77dL0XKsNp794ThfynNsr+FqSAwk8TGG0pZsg7eUQi6yHwaRBMVmZ3Aaf4FY46dxIIGgsg==
-
-[email protected]:
-  version "5.1.3"
-  resolved "https://registry.yarnpkg.com/tributejs/-/tributejs-5.1.3.tgz#980600fc72865be5868893078b4bfde721129eae"
-  integrity sha512-B5CXihaVzXw+1UHhNFyAwUTMDk1EfoLP5Tj1VhD9yybZ1I8DZJEv8tZ1l0RJo0t0tk9ZhR8eG5tEsaCvRigmdQ==

weblate/static/js/vendor/tribute.js.license

@@ -0,0 +1,3 @@
+Copyright (c) 2017-2020 ZURB, Inc.
+
+SPDX-License-Identifier: MIT