chore: add a deprecated warning message for preview_styles parameter

hugomods · Dec 3, 2023 · cde1a18 · cde1a18
1 parent 64cba79
commit cde1a18
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/assets/decap-cms/init.js.tmpl b/assets/decap-cms/init.js.tmpl
@@ -2,6 +2,10 @@
 {{- $css := resources.Get "decap-cms/scss/index.scss" }}
 {{- $css = $css | toCSS (dict "targetPath" "css/decap-cms.css" "outputStyle" (cond hugo.IsProduction "compressed" "")) }}
 {{- printf `CMS.registerPreviewStyle("%s");` $css.Permalink }}
+{{/* TODO: remove preview_styles in future versions. */}}
+{{- if isset site.Params.decap_cms "preview_styles" }}
+  {{- warnf `[decap-cms] the "preview_styles" is deprecated, rename it to "_preview_styles" instead.` }}
+{{- end }}
 {{- range default slice (default site.Params.decap_cms._preview_styles site.Params.decap_cms.preview_styles) }}
   {{- printf `CMS.registerPreviewStyle("%s");` (absURL .) }}
 {{- end }}