github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

livereload: Inject script without head or body tag

Browse source 
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
This commit is contained in:
satotake 2022-08-07 23:15:28 +09:00 committed by Bjørn Erik Pedersen
parent 7fb28085ac
commit b017f7cb01
2 changed files with 26 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
transform/livereloadinject/livereloadinject.go
View file

@ -24,16 +24,24 @@ import (
"github.com/gohugoio/hugo/transform" "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 { type tag struct {
markup []byte markup []byte
appendScript bool appendScript bool
warnRequired bool
} }
var tags = []tag{ 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("</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 // New creates a function that can be used
@ -64,15 +72,19 @@ func New(baseURL url.URL) transform.Transformer {
copy(c, b) copy(c, b)
if idx == -1 { if idx == -1 {
_, err := ft.To().Write(c) idx = len(b)
return err match = tag{warnRequired: true}
} }
script := []byte(fmt.Sprintf(`<script src="%s" data-no-instant defer></script>`, html.EscapeString(src))) script := []byte(fmt.Sprintf(`<script src="%s" data-no-instant defer></script>`, html.EscapeString(src)))
i := idx i := idx
if match.appendScript { 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:]...)...) c = append(c[:i], append(script, c[i:]...)...)

10
transform/livereloadinject/livereloadinject_test.go
View file

@ -58,7 +58,15 @@ func TestLiveReloadInject(t *testing.T) {
c.Assert(apply("foo</BODY>"), qt.Equals, "foo"+expectBase+"</BODY>") 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.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)
}) })
} }