]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
projects / brevno-suite / hugo / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 7fb2808)
livereload: Inject script without head or body tag
authorsatotake <doublequotation@gmail.com>
Sun, 7 Aug 2022 14:15:28 +0000 (23:15 +0900)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sun, 7 Aug 2022 16:34:01 +0000 (18:34 +0200)
Currently, Hugo does not inject `livereload` script if html does not contain `<head>` or `<body>`. This sometimes happens if you create new sites without `theme` and it is hard to catch the cause soon.

This PR:

* Inject livereload script even if html does not include `<head>`, `<body>`, or `<html>`
    - Modern browsers execute scripts even if they are outside `<html>`
    - Some js frameworks (confirmed with vite) inject HRM script without `<html>` tag
* Append warning script to html if `<head>` or `<body>` is not in html
* Fix bug that livereload cannot be appended to the tags with attrs

Close #10105

transform/livereloadinject/livereloadinject.go patch | blob | history
transform/livereloadinject/livereloadinject_test.go patch | blob | history

diff --git a/transform/livereloadinject/livereloadinject.go b/transform/livereloadinject/livereloadinject.go
index 32ed55f63ae0ffb6380215e393f743cd05cc8dda..d57ba4d244dae662042cab26b0ee117ff477c5d3 100644 (file)
--- a/transform/livereloadinject/livereloadinject.go
+++ b/transform/livereloadinject/livereloadinject.go
@@ -24,16 +24,24 @@ import (
        "github.com/gohugoio/hugo/transform"
 )
 
+const warnMessage = `"head" or "body" tag is required in html to append livereload script. ` +
+       "As a fallback, Hugo injects it somewhere but it might not work properly."
+
+var warnScript = fmt.Sprintf(`<script data-no-instant defer>console.warn('%s');</script>`, warnMessage)
+
 type tag struct {
        markup       []byte
        appendScript bool
+       warnRequired bool
 }
 
 var tags = []tag{
-       {markup: []byte("<head>"), appendScript: true},
-       {markup: []byte("<HEAD>"), appendScript: true},
+       {markup: []byte("<head"), appendScript: true},
+       {markup: []byte("<HEAD"), appendScript: true},
        {markup: []byte("</body>")},
        {markup: []byte("</BODY>")},
+       {markup: []byte("<html"), appendScript: true, warnRequired: true},
+       {markup: []byte("<HTML"), appendScript: true, warnRequired: true},
 }
 
 // New creates a function that can be used
@@ -64,15 +72,19 @@ func New(baseURL url.URL) transform.Transformer {
                copy(c, b)
 
                if idx == -1 {
-                       _, err := ft.To().Write(c)
-                       return err
+                       idx = len(b)
+                       match = tag{warnRequired: true}
                }
 
                script := []byte(fmt.Sprintf(`<script src="%s" data-no-instant defer></script>`, html.EscapeString(src)))
 
                i := idx
                if match.appendScript {
-                       i += len(match.markup)
+                       i += bytes.Index(b[i:], []byte(">")) + 1
+               }
+
+               if match.warnRequired {
+                       script = append(script, []byte(warnScript)...)
                }
 
                c = append(c[:i], append(script, c[i:]...)...)
diff --git a/transform/livereloadinject/livereloadinject_test.go b/transform/livereloadinject/livereloadinject_test.go
index b2ec4483ab18013a55179495a43dd5ae589c5364..d5cee79f8c4ed2610f74739078b3d7c3fd6840bd 100644 (file)
--- a/transform/livereloadinject/livereloadinject_test.go
+++ b/transform/livereloadinject/livereloadinject_test.go
@@ -58,7 +58,15 @@ func TestLiveReloadInject(t *testing.T) {
                c.Assert(apply("foo</BODY>"), qt.Equals, "foo"+expectBase+"</BODY>")
        })
 
+       c.Run("Html upper", func(c *qt.C) {
+               c.Assert(apply("<html>foo"), qt.Equals, "<html>"+expectBase+warnScript+"foo")
+       })
+
+       c.Run("Html upper with attr", func(c *qt.C) {
+               c.Assert(apply(`<html lang="en">foo`), qt.Equals, `<html lang="en">`+expectBase+warnScript+"foo")
+       })
+
        c.Run("No match", func(c *qt.C) {
-               c.Assert(apply("<h1>No match</h1>"), qt.Equals, "<h1>No match</h1>")
+               c.Assert(apply("<h1>No match</h1>"), qt.Equals, "<h1>No match</h1>"+expectBase+warnScript)
        })
 }
Unnamed repository; edit this file 'description' to name the repository.