mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 08:12:06 -05:00
b017f7cb01
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
97 lines
2.7 KiB
Go
97 lines
2.7 KiB
Go
// Copyright 2018 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package livereloadinject
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"html"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"github.com/gohugoio/hugo/helpers"
|
|
"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("</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
|
|
// to inject a script tag for the livereload JavaScript in a HTML document.
|
|
func New(baseURL url.URL) transform.Transformer {
|
|
return func(ft transform.FromTo) error {
|
|
b := ft.From().Bytes()
|
|
idx := -1
|
|
var match tag
|
|
// We used to insert the livereload script right before the closing body.
|
|
// This does not work when combined with tools such as Turbolinks.
|
|
// So we try to inject the script as early as possible.
|
|
for _, t := range tags {
|
|
idx = bytes.Index(b, t.markup)
|
|
if idx != -1 {
|
|
match = t
|
|
break
|
|
}
|
|
}
|
|
|
|
path := strings.TrimSuffix(baseURL.Path, "/")
|
|
|
|
src := path + "/livereload.js?mindelay=10&v=2"
|
|
src += "&port=" + baseURL.Port()
|
|
src += "&path=" + strings.TrimPrefix(path+"/livereload", "/")
|
|
|
|
c := make([]byte, len(b))
|
|
copy(c, b)
|
|
|
|
if idx == -1 {
|
|
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 += bytes.Index(b[i:], []byte(">")) + 1
|
|
}
|
|
|
|
if match.warnRequired {
|
|
script = append(script, []byte(warnScript)...)
|
|
}
|
|
|
|
c = append(c[:i], append(script, c[i:]...)...)
|
|
|
|
if _, err := ft.To().Write(c); err != nil {
|
|
helpers.DistinctWarnLog.Println("Failed to inject LiveReload script:", err)
|
|
}
|
|
return nil
|
|
}
|
|
}
|