Improve Tailwind/PostCSS error messages

Fixes gohugoio#7041 Fixes gohugoio#7042
bep · Mar 11, 2020 · df29855 · df29855
1 parent b1106f8
commit df29855
Show file tree

Hide file tree

Showing 11 changed files with 355 additions and 111 deletions.
diff --git a/commands/hugo.go b/commands/hugo.go
@@ -722,9 +722,6 @@ func (c *commandeer) handleBuildErr(err error, msg string) {
 
 func (c *commandeer) rebuildSites(events []fsnotify.Event) error {
 	defer c.timeTrack(time.Now(), "Total")
-	defer func() {
-		c.wasError = false
-	}()
 
 	c.buildErr = nil
 	visited := c.visitedURLs.PeekAllSet()
@@ -886,6 +883,10 @@ func (c *commandeer) handleEvents(watcher *watcher.Batcher,
 	evs []fsnotify.Event,
 	configSet map[string]bool) {
 
+	defer func() {
+		c.wasError = false
+	}()
+
 	var isHandled bool
 
 	for _, ev := range evs {
@@ -1080,10 +1081,11 @@ func (c *commandeer) handleEvents(watcher *watcher.Batcher,
 			// Will block forever trying to write to a channel that nobody is reading if livereload isn't initialized
 
 			// force refresh when more than one file
-			if len(staticEvents) == 1 {
+			if !c.wasError && len(staticEvents) == 1 {
 				ev := staticEvents[0]
 				path := c.hugo().BaseFs.SourceFilesystems.MakeStaticPathRelative(ev.Name)
 				path = c.firstPathSpec().RelURL(helpers.ToSlashTrimLeading(path), false)
+
 				livereload.RefreshPath(path)
 			} else {
 				livereload.ForceRefresh()
@@ -1107,6 +1109,10 @@ func (c *commandeer) handleEvents(watcher *watcher.Batcher,
 
 		if doLiveReload {
 			if len(partitionedEvents.ContentEvents) == 0 && len(partitionedEvents.AssetEvents) > 0 {
+				if c.wasError {
+					livereload.ForceRefresh()
+					return
+				}
 				changed := c.changeDetector.changed()
 				if c.changeDetector != nil && len(changed) == 0 {
 					// Nothing has changed.

diff --git a/commands/server.go b/commands/server.go
@@ -340,6 +340,7 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, string, string, erro
 					if err != nil {
 						f.c.logger.ERROR.Println(err)
 					}
+
 					port = 1313
 					if !f.c.paused {
 						port = f.c.Cfg.GetInt("liveReloadPort")

diff --git a/commands/server_errors.go b/commands/server_errors.go
@@ -30,8 +30,7 @@ var buildErrorTemplate = `<!doctype html>
 		body {
 			font-family: "Muli",avenir, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
 			font-size: 16px;
-			background-color: black;
-			color: rgba(255, 255, 255, 0.9);
+			background-color: #2f1e2e;
 		}
 		main {
 			margin: auto;
@@ -43,7 +42,7 @@ var buildErrorTemplate = `<!doctype html>
 			padding: 1rem 0;
 		}
 		.stack {
-			margin-top: 6rem;
+			margin-top: 4rem;
 		}
 		pre {
 			white-space: pre-wrap;      
@@ -54,10 +53,7 @@ var buildErrorTemplate = `<!doctype html>
 		}
 		.highlight {
 			overflow-x: auto;
-			padding: 0.75rem;
 			margin-bottom: 1rem;
-			background-color: #272822;
-			border: 1px solid black;
 		}
 		a {
 			color: #0594cb;
@@ -70,14 +66,14 @@ var buildErrorTemplate = `<!doctype html>
 	</head>
 	<body>
 		<main>
-			{{ highlight .Error "apl" "noclasses=true,style=monokai" }}
+			{{ highlight .Error "apl" "linenos=false,noclasses=true,style=paraiso-dark" }}
 			{{ with .File }}
-			{{ $params := printf "noclasses=true,style=monokai,linenos=table,hl_lines=%d,linenostart=%d" (add .LinesPos 1) (sub .Position.LineNumber .LinesPos) }}
+			{{ $params := printf "noclasses=true,style=paraiso-dark,linenos=table,hl_lines=%d,linenostart=%d" (add .LinesPos 1) (sub .Position.LineNumber .LinesPos) }}
 			{{ $lexer := .ChromaLexer | default "go-html-template" }}
 			{{  highlight (delimit .Lines "\n") $lexer $params }}
 			{{ end }}
 			{{ with .StackTrace }}
-			{{ highlight . "apl" "noclasses=true,style=monokai" }}
+			{{ highlight . "apl" "noclasses=true,style=paraiso-dark" }}
 			{{ end }}
 			<p class="version">{{ .Version }}</p>
 			<a href="">Reload Page</a>

diff --git a/deps/deps.go b/deps/deps.go
@@ -235,7 +235,9 @@ func New(cfg DepsCfg) (*Deps, error) {
 		return nil, errors.WithMessage(err, "failed to create file caches from configuration")
 	}
 
-	resourceSpec, err := resources.NewSpec(ps, fileCaches, logger, cfg.OutputFormats, cfg.MediaTypes)
+	errorHandler := &globalErrHandler{}
+
+	resourceSpec, err := resources.NewSpec(ps, fileCaches, logger, errorHandler, cfg.OutputFormats, cfg.MediaTypes)
 	if err != nil {
 		return nil, err
 	}
@@ -275,7 +277,7 @@ func New(cfg DepsCfg) (*Deps, error) {
 		BuildStartListeners:     &Listeners{},
 		BuildFlags:              &BuildFlags{},
 		Timeout:                 time.Duration(timeoutms) * time.Millisecond,
-		globalErrHandler:        &globalErrHandler{},
+		globalErrHandler:        errorHandler,
 	}
 
 	if cfg.Cfg.GetBool("templateMetrics") {
@@ -306,7 +308,7 @@ func (d Deps) ForLanguage(cfg DepsCfg, onCreated func(d *Deps) error) (*Deps, er
 	// The resource cache is global so reuse.
 	// TODO(bep) clean up these inits.
 	resourceCache := d.ResourceSpec.ResourceCache
-	d.ResourceSpec, err = resources.NewSpec(d.PathSpec, d.ResourceSpec.FileCaches, d.Log, cfg.OutputFormats, cfg.MediaTypes)
+	d.ResourceSpec, err = resources.NewSpec(d.PathSpec, d.ResourceSpec.FileCaches, d.Log, d.globalErrHandler, cfg.OutputFormats, cfg.MediaTypes)
 	if err != nil {
 		return nil, err
 	}

diff --git a/hugolib/resource_chain_test.go b/hugolib/resource_chain_test.go
@@ -22,6 +22,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/gohugoio/hugo/common/herrors"
+
 	"github.com/gohugoio/hugo/htesting"
 
 	"github.com/spf13/viper"
@@ -717,11 +719,10 @@ func TestResourceChainPostCSS(t *testing.T) {
 
 	packageJSON := `{
   "scripts": {},
-  "dependencies": {
-    "tailwindcss": "^1.2"
-  },
+
   "devDependencies": {
-    "postcss-cli": "^7.1.0"
+    "postcss-cli": "^7.1.0",
+    "tailwindcss": "^1.2"
   }
 }
 `
@@ -826,7 +827,7 @@ Styles Content: Len: 770878|
 
 	assertCss(b)
 
-	build := func(s string, shouldFail bool) {
+	build := func(s string, shouldFail bool) error {
 		b.Assert(os.RemoveAll(filepath.Join(workDir, "public")), qt.IsNil)
 
 		v := viper.New()
@@ -837,19 +838,37 @@ Styles Content: Len: 770878|
 		b = newTestBuilder(v)
 
 		b.Assert(os.RemoveAll(filepath.Join(workDir, "public")), qt.IsNil)
-		b.Assert(os.RemoveAll(filepath.Join(workDir, "node_modules")), qt.IsNil)
 
+		err := b.BuildE(BuildCfg{})
 		if shouldFail {
-			b.BuildFail(BuildCfg{})
+			b.Assert(err, qt.Not(qt.IsNil))
 		} else {
-			b.Build(BuildCfg{})
+			b.Assert(err, qt.IsNil)
 			assertCss(b)
 		}
+
+		return err
 	}
 
 	build("always", false)
 	build("fallback", false)
 
+	// Introduce a syntax error in an import
+	b.WithSourceFile("assets/css/components/b.css", `@import "a.css";
+
+class-in-b {
+	@apply asdf;
+}
+`)
+
+	err = build("newer", true)
+
+	err = herrors.UnwrapErrorWithFileContext(err)
+	fe, ok := err.(*herrors.ErrorWithFileContext)
+	b.Assert(ok, qt.Equals, true)
+	b.Assert(fe.Position().LineNumber, qt.Equals, 4)
+	b.Assert(fe.Error(), qt.Contains, filepath.Join(workDir, "assets/css/components/b.css:4:1"))
+
 	// Remove PostCSS
 	b.Assert(os.RemoveAll(filepath.Join(workDir, "node_modules")), qt.IsNil)
 

diff --git a/resources/resource_spec.go b/resources/resource_spec.go
@@ -22,6 +22,8 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/gohugoio/hugo/common/herrors"
+
 	"github.com/gohugoio/hugo/config"
 
 	"github.com/gohugoio/hugo/hugofs"
@@ -43,6 +45,7 @@ func NewSpec(
 	s *helpers.PathSpec,
 	fileCaches filecache.Caches,
 	logger *loggers.Logger,
+	errorHandler herrors.ErrorSender,
 	outputFormats output.Formats,
 	mimeTypes media.Types) (*Spec, error) {
 
@@ -67,6 +70,7 @@ func NewSpec(
 
 	rs := &Spec{PathSpec: s,
 		Logger:        logger,
+		ErrorSender:   errorHandler,
 		imaging:       imaging,
 		MediaTypes:    mimeTypes,
 		OutputFormats: outputFormats,
@@ -91,7 +95,8 @@ type Spec struct {
 	MediaTypes    media.Types
 	OutputFormats output.Formats
 
-	Logger *loggers.Logger
+	Logger      *loggers.Logger
+	ErrorSender herrors.ErrorSender
 
 	TextTemplates tpl.TemplateParseFinder
 

diff --git a/resources/resource_transformers/htesting/testhelpers.go b/resources/resource_transformers/htesting/testhelpers.go
@@ -51,7 +51,7 @@ func NewTestResourceSpec() (*resources.Spec, error) {
 		return nil, err
 	}
 
-	spec, err := resources.NewSpec(s, filecaches, nil, output.DefaultFormats, media.DefaultTypes)
+	spec, err := resources.NewSpec(s, filecaches, nil, nil, output.DefaultFormats, media.DefaultTypes)
 	return spec, err
 }