hugo/create/skeletons/skeletons.go

// 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 skeletons

import (
	"bytes"
	"embed"
	"errors"
	"io/fs"
	"path/filepath"
	"strings"

	"github.com/gohugoio/hugo/helpers"
	"github.com/gohugoio/hugo/parser"
	"github.com/gohugoio/hugo/parser/metadecoders"
	"github.com/spf13/afero"
)

//go:embed all:project/*
var projectFs embed.FS

//go:embed all:theme/*
var themeFs embed.FS

// CreateTheme creates a theme skeleton.
func CreateTheme(createpath string, sourceFs afero.Fs, format string) error {
	if exists, _ := helpers.Exists(createpath, sourceFs); exists {
		return errors.New(createpath + " already exists")
	}

	format = strings.ToLower(format)

	projectConfig := map[string]any{
		"baseURL": "https://example.org/",
		"locale":  "en-US",
		"title":   "My New Hugo Project",
		"menus": map[string]any{
			"main": []any{
				map[string]any{
					"name":    "Home",
					"pageRef": "/",
					"weight":  10,
				},
				map[string]any{
					"name":    "Posts",
					"pageRef": "/posts",
					"weight":  20,
				},
				map[string]any{
					"name":    "Tags",
					"pageRef": "/tags",
					"weight":  30,
				},
			},
		},
		"module": map[string]any{
			"hugoVersion": map[string]any{
				"extended": false,
				"min":      "0.146.0",
			},
		},
	}

	err := createProjectConfig(sourceFs, createpath, projectConfig, format)
	if err != nil {
		return err
	}

	defaultArchetype := map[string]any{
		"title": "{{ replace .File.ContentBaseName \"-\" \" \" | title }}",
		"date":  "{{ .Date }}",
		"draft": true,
	}

	err = createDefaultArchetype(sourceFs, createpath, defaultArchetype, format)
	if err != nil {
		return err
	}

	return copyFiles(createpath, sourceFs, themeFs)
}

// CreateProject creates a project skeleton.
func CreateProject(createpath string, sourceFs afero.Fs, force bool, format string) error {
	format = strings.ToLower(format)
	if exists, _ := helpers.Exists(createpath, sourceFs); exists {
		if isDir, _ := helpers.IsDir(createpath, sourceFs); !isDir {
			return errors.New(createpath + " already exists but not a directory")
		}

		isEmpty, _ := helpers.IsEmpty(createpath, sourceFs)

		switch {
		case !isEmpty && !force:
			return errors.New(createpath + " already exists and is not empty. See --force.")
		case !isEmpty && force:
			var all []string
			fs.WalkDir(projectFs, ".", func(path string, d fs.DirEntry, err error) error {
				if d.IsDir() && path != "." {
					all = append(all, path)
				}
				return nil
			})
			all = append(all, filepath.Join(createpath, "hugo."+format))
			for _, path := range all {
				if exists, _ := helpers.Exists(path, sourceFs); exists {
					return errors.New(path + " already exists")
				}
			}
		}
	}

	projectConfig := map[string]any{
		"baseURL": "https://example.org/",
		"locale":  "en-us",
		"title":   "My New Hugo Project",
	}

	err := createProjectConfig(sourceFs, createpath, projectConfig, format)
	if err != nil {
		return err
	}

	defaultArchetype := map[string]any{
		"title": "{{ replace .File.ContentBaseName \"-\" \" \" | title }}",
		"date":  "{{ .Date }}",
		"draft": true,
	}

	err = createDefaultArchetype(sourceFs, createpath, defaultArchetype, format)
	if err != nil {
		return err
	}

	return copyFiles(createpath, sourceFs, projectFs)
}

func copyFiles(createpath string, sourceFs afero.Fs, skeleton embed.FS) error {
	return fs.WalkDir(skeleton, ".", func(path string, d fs.DirEntry, err error) error {
		_, slug, _ := strings.Cut(path, "/")
		if d.IsDir() {
			return sourceFs.MkdirAll(filepath.Join(createpath, slug), 0o777)
		} else {
			if filepath.Base(path) != ".gitkeep" {
				data, _ := fs.ReadFile(skeleton, path)
				return helpers.WriteToDisk(filepath.Join(createpath, slug), bytes.NewReader(data), sourceFs)
			}
			return nil
		}
	})
}

func createProjectConfig(fs afero.Fs, createpath string, in map[string]any, format string) (err error) {
	var buf bytes.Buffer
	err = parser.InterfaceToConfig(in, metadecoders.FormatFromString(format), &buf)
	if err != nil {
		return err
	}

	return helpers.WriteToDisk(filepath.Join(createpath, "hugo."+format), &buf, fs)
}

func createDefaultArchetype(fs afero.Fs, createpath string, in map[string]any, format string) (err error) {
	var buf bytes.Buffer
	err = parser.InterfaceToFrontMatter(in, metadecoders.FormatFromString(format), &buf)
	if err != nil {
		return err
	}

	return helpers.WriteToDisk(filepath.Join(createpath, "archetypes", "default.md"), &buf, fs)
}