commands/new: Improve theme creation

- Reorganize layouts directory to match the new template system.
- Add --format flag to control format of the site configuration and
  default archetype.
- Remove theme.toml. This file's presence can be confusing for new
  users, and the README in the themes repository already has an example.

Closes #13489
Closes #13544

Author: jmooring

commands/new.go

@@ -144,15 +144,22 @@ according to your needs.`,
 					createpath := paths.AbsPathify(conf.configs.Base.WorkingDir, filepath.Join(conf.configs.Base.ThemesDir, args[0]))
 					r.Println("Creating new theme in", createpath)
 
-					err = skeletons.CreateTheme(createpath, sourceFs)
+					err = skeletons.CreateTheme(createpath, sourceFs, format)
 					if err != nil {
 						return err
 					}
 
 					return nil
 				},
 				withc: func(cmd *cobra.Command, r *rootCommand) {
-					cmd.ValidArgsFunction = cobra.NoFileCompletions
+					cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+						if len(args) != 0 {
+							return []string{}, cobra.ShellCompDirectiveNoFileComp
+						}
+						return []string{}, cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveFilterDirs
+					}
+					cmd.Flags().StringVar(&format, "format", "toml", "preferred file format (toml, yaml or json)")
+					_ = cmd.RegisterFlagCompletionFunc("format", cobra.FixedCompletions([]string{"toml", "yaml", "json"}, cobra.ShellCompDirectiveNoFileComp))
 				},
 			},
 		},

create/skeletons/skeletons.go

@@ -34,10 +34,60 @@ var siteFs embed.FS
 var themeFs embed.FS
 
 // CreateTheme creates a theme skeleton.
-func CreateTheme(createpath string, sourceFs afero.Fs) error {
+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)
+
+	siteConfig := map[string]any{
+		"baseURL":      "https://example.org/",
+		"languageCode": "en-US",
+		"title":        "My New Hugo Site",
+		"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.116.0",
+			},
+		},
+	}
+
+	err := createSiteConfig(sourceFs, createpath, siteConfig, 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)
 }
 
@@ -71,12 +121,24 @@ func CreateSite(createpath string, sourceFs afero.Fs, force bool, format string)
 		}
 	}
 
-	err := newSiteCreateConfig(sourceFs, createpath, format)
+	siteConfig := map[string]any{
+		"baseURL":      "https://example.org/",
+		"title":        "My New Hugo Site",
+		"languageCode": "en-us",
+	}
+
+	err := createSiteConfig(sourceFs, createpath, siteConfig, format)
 	if err != nil {
 		return err
 	}
 
-	err = newSiteCreateArchetype(sourceFs, createpath, format)
+	defaultArchetype := map[string]any{
+		"title": "{{ replace .File.ContentBaseName \"-\" \" \" | title }}",
+		"date":  "{{ .Date }}",
+		"draft": true,
+	}
+
+	err = createDefaultArchetype(sourceFs, createpath, defaultArchetype, format)
 	if err != nil {
 		return err
 	}
@@ -99,13 +161,7 @@ func copyFiles(createpath string, sourceFs afero.Fs, skeleton embed.FS) error {
 	})
 }
 
-func newSiteCreateConfig(fs afero.Fs, createpath string, format string) (err error) {
-	in := map[string]string{
-		"baseURL":      "https://example.org/",
-		"title":        "My New Hugo Site",
-		"languageCode": "en-us",
-	}
-
+func createSiteConfig(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 {
@@ -115,13 +171,7 @@ func newSiteCreateConfig(fs afero.Fs, createpath string, format string) (err err
 	return helpers.WriteToDisk(filepath.Join(createpath, "hugo."+format), &buf, fs)
 }
 
-func newSiteCreateArchetype(fs afero.Fs, createpath string, format string) (err error) {
-	in := map[string]any{
-		"title": "{{ replace .File.ContentBaseName \"-\" \" \" | title }}",
-		"date":  "{{ .Date }}",
-		"draft": true,
-	}
-
+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 {

create/skeletons/theme/archetypes/default.md

@@ -1,9 +1,9 @@
 {{- with resources.Get "css/main.css" }}
-  {{- if eq hugo.Environment "development" }}
-    <link rel="stylesheet" href="{{ .RelPermalink }}">
-  {{- else }}
+  {{- if hugo.IsProduction }}
     {{- with . | minify | fingerprint }}
       <link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
     {{- end }}
+  {{- else }}
+    <link rel="stylesheet" href="{{ .RelPermalink }}">
   {{- end }}
 {{- end }}

create/skeletons/theme/hugo.toml

@@ -0,0 +1,16 @@
+{{ with resources.Get "js/main.js" }}
+  {{ $opts := dict
+    "minify" hugo.IsProduction
+    "sourceMap" (cond hugo.IsProduction "" "external")
+    "targetPath" "js/main.js"
+  }}
+  {{ with . | js.Build $opts }}
+    {{ if hugo.IsProduction }}
+      {{ with . | fingerprint }}
+        <script src="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous"></script>
+      {{ end }}
+    {{ else }}
+      <script src="{{ .RelPermalink }}"></script>
+    {{ end }}
+  {{ end }}
+{{ end }}

create/skeletons/theme/layouts/partials/footer.html create/skeletons/theme/layouts/_partials/footer.html

@@ -0,0 +1,7 @@
+{{ define "main" }}
+  <h1>{{ .Title }}</h1>
+  {{ .Content }}
+  {{ range .Pages }}
+    <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
+  {{ end }}
+{{ end }}

create/skeletons/theme/layouts/partials/head.html create/skeletons/theme/layouts/_partials/head.html

@@ -0,0 +1,7 @@
+{{ define "main" }}
+  <h1>{{ .Title }}</h1>
+  {{ .Content }}
+  {{ range .Pages }}
+    <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
+  {{ end }}
+{{ end }}

create/skeletons/theme/layouts/partials/head/css.html create/skeletons/theme/layouts/_partials/head/css.html

@@ -20,7 +20,7 @@ exists themes
 
 hugo new theme -h
 stdout 'Create a new theme \(skeleton\) called \[name\] in ./themes'
-hugo new theme mytheme
+hugo new theme mytheme --format yml
 stdout 'Creating new theme'
 ! exists resources
 cd themes
@@ -34,22 +34,23 @@ checkfile content/posts/post-1.md
 checkfile content/posts/post-2.md
 checkfile content/posts/post-3/bryce-canyon.jpg
 checkfile content/posts/post-3/index.md
-checkfile layouts/_default/baseof.html
-checkfile layouts/_default/home.html
-checkfile layouts/_default/list.html
-checkfile layouts/_default/single.html
-checkfile layouts/partials/footer.html
-checkfile layouts/partials/head.html
-checkfile layouts/partials/head/css.html
-checkfile layouts/partials/head/js.html
-checkfile layouts/partials/header.html
-checkfile layouts/partials/menu.html
-checkfile layouts/partials/terms.html
+checkfile layouts/baseof.html
+checkfile layouts/home.html
+checkfile layouts/list.html
+checkfile layouts/single.html
+checkfile layouts/taxonomy.html
+checkfile layouts/term.html
+checkfile layouts/_partials/footer.html
+checkfile layouts/_partials/head.html
+checkfile layouts/_partials/head/css.html
+checkfile layouts/_partials/head/js.html
+checkfile layouts/_partials/header.html
+checkfile layouts/_partials/menu.html
+checkfile layouts/_partials/terms.html
 checkfile static/favicon.ico
 checkfile LICENSE
 checkfile README.md
-checkfile hugo.toml
-checkfile theme.toml
+checkfile hugo.yml
 exists data
 exists i18n