diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-04-09 19:36:10 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-04-11 09:48:56 +0200 |
commit | 56a13080446283ed1cde6b69fc6f4fac85076c84 (patch) | |
tree | 59316b9b8df2036aac0e8438c2ea31a6012c0802 /commands/new.go | |
parent | 4b780ca778ee7f25af808da38ede964a01698c70 (diff) |
commands: Make the new commands non-global
See #4598
Diffstat (limited to 'commands/new.go')
-rw-r--r-- | commands/new.go | 271 |
1 files changed, 32 insertions, 239 deletions
diff --git a/commands/new.go b/commands/new.go index c4f56fec9..f4caff50c 100644 --- a/commands/new.go +++ b/commands/new.go @@ -1,4 +1,4 @@ -// Copyright 2016 The Hugo Authors. All rights reserved. +// Copyright 2018 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. @@ -15,80 +15,64 @@ package commands import ( "bytes" - "errors" - "fmt" "os" "path/filepath" "strings" - "time" "github.com/gohugoio/hugo/create" "github.com/gohugoio/hugo/helpers" - "github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/hugolib" - "github.com/gohugoio/hugo/parser" "github.com/spf13/afero" "github.com/spf13/cobra" jww "github.com/spf13/jwalterweatherman" - "github.com/spf13/viper" ) -var ( - configFormat string +var _ cmder = (*newCmd)(nil) + +type newCmd struct { contentEditor string contentType string -) - -func init() { - newSiteCmd.Flags().StringVarP(&configFormat, "format", "f", "toml", "config & frontmatter format") - newSiteCmd.Flags().Bool("force", false, "init inside non-empty directory") - newCmd.Flags().StringVarP(&contentType, "kind", "k", "", "content type to create") - newCmd.PersistentFlags().StringVarP(&source, "source", "s", "", "filesystem path to read files relative from") - newCmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{}) - newCmd.Flags().StringVar(&contentEditor, "editor", "", "edit new content with this editor, if provided") - newCmd.AddCommand(newSiteCmd) - newCmd.AddCommand(newThemeCmd) + cmd *cobra.Command +} +func (c *newCmd) getCommand() *cobra.Command { + return c.cmd } -var newCmd = &cobra.Command{ - Use: "new [path]", - Short: "Create new content for your site", - Long: `Create a new content file and automatically set the date and title. +func newNewCmd() *newCmd { + ccmd := &newCmd{} + cmd := &cobra.Command{ + Use: "new [path]", + Short: "Create new content for your site", + Long: `Create a new content file and automatically set the date and title. It will guess which kind of file to create based on the path provided. You can also specify the kind with ` + "`-k KIND`" + `. If archetypes are provided in your theme or site, they will be used.`, - RunE: NewContent, -} + RunE: ccmd.newContent, + } -var newSiteCmd = &cobra.Command{ - Use: "site [path]", - Short: "Create a new site (skeleton)", - Long: `Create a new site in the provided directory. -The new site will have the correct structure, but no content or theme yet. -Use ` + "`hugo new [contentPath]`" + ` to create new content.`, - RunE: NewSite, -} + cmd.Flags().StringVarP(&ccmd.contentType, "kind", "k", "", "content type to create") + // TODO(bep) cli refactor + cmd.PersistentFlags().StringVarP(&source, "source", "s", "", "filesystem path to read files relative from") + cmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{}) + cmd.Flags().StringVar(&ccmd.contentEditor, "editor", "", "edit new content with this editor, if provided") + + cmd.AddCommand(newNewSiteCmd().getCommand()) + cmd.AddCommand(newNewThemeCmd().getCommand()) + + ccmd.cmd = cmd -var newThemeCmd = &cobra.Command{ - Use: "theme [name]", - Short: "Create a new theme", - Long: `Create a new theme (skeleton) called [name] in the current directory. -New theme is a skeleton. Please add content to the touched files. Add your -name to the copyright line in the license and adjust the theme.toml file -as you see fit.`, - RunE: NewTheme, + return ccmd } -// NewContent adds new content to a Hugo site. -func NewContent(cmd *cobra.Command, args []string) error { +func (n *newCmd) newContent(cmd *cobra.Command, args []string) error { cfgInit := func(c *commandeer) error { if cmd.Flags().Changed("editor") { - c.Set("newContentEditor", contentEditor) + c.Set("newContentEditor", n.contentEditor) } return nil } @@ -109,8 +93,8 @@ func NewContent(cmd *cobra.Command, args []string) error { createPath, kind = newContentPathSection(createPath) - if contentType != "" { - kind = contentType + if n.contentType != "" { + kind = n.contentType } cfg := c.DepsCfg @@ -151,56 +135,6 @@ func NewContent(cmd *cobra.Command, args []string) error { return create.NewContent(ps, siteFactory, kind, createPath) } -func doNewSite(fs *hugofs.Fs, basepath string, force bool) error { - archeTypePath := filepath.Join(basepath, "archetypes") - dirs := []string{ - filepath.Join(basepath, "layouts"), - filepath.Join(basepath, "content"), - archeTypePath, - filepath.Join(basepath, "static"), - filepath.Join(basepath, "data"), - filepath.Join(basepath, "themes"), - } - - if exists, _ := helpers.Exists(basepath, fs.Source); exists { - if isDir, _ := helpers.IsDir(basepath, fs.Source); !isDir { - return errors.New(basepath + " already exists but not a directory") - } - - isEmpty, _ := helpers.IsEmpty(basepath, fs.Source) - - switch { - case !isEmpty && !force: - return errors.New(basepath + " already exists and is not empty") - - case !isEmpty && force: - all := append(dirs, filepath.Join(basepath, "config."+configFormat)) - for _, path := range all { - if exists, _ := helpers.Exists(path, fs.Source); exists { - return errors.New(path + " already exists") - } - } - } - } - - for _, dir := range dirs { - if err := fs.Source.MkdirAll(dir, 0777); err != nil { - return fmt.Errorf("Failed to create dir: %s", err) - } - } - - createConfig(fs, basepath, configFormat) - - // Create a defaul archetype file. - helpers.SafeWriteToDisk(filepath.Join(archeTypePath, "default.md"), - strings.NewReader(create.ArchetypeTemplateTemplate), fs.Source) - - jww.FEEDBACK.Printf("Congratulations! Your new Hugo site is created in %s.\n\n", basepath) - jww.FEEDBACK.Println(nextStepsText()) - - return nil -} - func nextStepsText() string { var nextStepsText bytes.Buffer @@ -222,98 +156,6 @@ Visit https://gohugo.io/ for quickstart guide and full documentation.`) return nextStepsText.String() } -// NewSite creates a new Hugo site and initializes a structured Hugo directory. -func NewSite(cmd *cobra.Command, args []string) error { - if len(args) < 1 { - return newUserError("path needs to be provided") - } - - createpath, err := filepath.Abs(filepath.Clean(args[0])) - if err != nil { - return newUserError(err) - } - - forceNew, _ := cmd.Flags().GetBool("force") - - return doNewSite(hugofs.NewDefault(viper.New()), createpath, forceNew) -} - -// NewTheme creates a new Hugo theme. -func NewTheme(cmd *cobra.Command, args []string) error { - c, err := InitializeConfig(false, nil) - - if err != nil { - return err - } - - if len(args) < 1 { - return newUserError("theme name needs to be provided") - } - - createpath := c.PathSpec().AbsPathify(filepath.Join(c.Cfg.GetString("themesDir"), args[0])) - jww.INFO.Println("creating theme at", createpath) - - cfg := c.DepsCfg - - if x, _ := helpers.Exists(createpath, cfg.Fs.Source); x { - return newUserError(createpath, "already exists") - } - - mkdir(createpath, "layouts", "_default") - mkdir(createpath, "layouts", "partials") - - touchFile(cfg.Fs.Source, createpath, "layouts", "index.html") - touchFile(cfg.Fs.Source, createpath, "layouts", "404.html") - touchFile(cfg.Fs.Source, createpath, "layouts", "_default", "list.html") - touchFile(cfg.Fs.Source, createpath, "layouts", "_default", "single.html") - - touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "header.html") - touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "footer.html") - - mkdir(createpath, "archetypes") - - archDefault := []byte("+++\n+++\n") - - err = helpers.WriteToDisk(filepath.Join(createpath, "archetypes", "default.md"), bytes.NewReader(archDefault), cfg.Fs.Source) - if err != nil { - return err - } - - mkdir(createpath, "static", "js") - mkdir(createpath, "static", "css") - - by := []byte(`The MIT License (MIT) - -Copyright (c) ` + time.Now().Format("2006") + ` YOUR_NAME_HERE - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -`) - - err = helpers.WriteToDisk(filepath.Join(createpath, "LICENSE.md"), bytes.NewReader(by), cfg.Fs.Source) - if err != nil { - return err - } - - createThemeMD(cfg.Fs, createpath) - - return nil -} - func mkdir(x ...string) { p := filepath.Join(x...) @@ -332,39 +174,7 @@ func touchFile(fs afero.Fs, x ...string) { } } -func createThemeMD(fs *hugofs.Fs, inpath string) (err error) { - - by := []byte(`# theme.toml template for a Hugo theme -# See https://github.com/gohugoio/hugoThemes#themetoml for an example - -name = "` + strings.Title(helpers.MakeTitle(filepath.Base(inpath))) + `" -license = "MIT" -licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE.md" -description = "" -homepage = "http://example.com/" -tags = [] -features = [] -min_version = "0.38" - -[author] - name = "" - homepage = "" - -# If porting an existing theme -[original] - name = "" - homepage = "" - repo = "" -`) - - err = helpers.WriteToDisk(filepath.Join(inpath, "theme.toml"), bytes.NewReader(by), fs.Source) - if err != nil { - return - } - - return nil -} - +// TODO(bep) cli refactor => method func newContentPathSection(path string) (string, string) { // Forward slashes is used in all examples. Convert if needed. // Issue #1133 @@ -381,20 +191,3 @@ func newContentPathSection(path string) (string, string) { return createpath, section } - -func createConfig(fs *hugofs.Fs, inpath string, kind string) (err error) { - in := map[string]string{ - "baseURL": "http://example.org/", - "title": "My New Hugo Site", - "languageCode": "en-us", - } - kind = parser.FormatSanitize(kind) - - var buf bytes.Buffer - err = parser.InterfaceToConfig(in, parser.FormatToLeadRune(kind), &buf) - if err != nil { - return err - } - - return helpers.WriteToDisk(filepath.Join(inpath, "config."+kind), &buf, fs.Source) -} |