refactor: Rename $Deliver into $ for clarity (#177)

BREAKING CHANGE: `Deliver` parameter to various templates is now called `$`
reuixiy · May 26, 2020 · 81a773d · 81a773d
1 parent f160158
commit 81a773d
Show file tree

Hide file tree

Showing 37 changed files with 164 additions and 170 deletions.
diff --git a/assets/js/lunr-search.js b/assets/js/lunr-search.js
@@ -71,7 +71,7 @@ window.addEventListener("DOMContentLoaded", event => {
 
     function initIndex() {
         let request = new XMLHttpRequest();
-        request.open("GET", "{{ partial "utils/relative-url.html" (dict "Deliver" . "filename" (((.Site.GetPage "").OutputFormats.Get "SearchIndex").RelPermalink | strings.TrimPrefix "/")) }}");
+        request.open("GET", "{{ partial "utils/relative-url.html" (dict "$" . "filename" (((.Site.GetPage "").OutputFormats.Get "SearchIndex").RelPermalink | strings.TrimPrefix "/")) }}");
         request.responseType = "json";
         request.addEventListener("load", function(event) {
             let documents = request.response;

diff --git a/layouts/_default/list.html b/layouts/_default/list.html
@@ -70,7 +70,7 @@ <h1 class="list-title">{{ .Title | default .Data.Term | default (delimit (last 1
                             {{ $.Scratch.Set "year" .Key }}
                         {{ end }}
                         {{ $year := $.Scratch.Get "year" }}
-                        <h2 class="list-year">{{ $year }}{{ if $.Site.Params.chineseZodiac }}{{ partial "utils/icon.html" (dict "Deliver" $ "name" $zodiacName "class" "chinese-zodiac") }}{{ end }}</h2>
+                        <h2 class="list-year">{{ $year }}{{ if $.Site.Params.chineseZodiac }}{{ partial "utils/icon.html" (dict "$" $ "name" $zodiacName "class" "chinese-zodiac") }}{{ end }}</h2>
                         {{ if $.Site.Params.groupByMonth }}
                             {{ range .Pages.GroupByDate "January" }}
                                 {{ $.Scratch.Delete "month" }}
@@ -82,10 +82,10 @@ <h2 class="list-year">{{ $year }}{{ if $.Site.Params.chineseZodiac }}{{ partial
                                 {{ end }}
                                 {{ $month := $.Scratch.Get "month" }}
                                 <h3 class="list-month">{{ $month }}</h3>
-                                {{ partial "utils/list-item.html" (dict "Deliver" .) }}
+                                {{ partial "utils/list-item.html" (dict "$" .) }}
                             {{ end }}
                         {{ else }}
-                            {{ partial "utils/list-item.html" (dict "Deliver" .) }}
+                            {{ partial "utils/list-item.html" (dict "$" .) }}
                         {{ end }}
                     {{ end }}
                 </div>

diff --git a/layouts/index.searchindex.json b/layouts/index.searchindex.json
@@ -5,11 +5,11 @@
         {{- end -}}
         {{- $entry := dict "uri" $page.RelPermalink "title" $page.Title "content" ($page.Plain | htmlUnescape) -}}
         {{- if $page.Params.subtitle -}}
-            {{- $subtitle := partial "utils/markdownify.html" (dict "Deliver" $page "raw" $page.Params.subtitle "isContent" false) -}}
+            {{- $subtitle := partial "utils/markdownify.html" (dict "$" $page "raw" $page.Params.subtitle "isContent" false) -}}
             {{- $entry = merge $entry (dict "subtitle" ($subtitle | plainify)) -}}
         {{- end -}}
         {{- if .Site.Params.displayPostDescription -}}
-            {{- $description := partial "utils/markdownify.html" (dict "Deliver" $page "raw" $page.Description "isContent" false) -}}
+            {{- $description := partial "utils/markdownify.html" (dict "$" $page "raw" $page.Description "isContent" false) -}}
             {{- $entry = merge $entry (dict "description" ($description | plainify)) -}}
         {{- end -}}
         {{- if .Site.Params.displayCategory -}}

diff --git a/layouts/index.sectionsatom.xml b/layouts/index.sectionsatom.xml
@@ -55,9 +55,9 @@
                 <rights>{{ . | plainify }}</rights>
             {{- end }}
             {{- $summary := .Description | default (partial "utils/summary.html" $page) -}}
-            <summary type="html">{{ partial "utils/make-links-absolute.html" (dict "Deliver" . "content" $summary) | html }}</summary>
+            <summary type="html">{{ partial "utils/make-links-absolute.html" (dict "$" . "content" $summary) | html }}</summary>
             {{ if $.Site.Params.includeContent }}
-                <content type="html">{{ partial "utils/make-links-absolute.html" (dict "Deliver" . "content" .Content) | html }}</content>
+                <content type="html">{{ partial "utils/make-links-absolute.html" (dict "$" . "content" .Content) | html }}</content>
             {{ end }}
             <!-- Sections -->
             {{ if eq $.Site.Params.categoryBy "sections" }}

diff --git a/layouts/index.sectionsrss.xml b/layouts/index.sectionsrss.xml
@@ -47,10 +47,10 @@
                     <copyright>{{ . | plainify }}</copyright>
                 {{- end }}
                 {{ if $.Site.Params.includeContent }}
-                    <description>{{ partial "utils/make-links-absolute.html" (dict "Deliver" . "content" .Content) | html }}</description>
+                    <description>{{ partial "utils/make-links-absolute.html" (dict "$" . "content" .Content) | html }}</description>
                 {{ else }}
                     {{- $summary := .Description | default (partial "utils/summary.html" $page) -}}
-                    <description>{{ partial "utils/make-links-absolute.html" (dict "Deliver" . "content" $summary) | html }}</description>
+                    <description>{{ partial "utils/make-links-absolute.html" (dict "$" . "content" $summary) | html }}</description>
                 {{ end }}
                 <!-- Sections -->
                 {{ if eq $.Site.Params.categoryBy "sections" }}

diff --git a/layouts/partials/components/back-to-top.html b/layouts/partials/components/back-to-top.html
@@ -1,5 +1,5 @@
 {{ if or (and .IsHome .Site.Params.displayBackToTopInHome) (and (not .IsHome) .Site.Params.enableBackToTop) }}
     <div id="back-to-top" class="back-to-top">
-        <a href="#">{{ partial "utils/icon.html" (dict "Deliver" . "name" .Site.Params.backToTopIcon) }}</a>
+        <a href="#">{{ partial "utils/icon.html" (dict "$" . "name" .Site.Params.backToTopIcon) }}</a>
     </div>
 {{ end }}
diff --git a/layouts/partials/components/dark-mode.html b/layouts/partials/components/dark-mode.html
@@ -2,8 +2,8 @@
     {{- $hide := or (and $.IsHome $.Site.Params.hideThemeToggleInHome) (and (not $.IsHome) $.Site.Params.hideThemeToggle) -}}
     {{- if not $hide -}}
         <a id="theme-switcher" href="#">
-            {{- partial "utils/icon.html" (dict "Deliver" $ "name" "sun" "class" "theme-icon-light") -}}
-            {{- partial "utils/icon.html" (dict "Deliver" $ "name" "moon" "class" "theme-icon-dark") -}}
+            {{- partial "utils/icon.html" (dict "$" $ "name" "sun" "class" "theme-icon-light") -}}
+            {{- partial "utils/icon.html" (dict "$" $ "name" "moon" "class" "theme-icon-dark") -}}
         </a>
     {{- end -}}
 {{- end -}}
diff --git a/layouts/partials/components/minimal-footer-about.html b/layouts/partials/components/minimal-footer-about.html
@@ -7,7 +7,7 @@
                         {{- $linkType := (string .Pre) -}}
                         {{- $iconName := (string .Post) -}}
                         {{- $icon := (index $.Site.Data.SVG $iconName) -}}
-                        <a href="{{ .URL }}"{{ if eq $linkType "external" }} target="_blank" rel="external noopener"{{ end }}>{{ partial "utils/icon.html" (dict "Deliver" $ "name" $iconName "class" .Identifier) }}{{ .Name }}</a>
+                        <a href="{{ .URL }}"{{ if eq $linkType "external" }} target="_blank" rel="external noopener"{{ end }}>{{ partial "utils/icon.html" (dict "$" $ "name" $iconName "class" .Identifier) }}{{ .Name }}</a>
                     {{ end }}
                 </div>
             {{ end }}
@@ -17,7 +17,7 @@
                         {{- $linkType := (string .Pre) -}}
                         {{- $iconName := (string .Post) -}}
                         {{- $icon := (index $.Site.Data.SVG $iconName) -}}
-                        <a href="{{ .URL }}"{{ if eq $linkType "external" }} target="_blank" rel="external noopener"{{ end }}>{{ partial "utils/icon.html" (dict "Deliver" $ "name" $iconName "class" .Identifier) }}{{ .Name }}</a>
+                        <a href="{{ .URL }}"{{ if eq $linkType "external" }} target="_blank" rel="external noopener"{{ end }}>{{ partial "utils/icon.html" (dict "$" $ "name" $iconName "class" .Identifier) }}{{ .Name }}</a>
                     {{ end }}
                 </div>
             {{ end }}

diff --git a/layouts/partials/components/post-copyright.html b/layouts/partials/components/post-copyright.html
@@ -1,4 +1,3 @@
-{{- $Deliver := . -}}
 {{ if and .Site.Params.enablePostCopyright (.Params.displayCopyright | default .Site.Params.displayPostCopyright) }}
     {{ $author := partial "utils/author.html" . }}
     {{ with $author.name }}
@@ -23,7 +22,7 @@
             {{ end }}
             {{ with $author.copyright }}
                 {{- $raw := . -}}
-                <li class="copyright-item license"><span class="copyright-item-text">{{ i18n "copyrightLicense" }}</span>{{ i18n "colon" }}{{ partial "utils/markdownify.html" (dict "Deliver" $Deliver "raw" $raw "isContent" false) }}</li>
+                <li class="copyright-item license"><span class="copyright-item-text">{{ i18n "copyrightLicense" }}</span>{{ i18n "colon" }}{{ partial "utils/markdownify.html" (dict "$" $ "raw" $raw "isContent" false) }}</li>
             {{ end }}
         </ul>
     {{ end }}

diff --git a/layouts/partials/components/post-gitinfo.html b/layouts/partials/components/post-gitinfo.html
@@ -7,19 +7,19 @@
                         <div class="gitinfo-item commit">
                             {{- with .Site.Params.repoURL -}}
                                 <a href="{{ . }}/commit/{{ $.GitInfo.Hash }}" target="_blank" rel="noopener">
-                                    {{- partial "utils/icon.html" (dict "Deliver" $ "name" $.Site.Params.gitIcon "class" "git-icon") -}}
+                                    {{- partial "utils/icon.html" (dict "$" $ "name" $.Site.Params.gitIcon "class" "git-icon") -}}
                                     {{- $.GitInfo.AbbreviatedHash -}}
                                 </a>
                             {{- else -}}
-                                {{- partial "utils/icon.html" (dict "Deliver" $ "name" $.Site.Params.gitIcon "class" "git-icon") -}}
+                                {{- partial "utils/icon.html" (dict "$" $ "name" $.Site.Params.gitIcon "class" "git-icon") -}}
                                 {{- $.GitInfo.AbbreviatedHash -}}
                             {{- end -}}
                         </div>
                     {{ end }}
                     {{ if .Site.Params.displayCommitMessage }}
                         {{ with .GitInfo.Subject }}
                             <div class="gitinfo-item commit-msg">
-                                {{- partial "utils/icon.html" (dict "Deliver" $ "name" $.Site.Params.msgIcon "class" "msg-icon") -}}
+                                {{- partial "utils/icon.html" (dict "$" $ "name" $.Site.Params.msgIcon "class" "msg-icon") -}}
                                 {{- . -}}
                             </div>
                         {{ end }}
@@ -32,7 +32,7 @@
                         {{ with .Site.Params.repoURL }}
                             <div class="gitinfo-item feedback">
                                 <a href="{{ . }}/issues" target="_blank" rel="noopener">
-                                    {{- partial "utils/icon.html" (dict "Deliver" $ "name" $.Site.Params.feedbackIcon "class" "feedback-icon") -}}
+                                    {{- partial "utils/icon.html" (dict "$" $ "name" $.Site.Params.feedbackIcon "class" "feedback-icon") -}}
                                     {{- $.Site.Params.feedbackText -}}
                                 </a>
                             </div>
@@ -43,7 +43,7 @@
                             {{ $contentDir := (cond $.Site.IsMultiLingual (printf `/%s/` $.Site.Params.contentDir) "/content/") }}
                             <div class="gitinfo-item edit">
                                 <a href="{{ . }}{{ $contentDir }}{{ $.Path }}" target="_blank" rel="noopener">
-                                    {{- partial "utils/icon.html" (dict "Deliver" $ "name" $.Site.Params.editIcon "class" "edit-icon") -}}
+                                    {{- partial "utils/icon.html" (dict "$" $ "name" $.Site.Params.editIcon "class" "edit-icon") -}}
                                     {{- $.Site.Params.editText -}}
                                 </a>
                             </div>