dartsass: Enable deprecation, @warn and @debug logging

* @warn and Sass deprecations are printed as WARN
* @debug is currently logged as INFO (needs the `--verbose` flag). We may adjust this if it gets too chatty.

Fixes #9683

diff --git a/go.mod b/go.mod
index 9a5e1179e1eb34b6feab86551d7bf1099ee088bb..b797586be71f7a48f169901bc5040709f4351424 100644 (file)
--- a/go.mod
+++ b/go.mod
@@ -9,7 +9,7 @@ require (
        github.com/bep/debounce v1.2.0
        github.com/bep/gitmap v1.1.2
        github.com/bep/goat v0.5.0
-       github.com/bep/godartsass v0.12.0
+       github.com/bep/godartsass v0.14.0
        github.com/bep/golibsass v1.0.0
        github.com/bep/gowebp v0.1.0
        github.com/bep/tmc v0.5.1

diff --git a/go.sum b/go.sum
index 1027742c15fe1d0cf73080c7c83e54523d48291a..545ba1085591347fa363bf62f18432a52da6795e 100644 (file)
--- a/go.sum
+++ b/go.sum
@@ -140,8 +140,8 @@ github.com/bep/gitmap v1.1.2 h1:zk04w1qc1COTZPPYWDQHvns3y1afOsdRfraFQ3qI840=
 github.com/bep/gitmap v1.1.2/go.mod h1:g9VRETxFUXNWzMiuxOwcudo6DfZkW9jOsOW0Ft4kYaY=
 github.com/bep/goat v0.5.0 h1:S8jLXHCVy/EHIoCY+btKkmcxcXFd34a0Q63/0D4TKeA=
 github.com/bep/goat v0.5.0/go.mod h1:Md9x7gRxiWKs85yHlVTvHQw9rg86Bm+Y4SuYE8CTH7c=
-github.com/bep/godartsass v0.12.0 h1:VvGLA4XpXUjKvp53SI05YFLhRFJ78G+Ybnlaz6Oul7E=
-github.com/bep/godartsass v0.12.0/go.mod h1:nXQlHHk4H1ghUk6n/JkYKG5RD43yJfcfp5aHRqT/pc4=
+github.com/bep/godartsass v0.14.0 h1:pPb6XkpyDEppS+wK0veh7OXDQc4xzOJI9Qcjb743UeQ=
+github.com/bep/godartsass v0.14.0/go.mod h1:6LvK9RftsXMxGfsA0LDV12AGc4Jylnu6NgHL+Q5/pE8=
 github.com/bep/golibsass v1.0.0 h1:gNguBMSDi5yZEZzVZP70YpuFQE3qogJIGUlrVILTmOw=
 github.com/bep/golibsass v1.0.0/go.mod h1:DL87K8Un/+pWUS75ggYv41bliGiolxzDKWJAq3eJ1MA=
 github.com/bep/gowebp v0.1.0 h1:4/iQpfnxHyXs3x/aTxMMdOpLEQQhFmF6G7EieWPTQyo=
@@ -219,7 +219,6 @@ github.com/fortytw2/leaktest v1.3.0 h1:u8491cBMTQ8ft8aeV+adlcytMZylmA5nnwwkRZjI8
 github.com/fortytw2/leaktest v1.3.0/go.mod h1:jDsjWgpAGjm2CA7WthBh/CdZYEPF31XHquHwclZch5g=
 github.com/frankban/quicktest v1.4.1/go.mod h1:36zfPVQyHxymz4cH7wlDmVwDrJuljRB60qkgn7rorfQ=
 github.com/frankban/quicktest v1.7.2/go.mod h1:jaStnuzAqU1AJdCO0l53JDCJrVDKcS03DbaAcR7Ks/o=
-github.com/frankban/quicktest v1.11.2/go.mod h1:K+q6oSqb0W0Ininfk863uOk1lMy69l/P6txr3mVT54s=
 github.com/frankban/quicktest v1.13.0/go.mod h1:qLE0fzW0VuyUAJgPU19zByoIr0HtCHN/r/VLSOOIySU=
 github.com/frankban/quicktest v1.14.2 h1:SPb1KFFmM+ybpEjPUhCCkZOM5xlovT5UbrMvWnXyBns=
 github.com/frankban/quicktest v1.14.2/go.mod h1:mgiwOwqx65TmIk1wJ6Q7wvnVMocbUorkibMOrVTHZps=

diff --git a/hugolib/integrationtest_builder.go b/hugolib/integrationtest_builder.go
index 1bfa194bdc98c3621c4cb5113a1df12a67764aa2..d49e29763c0fbc544e2f40cb4901fa8a8ca1a370 100644 (file)
--- a/hugolib/integrationtest_builder.go
+++ b/hugolib/integrationtest_builder.go
@@ -6,6 +6,7 @@ import (
        "io"
        "os"
        "path/filepath"
+       "regexp"
        "strings"
        "sync"
        "testing"
@@ -98,6 +99,12 @@ func (s *IntegrationTestBuilder) AssertLogContains(text string) {
        s.Assert(s.logBuff.String(), qt.Contains, text)
 }
 
+func (s *IntegrationTestBuilder) AssertLogMatches(expression string) {
+       s.Helper()
+       re := regexp.MustCompile(expression)
+       s.Assert(re.MatchString(s.logBuff.String()), qt.IsTrue, qt.Commentf(s.logBuff.String()))
+}
+
 func (s *IntegrationTestBuilder) AssertBuildCountData(count int) {
        s.Helper()
        s.Assert(s.H.init.data.InitCount(), qt.Equals, count)

diff --git a/resources/resource_transformers/tocss/dartsass/client.go b/resources/resource_transformers/tocss/dartsass/client.go
index b5d05b30b41455dece20450b17eec11d80763cb9..647cf86aa018da5e298c9a3c3a2c3da82806b5fd 100644 (file)
--- a/resources/resource_transformers/tocss/dartsass/client.go
+++ b/resources/resource_transformers/tocss/dartsass/client.go
@@ -18,6 +18,7 @@ package dartsass
 import (
        "fmt"
        "io"
+       "strings"
 
        "github.com/gohugoio/hugo/helpers"
        "github.com/gohugoio/hugo/hugolib/filesystems"
@@ -41,7 +42,19 @@ func New(fs *filesystems.SourceFilesystem, rs *resources.Spec) (*Client, error)
                return nil, err
        }
 
-       transpiler, err := godartsass.Start(godartsass.Options{})
+       transpiler, err := godartsass.Start(godartsass.Options{
+               LogEventHandler: func(event godartsass.LogEvent) {
+                       message := strings.ReplaceAll(event.Message, stdinPrefix, "")
+                       switch event.Type {
+                       case godartsass.LogEventTypeDebug:
+                               // Log as Info for now, we may adjust this if it gets too chatty.
+                               rs.Logger.Infof("Dart Sass: %s", message)
+                       default:
+                               // The rest are either deprecations or @warn statements.
+                               rs.Logger.Warnf("Dart Sass: %s", message)
+                       }
+               },
+       })
        if err != nil {
                return nil, err
        }

diff --git a/resources/resource_transformers/tocss/dartsass/integration_test.go b/resources/resource_transformers/tocss/dartsass/integration_test.go
index 9434b1d5233bfe041abcf1908d7a8afbbd88caa2..a1ac1d59f13f21977a3ba2d9697535550e19d3c7 100644 (file)
--- a/resources/resource_transformers/tocss/dartsass/integration_test.go
+++ b/resources/resource_transformers/tocss/dartsass/integration_test.go
@@ -18,6 +18,7 @@ import (
 
        "github.com/gohugoio/hugo/hugolib"
        "github.com/gohugoio/hugo/resources/resource_transformers/tocss/dartsass"
+       jww "github.com/spf13/jwalterweatherman"
 )
 
 func TestTransformIncludePaths(t *testing.T) {
@@ -164,3 +165,34 @@ zoo {
 
        b.AssertFileContent("public/index.html", `T1: moo{color:#ccc}boo{color:green}zoo{color:pink}`)
 }
+
+func TestTransformLogging(t *testing.T) {
+       if !dartsass.Supports() {
+               t.Skip()
+       }
+
+       files := `
+-- assets/scss/main.scss --
+@warn "foo";
+@debug "bar";
+
+-- config.toml --
+disableKinds = ["term", "taxonomy", "section", "page"]
+-- layouts/index.html --
+{{ $cssOpts := (dict  "transpiler" "dartsass" ) }}
+{{ $r := resources.Get "scss/main.scss" |  toCSS $cssOpts   }}
+T1: {{ $r.Content }}
+       `
+
+       b := hugolib.NewIntegrationTestBuilder(
+               hugolib.IntegrationTestConfig{
+                       T:           t,
+                       TxtarString: files,
+                       NeedsOsFS:   true,
+                       LogLevel:    jww.LevelInfo,
+               }).Build()
+
+       b.AssertLogMatches(`WARN.*Dart Sass: foo`)
+       b.AssertLogMatches(`INFO.*Dart Sass: .*assets.*main.scss:1:0: bar`)
+
+}

diff --git a/resources/resource_transformers/tocss/dartsass/transform.go b/resources/resource_transformers/tocss/dartsass/transform.go
index 57d9feadbeebd1c9b626708cd1e7b22ca0f95f83..aaf9d4bf8134997fdc3f367b66fb6485302a4d86 100644 (file)
--- a/resources/resource_transformers/tocss/dartsass/transform.go
+++ b/resources/resource_transformers/tocss/dartsass/transform.go
@@ -39,7 +39,8 @@ import (
 
 const (
        // See https://github.com/sass/dart-sass-embedded/issues/24
-       stdinPlaceholder           = "HUGOSTDIN"
+       // Note: This prefix must be all lower case.
+       stdinPrefix                = "hugostdin:"
        dartSassEmbeddedBinaryName = "dart-sass-embedded"
 )
 
@@ -75,9 +76,14 @@ func (t *transform) Transform(ctx *resources.ResourceTransformationCtx) error {
        }
 
        baseDir := path.Dir(ctx.SourcePath)
+       filename := stdinPrefix
+
+       if ctx.SourcePath != "" {
+               filename += t.c.sfs.RealFilename(ctx.SourcePath)
+       }
 
        args := godartsass.Args{
-               URL:          stdinPlaceholder,
+               URL:          filename,
                IncludePaths: t.c.sfs.RealDirs(baseDir),
                ImportResolver: importResolver{
                        baseDir: baseDir,
@@ -106,11 +112,8 @@ func (t *transform) Transform(ctx *resources.ResourceTransformationCtx) error {
                        start := sassErr.Span.Start
                        context := strings.TrimSpace(sassErr.Span.Context)
                        filename, _ := urlToFilename(sassErr.Span.Url)
-                       if filename == stdinPlaceholder {
-                               if ctx.SourcePath == "" {
-                                       return sassErr
-                               }
-                               filename = t.c.sfs.RealFilename(ctx.SourcePath)
+                       if strings.HasPrefix(filename, stdinPrefix) {
+                               filename = filename[len(stdinPrefix):]
                        }
 
                        offsetMatcher := func(m herrors.LineMatcher) bool {