Merge pull request #1065 from gethinode/develop

Support localization of script bundles

config/_default/hugo.toml

@@ -125,7 +125,7 @@ home = ["HTML", "RSS", "REDIR"]
   [[module.imports]]
     path = "github.com/gethinode/mod-bootstrap"
   [[module.imports]]
-    path = "github.com/gethinode/mod-flexsearch"
+    path = "github.com/gethinode/mod-flexsearch/v2"
   [[module.imports]]
     path = "github.com/gethinode/mod-fontawesome"
   [[module.imports]]

data/structures/scripts.yml

@@ -0,0 +1,69 @@
+comment: >-
+  Bundles a JavaScript file for client-side processing. Scripts can be included
+  as critical, core, or optional file.
+arguments:
+  page:
+    type:
+      - '*hugolib.pageState'
+      - '*hugolib.pageForShortcode'
+    optional: false
+    comment: Context of the current page.
+  core:
+    type: bool
+    default: false
+    optional: true
+    comment: >-
+      Trigger to include all core files in the script bundle. Core bundles are
+      loaded asynchronously in each page of the site.
+  filename:
+    type: string
+    default: js/main.bundle.js
+    optional: true
+    comment: >-
+      Path of the target bundle file, relative to the site root.
+  match:
+    type: string
+    default: {js/*.js,js/vendor/**.js}
+    optional: true
+    comment: >-
+      Regular expression that defines the pattern of source files to be included
+      in the bundle. The pattern is relative to the project's `asset` folder.
+  header:
+    type: bool
+    default: false
+    comment: >-
+      Trigger to consider the script as loaded in the page header. When enabled,
+      it includes a script to load Google Analytics adjacent to any bundle
+      input.
+  localize:
+    type: bool
+    default: false
+    optional: true
+    comment: >-
+      Triggers the creation of a language-specific bundle file. The language
+      code is appended as suffix to the base name. For example, the English
+      version of `js/main.bundle.js` becomes `js/main.bundle.en.js`.
+  skipTemplate:
+    type: bool
+    default: false
+    optional: true
+    comment: >-
+      Script source input can contain Go Template magic. As such, Hinode
+      processes all input files with `resources.ExecuteAsTemplate`. However,
+      certain input files may be incompatible. Set `skipTemplate` to true to
+      skip template processing.
+  state:
+    type: select
+    optional: true
+    default: async
+    comment: >-
+      Defines the loading behavior of the script bundle. By default, scripts are
+      processed in the background and loaded when ready (`async`). Set the state
+      to `immediate` to load the script immediately (such as critical scripts).
+      Use 'defer' to load the script in relative order when the DOM is fully
+      built.
+    options:
+      values:
+        - async
+        - defer
+        - immediate

go.mod

@@ -4,14 +4,14 @@ go 1.19
 
 require (
 	github.com/airbnb/lottie-web v5.12.2+incompatible // indirect
-	github.com/gethinode/mod-bootstrap v1.3.0 // indirect
-	github.com/gethinode/mod-flexsearch v1.12.0 // indirect
-	github.com/gethinode/mod-fontawesome v1.9.0 // indirect
-	github.com/gethinode/mod-katex v1.1.0 // indirect
-	github.com/gethinode/mod-leaflet v1.1.0 // indirect
-	github.com/gethinode/mod-lottie v1.5.5 // indirect
-	github.com/gethinode/mod-simple-datatables v1.0.3 // indirect
+	github.com/gethinode/mod-bootstrap v1.3.1 // indirect
+	github.com/gethinode/mod-flexsearch/v2 v2.0.1 // indirect
+	github.com/gethinode/mod-fontawesome v1.9.1 // indirect
+	github.com/gethinode/mod-katex v1.1.1 // indirect
+	github.com/gethinode/mod-leaflet v1.1.1 // indirect
+	github.com/gethinode/mod-lottie v1.5.6 // indirect
+	github.com/gethinode/mod-simple-datatables v1.0.5 // indirect
 	github.com/gethinode/mod-utils/v2 v2.3.10 // indirect
-	github.com/nextapps-de/flexsearch v0.0.0-20240110101704-4c3966709f85 // indirect
+	github.com/nextapps-de/flexsearch v0.0.0-20240501124520-961c3ae84a87 // indirect
 	github.com/twbs/bootstrap v5.3.3+incompatible // indirect
 )

go.sum

@@ -22,6 +22,8 @@ github.com/gethinode/mod-bootstrap v1.2.8 h1:kIKSO6qqE8xA0KQC5s6kkEv5UDc8oT17Hal
 github.com/gethinode/mod-bootstrap v1.2.8/go.mod h1:CL9IDot6nbXIWJYE/KxfsTdYYEJIGL17BXbAYPn+wVQ=
 github.com/gethinode/mod-bootstrap v1.3.0 h1:UxNmXgXo7gA8C8z1ar47+tSccmKYpaYBBN+txB0pwBk=
 github.com/gethinode/mod-bootstrap v1.3.0/go.mod h1:CL9IDot6nbXIWJYE/KxfsTdYYEJIGL17BXbAYPn+wVQ=
+github.com/gethinode/mod-bootstrap v1.3.1 h1:ZUX72St0WZ5tyXpEPBJlayX/dmCH3cGErzsozkUKCok=
+github.com/gethinode/mod-bootstrap v1.3.1/go.mod h1:CL9IDot6nbXIWJYE/KxfsTdYYEJIGL17BXbAYPn+wVQ=
 github.com/gethinode/mod-flexsearch v1.0.1 h1:FJkRsUzSnQTXl3MWCigT4E6vfff870UWTnkGqaDGIhA=
 github.com/gethinode/mod-flexsearch v1.0.1/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
 github.com/gethinode/mod-flexsearch v1.1.0 h1:7BCMyQDlYlskNXuazt8Jg/jg9WREexu2xVkYqThkAX4=
@@ -68,6 +70,10 @@ github.com/gethinode/mod-flexsearch v1.11.3 h1:ykxpUg8M4vr1C4QzxJOPGt+1ZmPAD/gOC
 github.com/gethinode/mod-flexsearch v1.11.3/go.mod h1:L8hrnpupx27cez2ObMX8gWnhbW6qss4HGH1Ea4UaBRQ=
 github.com/gethinode/mod-flexsearch v1.12.0 h1:zg1IHvc8VO9WEtQuQnuG6HeWFNByvyqC9JYWDtpsP6s=
 github.com/gethinode/mod-flexsearch v1.12.0/go.mod h1:L8hrnpupx27cez2ObMX8gWnhbW6qss4HGH1Ea4UaBRQ=
+github.com/gethinode/mod-flexsearch v1.12.1 h1:clkGUWaNPe9Dt/66Apy7oH9NwVQfnD6OpGSLffeC9sY=
+github.com/gethinode/mod-flexsearch v1.12.1/go.mod h1:L8hrnpupx27cez2ObMX8gWnhbW6qss4HGH1Ea4UaBRQ=
+github.com/gethinode/mod-flexsearch/v2 v2.0.1 h1:5unGUSb1tX1LBtKygnLfdt7CnVJuFKSt6VXiKRxdojc=
+github.com/gethinode/mod-flexsearch/v2 v2.0.1/go.mod h1:d7MMkVlz0l6cEk76e0mkveEsDxGfu5Sv+HUIhoGguhE=
 github.com/gethinode/mod-fontawesome v1.0.2 h1:ZSK6D20/w4y5GnfYfTBB58uHD0ChIfkpKfRGwioS9rg=
 github.com/gethinode/mod-fontawesome v1.0.2/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-fontawesome v1.1.0 h1:rsDzUI+3ZlS/do2ff3ne8/z3KwHeysmuA+WsXlumXXk=
@@ -108,6 +114,8 @@ github.com/gethinode/mod-fontawesome v1.8.2 h1:LAzLytyh9c9gLzBWMju6Gtp3uEojhBQEY
 github.com/gethinode/mod-fontawesome v1.8.2/go.mod h1:xBKsZH3WJtMOItZVlp9SbO51uaBy6IbvUZSKpNu3b6Y=
 github.com/gethinode/mod-fontawesome v1.9.0 h1:xqUB8AnezMHAt8lye4ksqvmHSVPCOkiHsHGUbqNoeP0=
 github.com/gethinode/mod-fontawesome v1.9.0/go.mod h1:xBKsZH3WJtMOItZVlp9SbO51uaBy6IbvUZSKpNu3b6Y=
+github.com/gethinode/mod-fontawesome v1.9.1 h1:cQk84vriqffM4fuUUoM9j3SSD+3ppeW2j4ta7AiToMU=
+github.com/gethinode/mod-fontawesome v1.9.1/go.mod h1:xBKsZH3WJtMOItZVlp9SbO51uaBy6IbvUZSKpNu3b6Y=
 github.com/gethinode/mod-katex v1.0.0 h1:me/3dIIZBkfk1mRIFt8QiAGYwYDoSG5bc2hHRtIutFc=
 github.com/gethinode/mod-katex v1.0.0/go.mod h1:byAfpI3wuqNJIooTGVEGc1cjBhhCy4+CcK1H6495MYg=
 github.com/gethinode/mod-katex v1.0.1 h1:809QUztxmKgMNchU+v03iMO7Ma+ISc3ZzhXYauc21rs=
@@ -128,6 +136,8 @@ github.com/gethinode/mod-katex v1.0.9 h1:cCJoR28tZwkDvXps17o9Jwfe3aQQAZ3Rxk0jCNR
 github.com/gethinode/mod-katex v1.0.9/go.mod h1:byAfpI3wuqNJIooTGVEGc1cjBhhCy4+CcK1H6495MYg=
 github.com/gethinode/mod-katex v1.1.0 h1:PxST3HPUt6F2X/xKakTVeTkwWqCtEr53K1vYEOyQu3I=
 github.com/gethinode/mod-katex v1.1.0/go.mod h1:byAfpI3wuqNJIooTGVEGc1cjBhhCy4+CcK1H6495MYg=
+github.com/gethinode/mod-katex v1.1.1 h1:z8+mfVI6UTWcfpQMVPIzxQzt6Lp9BcmXxSOILQ84qFg=
+github.com/gethinode/mod-katex v1.1.1/go.mod h1:byAfpI3wuqNJIooTGVEGc1cjBhhCy4+CcK1H6495MYg=
 github.com/gethinode/mod-leaflet v0.2.3 h1:QQI4h+IH0jZ7fx4q0um2YIEiYBoW3OAfW8qHzbRCDPk=
 github.com/gethinode/mod-leaflet v0.2.3/go.mod h1:uGggt87x4Fw7wBoJpSiUvNkYg+s/Ujne7klAX2rxMRk=
 github.com/gethinode/mod-leaflet v0.3.1 h1:H5MaOa+BB1KuVw7abTqfIn/SNzzRsAyx/WQoSe+2Ykc=
@@ -146,6 +156,8 @@ github.com/gethinode/mod-leaflet v1.0.1 h1:L4Coe6HTD9O0Txs1S8AtVg+6/TEneSF9i6fJK
 github.com/gethinode/mod-leaflet v1.0.1/go.mod h1:Ei0x9WiL7Dbi4JeG6yI1CE63bT1QJ8sKi67Jea1wFSE=
 github.com/gethinode/mod-leaflet v1.1.0 h1:FXzPCic5XmUluxQ6e7LYUhhLnxuQOBwry8qjG9k30UY=
 github.com/gethinode/mod-leaflet v1.1.0/go.mod h1:Ei0x9WiL7Dbi4JeG6yI1CE63bT1QJ8sKi67Jea1wFSE=
+github.com/gethinode/mod-leaflet v1.1.1 h1:AIHR4k8SjmeoZxtjLgSS6/N3jKeZNZGdZTgu/7MwP4c=
+github.com/gethinode/mod-leaflet v1.1.1/go.mod h1:Ei0x9WiL7Dbi4JeG6yI1CE63bT1QJ8sKi67Jea1wFSE=
 github.com/gethinode/mod-lottie v1.0.0 h1:1CUZMcgN5FAyjjyuP3qkaOQ6M5sv6HUAbosW4sIT5VE=
 github.com/gethinode/mod-lottie v1.0.0/go.mod h1:erRCgSL2FCfKHI0jQbSpM+g0jXl7SjKVJrh7kWGteKs=
 github.com/gethinode/mod-lottie v1.0.1 h1:+IE7xtnSVQpJS56oBJq9RWKZeFEfxrOZAqE3BSrS/u0=
@@ -184,12 +196,16 @@ github.com/gethinode/mod-lottie v1.5.4 h1:+xbamSsjcnP2tyzGl0CA1enma7gkAp67wenmuP
 github.com/gethinode/mod-lottie v1.5.4/go.mod h1:gALqz48aYpoDLxJOI3LzIpdy0Eq/lOBNtlcOxABa9tg=
 github.com/gethinode/mod-lottie v1.5.5 h1:uEJKsz+ovsZtbGkMhPONcIhtG6M3RjYiK+iVoScLOVo=
 github.com/gethinode/mod-lottie v1.5.5/go.mod h1:VTvBxD8VokICwnEqM0VUZFZHBYxLf4/grDFQyEh1DL0=
+github.com/gethinode/mod-lottie v1.5.6 h1:dxz5nmD0XXEt/DAOc1s5fIPynj5bhzDL32EEwLFCSmk=
+github.com/gethinode/mod-lottie v1.5.6/go.mod h1:VTvBxD8VokICwnEqM0VUZFZHBYxLf4/grDFQyEh1DL0=
 github.com/gethinode/mod-simple-datatables v1.0.0 h1:Dj4WGw12OkaimwkCpLn5Jhmd49dvNJW9O2P/W9F+HlQ=
 github.com/gethinode/mod-simple-datatables v1.0.0/go.mod h1:K8T7fIdb8pMOB+OSW4A5lz5IW99+HyzcTgx764fvOGw=
 github.com/gethinode/mod-simple-datatables v1.0.2 h1:zhqxHet3iLQWYCBbGROALpOY9zQlptMycFkz1Tto5bA=
 github.com/gethinode/mod-simple-datatables v1.0.2/go.mod h1:mmrcvAJU2i3SMU56VmQ5PW43uDXBcsJKcZwCHrvl3Kc=
 github.com/gethinode/mod-simple-datatables v1.0.3 h1:JL2nBlEHWMmkE7EZrpfpmzka47dklJUh23/xKJkOQoI=
 github.com/gethinode/mod-simple-datatables v1.0.3/go.mod h1:mmrcvAJU2i3SMU56VmQ5PW43uDXBcsJKcZwCHrvl3Kc=
+github.com/gethinode/mod-simple-datatables v1.0.5 h1:2Aa4k1Bd1WEYHbskFQj+1X35BB7abB8RXHE7Uk2N4pg=
+github.com/gethinode/mod-simple-datatables v1.0.5/go.mod h1:mmrcvAJU2i3SMU56VmQ5PW43uDXBcsJKcZwCHrvl3Kc=
 github.com/gethinode/mod-utils v1.0.0 h1:cqHm2xS5uDiJzRm1KfHaNbq6uMVDKLhQa8/BuTZ1nhY=
 github.com/gethinode/mod-utils v1.0.0/go.mod h1:ONJm3pHCq7nvaPNjusLZNCeCbhOhSBH4HVKHwK1FdYE=
 github.com/gethinode/mod-utils v1.0.1 h1:jhZGlGFHHL1f5HXbBMXfiZ2gCz4TVafAzjnRPTIBSEE=
@@ -242,6 +258,8 @@ github.com/nextapps-de/flexsearch v0.0.0-20240108021025-afd75f742f22 h1:re7L8Fxb
 github.com/nextapps-de/flexsearch v0.0.0-20240108021025-afd75f742f22/go.mod h1:5GdMfPAXzbA2gXBqTjC6l27kioSYzHlqDMh0+wyx7sU=
 github.com/nextapps-de/flexsearch v0.0.0-20240110101704-4c3966709f85 h1:H6xa5YyCHr78M+qqCApM4Kvz/eMA7pfGskYmfkEBRCA=
 github.com/nextapps-de/flexsearch v0.0.0-20240110101704-4c3966709f85/go.mod h1:5GdMfPAXzbA2gXBqTjC6l27kioSYzHlqDMh0+wyx7sU=
+github.com/nextapps-de/flexsearch v0.0.0-20240501124520-961c3ae84a87 h1:6PNbL0/LxO8Xl8MZSe5uvCidYNpFTz9nlWTqj2qdlzA=
+github.com/nextapps-de/flexsearch v0.0.0-20240501124520-961c3ae84a87/go.mod h1:5GdMfPAXzbA2gXBqTjC6l27kioSYzHlqDMh0+wyx7sU=
 github.com/twbs/bootstrap v5.3.2+incompatible h1:tuiO5acc6xnZUR77Sbi5aKWXxjYxbmsSbJwYrhAKoQQ=
 github.com/twbs/bootstrap v5.3.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
 github.com/twbs/bootstrap v5.3.3+incompatible h1:goFoqinzdHfkeegpFP7pvhbd0g+A3O2hbU3XCjuNrEQ=

layouts/partials/footer/optional-scripts.html

@@ -27,5 +27,20 @@
         {{- with index . "state" }}{{ $state = . }}{{ end -}}
     {{- end -}}
 
-    {{- partial "footer/scripts.html" (dict "filename" $filename "match" $match "header" false "skipTemplate" $skipTemplate "state" $state "page" .) }}
+    {{ $localize := false }}
+    {{- if reflect.IsSlice $config.localize -}}
+        {{- if in $config.localize $mod}}
+            {{- $localize = true -}}
+        {{- end -}}
+    {{- end -}}
+
+    {{- partial "footer/scripts.html" (dict 
+        "filename" $filename
+        "match" $match
+        "header" false
+        "skipTemplate" $skipTemplate
+        "state" $state
+        "localize" $localize
+        "page" page
+    ) }}
 {{- end -}}

layouts/partials/footer/scripts.html

@@ -1,3 +1,18 @@
+<!-- 
+    Copyright © 2024 The Hinode Team / Mark Dumay. All rights reserved.
+    Use of this source code is governed by The MIT License (MIT) that can be found in the LICENSE file.
+    Visit gethinode.com/license for more details.
+-->
+
+{{ $error := false }}
+
+<!-- Validate arguments -->
+{{ if partial "utilities/IsInvalidArgs.html" (dict "structure" "scripts" "args" . "group" "partial") }}
+    {{- errorf "partial [footer/scripts.html] - Invalid arguments" -}}
+    {{ $error = true }}
+{{ end }}
+
+<!-- Initialize arguments -->
 {{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
 {{- $filename := .filename | default "js/main.bundle.js" -}}
 {{- $match := .match | default "{js/*.js,js/vendor/**.js}" -}}
@@ -5,16 +20,12 @@
 {{- $header := .header -}}
 {{- $core := .core | default false -}}
 {{- $skipTemplate := .skipTemplate | default false -}}
+{{- $localize := .localize | default false }}
 
-{{- $state := "async" -}}
-{{- with .state }}{{ $state = . }}{{ end -}}
+{{- $state := .state | default "async" -}}
 {{- if or $header (eq $state "immediate") }}{{ $state = "" }}{{ end -}}
-{{- $supportedStates := slice "defer" "async" "immediate" -}}
-{{- if and $state (not (in $supportedStates $state)) -}}
-    {{- errorf "partial [footer/script.html] - Invalid value for param 'processing': %s" $state -}}
-{{- end -}}
 
-{{ $config := page.Scratch.Get "modules" }}
+{{ $config := $page.Scratch.Get "modules" }}
 {{ if not $config }}
     {{ errorf "partial [footer/scripts.html] - Cannot initialize module configuration" }}
 {{ end }}
@@ -22,9 +33,28 @@
 {{- $modules := "" -}}
 {{ if $core }}
     {{- $modules = $config.core -}}
+    {{- if reflect.IsSlice $config.localize -}}
+        {{- range $index, $mod := $modules -}}            
+            {{- if in $config.localize $mod}}
+                {{- $localize = true -}}
+            {{- end -}}
+        {{- end -}}
+    {{- end -}}
 {{- end -}}
 
-{{- $bundle := partial "utilities/bundle" (dict "match" $match "filename" $filename "modules" $modules "basepath" "js/modules" "all" true "debugging" site.Params.debugging.showJS) -}}
+{{ if $localize }}
+    {{ $filename = path.Join (path.Dir $filename) (printf "%s.%s%s" (path.BaseName $filename) $page.Language.Lang (path.Ext $filename)) }}
+{{ end }}
+
+<!-- Main code -->
+{{- $bundle := partial "utilities/bundle" (dict
+    "match" $match
+    "filename" $filename
+    "modules" $modules
+    "basepath" "js/modules"
+    "all" true
+    "debugging" site.Params.debugging.showJS
+) -}}
 {{- $js := $bundle -}}
 {{- if not $skipTemplate -}}
     {{- $js = $bundle | resources.ExecuteAsTemplate $filename $page -}}

layouts/partials/utilities/InitModules.html

@@ -4,6 +4,7 @@
 {{ $optional := slice }}
 {{ $excludeSCSS := slice }}
 {{ $disableTemplate := slice }}
+{{ $localize := slice }}
 {{ $modules := dict }}
 
 {{ range $key, $mod := $page.Site.Params.modules }}
@@ -37,13 +38,24 @@
             {{ $disableTemplate = $disableTemplate | append $key }}
         {{ end }}
 
+        {{ if eq (index $mod "localize") true }}
+            {{ $localize = $localize | append $key }}
+        {{ end }}
+
         {{ $modules = merge $modules (dict $key $mod) }}
     {{ else }}
         {{ warnf "Unsupported module parameter: %s" $key }}
     {{ end }}
 {{ end }}
 
-{{ $modules := dict "modules" $modules "core" $core "optional" $optional "excludeSCSS" $excludeSCSS "disableTemplate" $disableTemplate }}
+{{ $modules := dict 
+    "modules" $modules
+    "core" $core
+    "optional" $optional
+    "excludeSCSS" $excludeSCSS
+    "disableTemplate" $disableTemplate
+    "localize" $localize
+}}
 
 {{- if and $page.IsPage (not (in $core "bootstrap")) -}}
     {{- errorf "Bootstrap is a required module, please add it to 'modules.core' in your site parameters" -}}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.24.24",
+  "version": "0.25.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@gethinode/hinode",
-      "version": "0.24.24",
+      "version": "0.25.0",
       "license": "MIT",
       "dependencies": {
         "@fullhuman/postcss-purgecss": "^6.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.24.24",
+  "version": "0.25.0",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",