aboutsummaryrefslogtreecommitdiffhomepage
path: root/tpl/js/js.go
blob: b686b76a7bc857cbba833c804beb6d982a68d98e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// 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 js provides functions for building JavaScript resources
package js

import (
	"errors"

	"github.com/gohugoio/hugo/common/maps"
	"github.com/gohugoio/hugo/deps"
	"github.com/gohugoio/hugo/internal/js/esbuild"
	"github.com/gohugoio/hugo/resources"
	"github.com/gohugoio/hugo/resources/resource"
	"github.com/gohugoio/hugo/resources/resource_factories/create"
	"github.com/gohugoio/hugo/resources/resource_transformers/babel"
	jstransform "github.com/gohugoio/hugo/resources/resource_transformers/js"
	"github.com/gohugoio/hugo/tpl/internal/resourcehelpers"
)

// New returns a new instance of the js-namespaced template functions.
func New(d *deps.Deps) (*Namespace, error) {
	if d.ResourceSpec == nil {
		return &Namespace{}, nil
	}

	batcherClient, err := esbuild.NewBatcherClient(d)
	if err != nil {
		return nil, err
	}

	return &Namespace{
		d:                 d,
		jsTransformClient: jstransform.New(d.BaseFs.Assets, d.ResourceSpec),
		jsBatcherClient:   batcherClient,
		jsBatcherStore:    maps.NewCache[string, esbuild.Batcher](),
		createClient:      create.New(d.ResourceSpec),
		babelClient:       babel.New(d.ResourceSpec),
	}, nil
}

// Namespace provides template functions for the "js" namespace.
type Namespace struct {
	d *deps.Deps

	jsTransformClient *jstransform.Client
	createClient      *create.Client
	babelClient       *babel.Client
	jsBatcherClient   *esbuild.BatcherClient
	jsBatcherStore    *maps.Cache[string, esbuild.Batcher]
}

// Build processes the given Resource with ESBuild.
func (ns *Namespace) Build(args ...any) (resource.Resource, error) {
	var (
		r          resources.ResourceTransformer
		m          map[string]any
		targetPath string
		err        error
		ok         bool
	)

	r, targetPath, ok = resourcehelpers.ResolveIfFirstArgIsString(args)

	if !ok {
		r, m, err = resourcehelpers.ResolveArgs(args)
		if err != nil {
			return nil, err
		}
	}

	if targetPath != "" {
		m = map[string]any{"targetPath": targetPath}
	}

	return ns.jsTransformClient.Process(r, m)
}

// Batch creates a new Batcher with the given ID.
// Repeated calls with the same ID will return the same Batcher.
// The ID will be used to name the root directory of the batch.
// Forward slashes in the ID is allowed.
func (ns *Namespace) Batch(id string) (esbuild.Batcher, error) {
	if err := esbuild.ValidateBatchID(id, true); err != nil {
		return nil, err
	}
	b, err := ns.jsBatcherStore.GetOrCreate(id, func() (esbuild.Batcher, error) {
		return ns.jsBatcherClient.New(id)
	})
	if err != nil {
		return nil, err
	}
	return b, nil
}

// Babel processes the given Resource with Babel.
func (ns *Namespace) Babel(args ...any) (resource.Resource, error) {
	if len(args) > 2 {
		return nil, errors.New("must not provide more arguments than resource object and options")
	}

	r, m, err := resourcehelpers.ResolveArgs(args)
	if err != nil {
		return nil, err
	}
	var options babel.Options
	if m != nil {
		options, err = babel.DecodeOptions(m)
		if err != nil {
			return nil, err
		}
	}

	return ns.babelClient.Process(r, options)
}