Merge pull request #2 from theNewDynamic/1-cms-version-config

NetlifyCMS version settings
theNewDynamic · Jun 1, 2020 · 2fc0737 · 2fc0737
2 parents 42f6c76 + e300ab8
commit 2fc0737
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -86,6 +86,13 @@ name: "title"
 widget: "string"
 ```
 
+## Module Settings
+
+Module settings are set as part of the shared `data/netlifycms/config.yaml` file under the reserved `tnd_netlifycms` map key.
+
+Available settings are:
+ - cms_version (default: `^2.0.0`): Semantic versioning string to be used when calling CDN endpoint.
+
 ## Scripts
 
 The module faciliate the addiont of extra Netlify CMS scripts for WidgetPreviews, CollectionPreviews etc...

diff --git a/func/private/GetCMSVersion.html b/func/private/GetCMSVersion.html
@@ -0,0 +1,27 @@
+{{/*
+  GetCMSVersion retrieves the version as set in the tnd_netlifycms settings.
+
+  @author @regisphilibert
+
+  @context Any (.)
+
+  @access public
+
+  @return String (default: ^2.0.0)
+
+  @example - Go Template
+    {{ partial "path" context }}
+    {{ partialCached "path" context "variant" }}
+*/}}
+
+{{/* Default is `^2.0.0` for now */}}
+{{ $version := `^2.0.0` }}
+
+{{ with partialCached "tnd-netlifycms/private/GetModuleConfig" . "tnd-netlifycms/private/GetModuleConfig" }}
+  {{ with .cms_version }}
+    {{ $version = . }}
+  {{ end }}
+{{ end }}
+
+
+{{ return $version }}
diff --git a/func/private/GetModuleConfig.html b/func/private/GetModuleConfig.html
@@ -0,0 +1,24 @@
+{{/*
+  GetModuleConfig returns the config as set in data/netlifycms/config.yaml's tnd_netlifycms map.
+
+  @author @regisphilibert
+
+  @context Any
+
+  @return Map
+
+  @access private
+
+  @example - Go Template
+    {{ with partial "tnd-netlifycms/private/GetModuleConfig" . }}
+      {{ $config = . }}
+    {{ end }}
+*/}}
+{{ $return := dict }}
+{{ with site.Data.netlifycms.config }}
+  {{ with .tnd_netlifycms }}
+    {{ $return = . }}
+  {{ end }}
+{{ end }}
+
+{{ return $return }}
diff --git a/templates/single.html.html b/templates/single.html.html
@@ -9,7 +9,11 @@
   </head>
   <body>
     <!-- Include the script that builds the page and powers Netlify CMS -->
-    <script src="https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js"></script>
+    {{- $version := partialCached "tnd-netlifycms/private/GetCMSVersion" . "tnd-netlifycms/private//GetCMSVersion" -}}
+    {{/* Hugo keeps escaping the `^` character potentially used to specify CMS version (`^2.0.0`) in spite of
+      safeHTML, safeHTMLAttr and the like. Passing the whole tag through `printf` fixes it... */}}
+    {{- $cdn := printf `<script src="https://unpkg.com/netlify-cms@%s/dist/netlify-cms.js"></script>` $version -}}
+    {{ $cdn | safeHTML }}
     {{ partial "tnd-netlifycms/scripts.html" . }}
   </body>
 </html>