- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Add css.TailwindCSS
- v0.145.0
- v0.144.2
- v0.144.1
- v0.144.0
- v0.143.1
- v0.143.0
- v0.142.0
- v0.141.0
- v0.140.2
- v0.140.1
- v0.140.0
- v0.139.5
- v0.139.4
- v0.139.3
- v0.139.2
- v0.139.1
- v0.139.0
- v0.138.0
- v0.137.1
- v0.137.0
- v0.136.5
- v0.136.4
- v0.136.3
- v0.136.2
- v0.136.1
- v0.136.0
- v0.135.0
- v0.134.3
- v0.134.2
- v0.134.1
- v0.134.0
- v0.133.1
- v0.133.0
- v0.132.2
- v0.132.1
- v0.132.0
- v0.131.0
- v0.130.0
- v0.129.0
- v0.128.2
- v0.128.1
- v0.128.0
Showing
20 changed files
with
644 additions
and
285 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
247 changes: 247 additions & 0 deletions
247
resources/resource_transformers/cssjs/inline_imports.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| // Copyright 2024 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 cssjs | ||
|
|
||
| import ( | ||
| "crypto/sha256" | ||
| "encoding/hex" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "path" | ||
| "path/filepath" | ||
| "regexp" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/gohugoio/hugo/common/herrors" | ||
| "github.com/gohugoio/hugo/common/loggers" | ||
| "github.com/gohugoio/hugo/common/text" | ||
| "github.com/gohugoio/hugo/hugofs" | ||
| "github.com/gohugoio/hugo/identity" | ||
| "github.com/spf13/afero" | ||
| ) | ||
|
|
||
| const importIdentifier = "@import" | ||
|
|
||
| var ( | ||
| cssSyntaxErrorRe = regexp.MustCompile(`> (\d+) \|`) | ||
| shouldImportRe = regexp.MustCompile(`^@import ["'](.*?)["'];?\s*(/\*.*\*/)?$`) | ||
| ) | ||
|
|
||
| type fileOffset struct { | ||
| Filename string | ||
| Offset int | ||
| } | ||
|
|
||
| type importResolver struct { | ||
| r io.Reader | ||
| inPath string | ||
| opts InlineImports | ||
|
|
||
| contentSeen map[string]bool | ||
| dependencyManager identity.Manager | ||
| linemap map[int]fileOffset | ||
| fs afero.Fs | ||
| logger loggers.Logger | ||
| } | ||
|
|
||
| func newImportResolver(r io.Reader, inPath string, opts InlineImports, fs afero.Fs, logger loggers.Logger, dependencyManager identity.Manager) *importResolver { | ||
| return &importResolver{ | ||
| r: r, | ||
| dependencyManager: dependencyManager, | ||
| inPath: inPath, | ||
| fs: fs, logger: logger, | ||
| linemap: make(map[int]fileOffset), contentSeen: make(map[string]bool), | ||
| opts: opts, | ||
| } | ||
| } | ||
|
|
||
| func (imp *importResolver) contentHash(filename string) ([]byte, string) { | ||
| b, err := afero.ReadFile(imp.fs, filename) | ||
| if err != nil { | ||
| return nil, "" | ||
| } | ||
| h := sha256.New() | ||
| h.Write(b) | ||
| return b, hex.EncodeToString(h.Sum(nil)) | ||
| } | ||
|
|
||
| func (imp *importResolver) importRecursive( | ||
| lineNum int, | ||
| content string, | ||
| inPath string, | ||
| ) (int, string, error) { | ||
| basePath := path.Dir(inPath) | ||
|
|
||
| var replacements []string | ||
| lines := strings.Split(content, "\n") | ||
|
|
||
| trackLine := func(i, offset int, line string) { | ||
| // TODO(bep) this is not very efficient. | ||
| imp.linemap[i+lineNum] = fileOffset{Filename: inPath, Offset: offset} | ||
| } | ||
|
|
||
| i := 0 | ||
| for offset, line := range lines { | ||
| i++ | ||
| lineTrimmed := strings.TrimSpace(line) | ||
| column := strings.Index(line, lineTrimmed) | ||
| line = lineTrimmed | ||
|
|
||
| if !imp.shouldImport(line) { | ||
| trackLine(i, offset, line) | ||
| } else { | ||
| path := strings.Trim(strings.TrimPrefix(line, importIdentifier), " \"';") | ||
| filename := filepath.Join(basePath, path) | ||
| imp.dependencyManager.AddIdentity(identity.CleanStringIdentity(filename)) | ||
| importContent, hash := imp.contentHash(filename) | ||
|
|
||
| if importContent == nil { | ||
| if imp.opts.SkipInlineImportsNotFound { | ||
| trackLine(i, offset, line) | ||
| continue | ||
| } | ||
| pos := text.Position{ | ||
| Filename: inPath, | ||
| LineNumber: offset + 1, | ||
| ColumnNumber: column + 1, | ||
| } | ||
| return 0, "", herrors.NewFileErrorFromFileInPos(fmt.Errorf("failed to resolve CSS @import \"%s\"", filename), pos, imp.fs, nil) | ||
| } | ||
|
|
||
| i-- | ||
|
|
||
| if imp.contentSeen[hash] { | ||
| i++ | ||
| // Just replace the line with an empty string. | ||
| replacements = append(replacements, []string{line, ""}...) | ||
| trackLine(i, offset, "IMPORT") | ||
| continue | ||
| } | ||
|
|
||
| imp.contentSeen[hash] = true | ||
|
|
||
| // Handle recursive imports. | ||
| l, nested, err := imp.importRecursive(i+lineNum, string(importContent), filepath.ToSlash(filename)) | ||
| if err != nil { | ||
| return 0, "", err | ||
| } | ||
|
|
||
| trackLine(i, offset, line) | ||
|
|
||
| i += l | ||
|
|
||
| importContent = []byte(nested) | ||
|
|
||
| replacements = append(replacements, []string{line, string(importContent)}...) | ||
| } | ||
| } | ||
|
|
||
| if len(replacements) > 0 { | ||
| repl := strings.NewReplacer(replacements...) | ||
| content = repl.Replace(content) | ||
| } | ||
|
|
||
| return i, content, nil | ||
| } | ||
|
|
||
| func (imp *importResolver) resolve() (io.Reader, error) { | ||
| content, err := io.ReadAll(imp.r) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| contents := string(content) | ||
|
|
||
| _, newContent, err := imp.importRecursive(0, contents, imp.inPath) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return strings.NewReader(newContent), nil | ||
| } | ||
|
|
||
| // See https://www.w3schools.com/cssref/pr_import_rule.asp | ||
| // We currently only support simple file imports, no urls, no media queries. | ||
| // So this is OK: | ||
| // | ||
| // @import "navigation.css"; | ||
| // | ||
| // This is not: | ||
| // | ||
| // @import url("navigation.css"); | ||
| // @import "mobstyle.css" screen and (max-width: 768px); | ||
| func (imp *importResolver) shouldImport(s string) bool { | ||
| if !strings.HasPrefix(s, importIdentifier) { | ||
| return false | ||
| } | ||
| if strings.Contains(s, "url(") { | ||
| return false | ||
| } | ||
|
|
||
| m := shouldImportRe.FindStringSubmatch(s) | ||
| if m == nil { | ||
| return false | ||
| } | ||
|
|
||
| if len(m) != 3 { | ||
| return false | ||
| } | ||
|
|
||
| if tailwindImportExclude(m[1]) { | ||
| return false | ||
| } | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| func (imp *importResolver) toFileError(output string) error { | ||
| inErr := errors.New(output) | ||
|
|
||
| match := cssSyntaxErrorRe.FindStringSubmatch(output) | ||
| if match == nil { | ||
| return inErr | ||
| } | ||
|
|
||
| lineNum, err := strconv.Atoi(match[1]) | ||
| if err != nil { | ||
| return inErr | ||
| } | ||
|
|
||
| file, ok := imp.linemap[lineNum] | ||
| if !ok { | ||
| return inErr | ||
| } | ||
|
|
||
| fi, err := imp.fs.Stat(file.Filename) | ||
| if err != nil { | ||
| return inErr | ||
| } | ||
|
|
||
| meta := fi.(hugofs.FileMetaInfo).Meta() | ||
| realFilename := meta.Filename | ||
| f, err := meta.Open() | ||
| if err != nil { | ||
| return inErr | ||
| } | ||
| defer f.Close() | ||
|
|
||
| ferr := herrors.NewFileErrorFromName(inErr, realFilename) | ||
| pos := ferr.Position() | ||
| pos.LineNumber = file.Offset + 1 | ||
| return ferr.UpdatePosition(pos).UpdateContent(f, nil) | ||
|
|
||
| // return herrors.NewFileErrorFromFile(inErr, file.Filename, realFilename, hugofs.Os, herrors.SimpleLineMatcher) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| // Copyright 2024 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 cssjs | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "io" | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "github.com/gohugoio/hugo/common/herrors" | ||
| "github.com/gohugoio/hugo/common/hexec" | ||
| "github.com/gohugoio/hugo/common/hugo" | ||
| "github.com/gohugoio/hugo/common/loggers" | ||
| "github.com/gohugoio/hugo/resources" | ||
| "github.com/gohugoio/hugo/resources/internal" | ||
| "github.com/gohugoio/hugo/resources/resource" | ||
| "github.com/mitchellh/mapstructure" | ||
| ) | ||
|
|
||
| var ( | ||
| tailwindcssImportRe = regexp.MustCompile(`^tailwindcss/?`) | ||
| tailwindImportExclude = func(s string) bool { | ||
| return tailwindcssImportRe.MatchString(s) && !strings.Contains(s, ".") | ||
| } | ||
| ) | ||
|
|
||
| // NewTailwindCSSClient creates a new TailwindCSSClient with the given specification. | ||
| func NewTailwindCSSClient(rs *resources.Spec) *TailwindCSSClient { | ||
| return &TailwindCSSClient{rs: rs} | ||
| } | ||
|
|
||
| // Client is the client used to do TailwindCSS transformations. | ||
| type TailwindCSSClient struct { | ||
| rs *resources.Spec | ||
| } | ||
|
|
||
| // Process transforms the given Resource with the TailwindCSS processor. | ||
| func (c *TailwindCSSClient) Process(res resources.ResourceTransformer, options map[string]any) (resource.Resource, error) { | ||
| return res.Transform(&tailwindcssTransformation{rs: c.rs, optionsm: options}) | ||
| } | ||
|
|
||
| type tailwindcssTransformation struct { | ||
| optionsm map[string]any | ||
| rs *resources.Spec | ||
| } | ||
|
|
||
| func (t *tailwindcssTransformation) Key() internal.ResourceTransformationKey { | ||
| return internal.NewResourceTransformationKey("tailwindcss", t.optionsm) | ||
| } | ||
|
|
||
| type TailwindCSSOptions struct { | ||
| Minify bool // Optimize and minify the output | ||
| Optimize bool // Optimize the output without minifying | ||
| InlineImports `mapstructure:",squash"` | ||
| } | ||
|
|
||
| func (opts TailwindCSSOptions) toArgs() []any { | ||
| var args []any | ||
| if opts.Minify { | ||
| args = append(args, "--minify") | ||
| } | ||
| if opts.Optimize { | ||
| args = append(args, "--optimize") | ||
| } | ||
| return args | ||
| } | ||
|
|
||
| func (t *tailwindcssTransformation) Transform(ctx *resources.ResourceTransformationCtx) error { | ||
| const binaryName = "tailwindcss" | ||
|
|
||
| options, err := decodeTailwindCSSOptions(t.optionsm) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| infol := t.rs.Logger.InfoCommand(binaryName) | ||
| infow := loggers.LevelLoggerToWriter(infol) | ||
|
|
||
| ex := t.rs.ExecHelper | ||
|
|
||
| workingDir := t.rs.Cfg.BaseConfig().WorkingDir | ||
|
|
||
| var cmdArgs []any = []any{ | ||
| "--input=-", // Read from stdin. | ||
| "--cwd", workingDir, | ||
| } | ||
|
|
||
| cmdArgs = append(cmdArgs, options.toArgs()...) | ||
|
|
||
| // TODO1 | ||
| // npm i tailwindcss @tailwindcss/cli | ||
| // npm i tailwindcss@next @tailwindcss/cli@next | ||
| // npx tailwindcss -h | ||
|
|
||
| var errBuf bytes.Buffer | ||
|
|
||
| stderr := io.MultiWriter(infow, &errBuf) | ||
| cmdArgs = append(cmdArgs, hexec.WithStderr(stderr)) | ||
| cmdArgs = append(cmdArgs, hexec.WithStdout(ctx.To)) | ||
| cmdArgs = append(cmdArgs, hexec.WithEnviron(hugo.GetExecEnviron(workingDir, t.rs.Cfg, t.rs.BaseFs.Assets.Fs))) | ||
|
|
||
| cmd, err := ex.Npx(binaryName, cmdArgs...) | ||
| if err != nil { | ||
| if hexec.IsNotFound(err) { | ||
| // This may be on a CI server etc. Will fall back to pre-built assets. | ||
| return &herrors.FeatureNotAvailableError{Cause: err} | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| stdin, err := cmd.StdinPipe() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| src := ctx.From | ||
|
|
||
| imp := newImportResolver( | ||
| ctx.From, | ||
| ctx.InPath, | ||
| options.InlineImports, | ||
| t.rs.Assets.Fs, t.rs.Logger, ctx.DependencyManager, | ||
| ) | ||
|
|
||
| // TODO1 option { | ||
| src, err = imp.resolve() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| go func() { | ||
| defer stdin.Close() | ||
| io.Copy(stdin, src) | ||
| }() | ||
|
|
||
| err = cmd.Run() | ||
| if err != nil { | ||
| if hexec.IsNotFound(err) { | ||
| return &herrors.FeatureNotAvailableError{ | ||
| Cause: err, | ||
| } | ||
| } | ||
| return imp.toFileError(errBuf.String()) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func decodeTailwindCSSOptions(m map[string]any) (opts TailwindCSSOptions, err error) { | ||
| if m == nil { | ||
| return | ||
| } | ||
| err = mapstructure.WeakDecode(m, &opts) | ||
| return | ||
| } |
72 changes: 72 additions & 0 deletions
72
resources/resource_transformers/cssjs/tailwindcss_integration_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| // Copyright 2024 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 cssjs_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/bep/logg" | ||
| "github.com/gohugoio/hugo/htesting" | ||
| "github.com/gohugoio/hugo/hugolib" | ||
| ) | ||
|
|
||
| func TestTailwindV4Basic(t *testing.T) { | ||
| if !htesting.IsCI() { | ||
| t.Skip("Skip long running test when running locally") | ||
| } | ||
|
|
||
| files := ` | ||
| -- hugo.toml -- | ||
| -- package.json -- | ||
| { | ||
| "license": "MIT", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/bep/hugo-starter-tailwind-basic.git" | ||
| }, | ||
| "devDependencies": { | ||
| "@tailwindcss/cli": "^4.0.0-alpha.16", | ||
| "tailwindcss": "^4.0.0-alpha.16" | ||
| }, | ||
| "name": "hugo-starter-tailwind-basic", | ||
| "version": "0.1.0" | ||
| } | ||
| -- assets/css/styles.css -- | ||
| @import "tailwindcss"; | ||
| @theme { | ||
| --font-family-display: "Satoshi", "sans-serif"; | ||
| --breakpoint-3xl: 1920px; | ||
| --color-neon-pink: oklch(71.7% 0.25 360); | ||
| --color-neon-lime: oklch(91.5% 0.258 129); | ||
| --color-neon-cyan: oklch(91.3% 0.139 195.8); | ||
| } | ||
| -- layouts/index.html -- | ||
| {{ $css := resources.Get "css/styles.css" | css.TailwindCSS }} | ||
| CSS: {{ $css.Content | safeCSS }}| | ||
| ` | ||
|
|
||
| b := hugolib.NewIntegrationTestBuilder( | ||
| hugolib.IntegrationTestConfig{ | ||
| T: t, | ||
| TxtarString: files, | ||
| NeedsOsFS: true, | ||
| NeedsNpmInstall: true, | ||
| LogLevel: logg.LevelInfo, | ||
| }).Build() | ||
|
|
||
| b.AssertFileContent("public/index.html", "/*! tailwindcss v4.0.0") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters