2018-04-09 13:36:10 -04:00
|
|
|
// Copyright 2018 The Hugo Authors. All rights reserved.
|
2015-02-08 10:11:04 -05:00
|
|
|
//
|
2015-11-23 22:16:36 -05:00
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
2014-05-02 01:06:01 -04:00
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
2015-11-23 22:16:36 -05:00
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
2014-05-02 01:06:01 -04:00
|
|
|
//
|
|
|
|
// 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 commands
|
|
|
|
|
|
|
|
import (
|
2014-05-08 18:30:11 -04:00
|
|
|
"bytes"
|
|
|
|
"os"
|
|
|
|
"path/filepath"
|
2014-05-02 01:06:01 -04:00
|
|
|
"strings"
|
|
|
|
|
2017-06-13 12:42:45 -04:00
|
|
|
"github.com/gohugoio/hugo/create"
|
|
|
|
"github.com/gohugoio/hugo/helpers"
|
|
|
|
"github.com/gohugoio/hugo/hugolib"
|
2017-06-13 13:07:35 -04:00
|
|
|
"github.com/spf13/afero"
|
|
|
|
"github.com/spf13/cobra"
|
2014-05-02 01:06:01 -04:00
|
|
|
jww "github.com/spf13/jwalterweatherman"
|
|
|
|
)
|
|
|
|
|
2018-04-09 13:36:10 -04:00
|
|
|
var _ cmder = (*newCmd)(nil)
|
|
|
|
|
|
|
|
type newCmd struct {
|
2016-03-14 10:24:42 -04:00
|
|
|
contentEditor string
|
|
|
|
contentType string
|
2016-02-05 12:41:40 -05:00
|
|
|
|
2018-11-17 22:20:43 -05:00
|
|
|
*baseBuilderCmd
|
2014-05-02 01:06:01 -04:00
|
|
|
}
|
|
|
|
|
2018-11-17 22:20:43 -05:00
|
|
|
func (b *commandsBuilder) newNewCmd() *newCmd {
|
|
|
|
cmd := &cobra.Command{
|
2018-04-09 13:36:10 -04:00
|
|
|
Use: "new [path]",
|
|
|
|
Short: "Create new content for your site",
|
|
|
|
Long: `Create a new content file and automatically set the date and title.
|
2014-05-02 01:06:01 -04:00
|
|
|
It will guess which kind of file to create based on the path provided.
|
2015-08-04 05:15:12 -04:00
|
|
|
|
|
|
|
You can also specify the kind with ` + "`-k KIND`" + `.
|
|
|
|
|
2018-10-15 11:48:19 -04:00
|
|
|
If archetypes are provided in your theme or site, they will be used.
|
|
|
|
|
|
|
|
Ensure you run this within the root directory of your site.`,
|
2018-11-17 22:20:43 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
cc := &newCmd{baseBuilderCmd: b.newBuilderCmd(cmd)}
|
2015-08-04 05:15:12 -04:00
|
|
|
|
2018-11-17 22:20:43 -05:00
|
|
|
cmd.Flags().StringVarP(&cc.contentType, "kind", "k", "", "content type to create")
|
|
|
|
cmd.Flags().StringVar(&cc.contentEditor, "editor", "", "edit new content with this editor, if provided")
|
2014-05-02 01:06:01 -04:00
|
|
|
|
2020-01-31 03:09:11 -05:00
|
|
|
cmd.AddCommand(b.newNewSiteCmd().getCommand())
|
|
|
|
cmd.AddCommand(b.newNewThemeCmd().getCommand())
|
2018-04-09 13:36:10 -04:00
|
|
|
|
2018-11-17 22:20:43 -05:00
|
|
|
cmd.RunE = cc.newContent
|
2014-05-08 18:30:11 -04:00
|
|
|
|
2018-04-10 13:16:09 -04:00
|
|
|
return cc
|
2014-05-08 18:30:11 -04:00
|
|
|
}
|
|
|
|
|
2018-04-09 13:36:10 -04:00
|
|
|
func (n *newCmd) newContent(cmd *cobra.Command, args []string) error {
|
:sparkles: Implement Page bundling and image handling
This commit is not the smallest in Hugo's history.
Some hightlights include:
* Page bundles (for complete articles, keeping images and content together etc.).
* Bundled images can be processed in as many versions/sizes as you need with the three methods `Resize`, `Fill` and `Fit`.
* Processed images are cached inside `resources/_gen/images` (default) in your project.
* Symbolic links (both files and dirs) are now allowed anywhere inside /content
* A new table based build summary
* The "Total in nn ms" now reports the total including the handling of the files inside /static. So if it now reports more than you're used to, it is just **more real** and probably faster than before (see below).
A site building benchmark run compared to `v0.31.1` shows that this should be slightly faster and use less memory:
```bash
▶ ./benchSite.sh "TOML,num_langs=.*,num_root_sections=5,num_pages=(500|1000),tags_per_page=5,shortcodes,render"
benchmark old ns/op new ns/op delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 101785785 78067944 -23.30%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 185481057 149159919 -19.58%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 103149918 85679409 -16.94%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 203515478 169208775 -16.86%
benchmark old allocs new allocs delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 532464 391539 -26.47%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1056549 772702 -26.87%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 555974 406630 -26.86%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1086545 789922 -27.30%
benchmark old bytes new bytes delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 53243246 43598155 -18.12%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 105811617 86087116 -18.64%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 54558852 44545097 -18.35%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 106903858 86978413 -18.64%
```
Fixes #3651
Closes #3158
Fixes #1014
Closes #2021
Fixes #1240
Updates #3757
2017-07-24 03:00:23 -04:00
|
|
|
cfgInit := func(c *commandeer) error {
|
|
|
|
if cmd.Flags().Changed("editor") {
|
2018-04-09 13:36:10 -04:00
|
|
|
c.Set("newContentEditor", n.contentEditor)
|
:sparkles: Implement Page bundling and image handling
This commit is not the smallest in Hugo's history.
Some hightlights include:
* Page bundles (for complete articles, keeping images and content together etc.).
* Bundled images can be processed in as many versions/sizes as you need with the three methods `Resize`, `Fill` and `Fit`.
* Processed images are cached inside `resources/_gen/images` (default) in your project.
* Symbolic links (both files and dirs) are now allowed anywhere inside /content
* A new table based build summary
* The "Total in nn ms" now reports the total including the handling of the files inside /static. So if it now reports more than you're used to, it is just **more real** and probably faster than before (see below).
A site building benchmark run compared to `v0.31.1` shows that this should be slightly faster and use less memory:
```bash
▶ ./benchSite.sh "TOML,num_langs=.*,num_root_sections=5,num_pages=(500|1000),tags_per_page=5,shortcodes,render"
benchmark old ns/op new ns/op delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 101785785 78067944 -23.30%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 185481057 149159919 -19.58%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 103149918 85679409 -16.94%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 203515478 169208775 -16.86%
benchmark old allocs new allocs delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 532464 391539 -26.47%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1056549 772702 -26.87%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 555974 406630 -26.86%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1086545 789922 -27.30%
benchmark old bytes new bytes delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 53243246 43598155 -18.12%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 105811617 86087116 -18.64%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 54558852 44545097 -18.35%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 106903858 86978413 -18.64%
```
Fixes #3651
Closes #3158
Fixes #1014
Closes #2021
Fixes #1240
Updates #3757
2017-07-24 03:00:23 -04:00
|
|
|
}
|
|
|
|
return nil
|
2015-12-02 05:42:53 -05:00
|
|
|
}
|
2014-05-02 01:06:01 -04:00
|
|
|
|
2021-08-31 11:02:51 -04:00
|
|
|
c, err := initializeConfig(true, true, false, &n.hugoBuilderCommon, n, cfgInit)
|
2017-03-25 09:37:04 -04:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-02-04 22:20:06 -05:00
|
|
|
|
2014-05-02 01:06:01 -04:00
|
|
|
if len(args) < 1 {
|
2015-12-02 05:42:53 -05:00
|
|
|
return newUserError("path needs to be provided")
|
2014-05-02 01:06:01 -04:00
|
|
|
}
|
|
|
|
|
2017-03-24 03:14:14 -04:00
|
|
|
createPath := args[0]
|
2014-05-02 01:06:01 -04:00
|
|
|
|
|
|
|
var kind string
|
|
|
|
|
2019-08-15 03:33:47 -04:00
|
|
|
createPath, kind = newContentPathSection(c.hugo(), createPath)
|
2014-05-02 01:06:01 -04:00
|
|
|
|
2018-04-09 13:36:10 -04:00
|
|
|
if n.contentType != "" {
|
|
|
|
kind = n.contentType
|
2014-05-02 01:06:01 -04:00
|
|
|
}
|
|
|
|
|
2019-08-15 03:33:47 -04:00
|
|
|
return create.NewContent(c.hugo(), kind, createPath)
|
2014-05-02 01:06:01 -04:00
|
|
|
}
|
|
|
|
|
2014-05-08 18:30:11 -04:00
|
|
|
func mkdir(x ...string) {
|
2014-11-06 11:56:14 -05:00
|
|
|
p := filepath.Join(x...)
|
2014-05-08 18:30:11 -04:00
|
|
|
|
2015-02-08 10:11:04 -05:00
|
|
|
err := os.MkdirAll(p, 0777) // before umask
|
2014-05-08 18:30:11 -04:00
|
|
|
if err != nil {
|
|
|
|
jww.FATAL.Fatalln(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-01-10 04:55:03 -05:00
|
|
|
func touchFile(fs afero.Fs, x ...string) {
|
2014-11-06 11:56:14 -05:00
|
|
|
inpath := filepath.Join(x...)
|
2014-05-08 18:30:11 -04:00
|
|
|
mkdir(filepath.Dir(inpath))
|
2017-01-10 04:55:03 -05:00
|
|
|
err := helpers.WriteToDisk(inpath, bytes.NewReader([]byte{}), fs)
|
2014-05-08 18:30:11 -04:00
|
|
|
if err != nil {
|
|
|
|
jww.FATAL.Fatalln(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-09-19 01:48:17 -04:00
|
|
|
func newContentPathSection(h *hugolib.HugoSites, path string) (string, string) {
|
2015-05-12 12:12:58 -04:00
|
|
|
// Forward slashes is used in all examples. Convert if needed.
|
|
|
|
// Issue #1133
|
2017-01-10 04:55:03 -05:00
|
|
|
createpath := filepath.FromSlash(path)
|
2018-09-19 01:48:17 -04:00
|
|
|
|
|
|
|
if h != nil {
|
Add Hugo Modules
This commit implements Hugo Modules.
This is a broad subject, but some keywords include:
* A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project.
* A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects.
* Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running.
* Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions.
* A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`.
All of the above is backed by Go Modules.
Fixes #5973
Fixes #5996
Fixes #6010
Fixes #5911
Fixes #5940
Fixes #6074
Fixes #6082
Fixes #6092
2019-05-03 03:16:58 -04:00
|
|
|
for _, dir := range h.BaseFs.Content.Dirs {
|
2021-07-13 05:41:02 -04:00
|
|
|
createpath = strings.TrimPrefix(createpath, dir.Meta().Filename)
|
2018-09-19 01:48:17 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-05-12 12:12:58 -04:00
|
|
|
var section string
|
|
|
|
// assume the first directory is the section (kind)
|
|
|
|
if strings.Contains(createpath[1:], helpers.FilePathSeparator) {
|
:sparkles: Implement Page bundling and image handling
This commit is not the smallest in Hugo's history.
Some hightlights include:
* Page bundles (for complete articles, keeping images and content together etc.).
* Bundled images can be processed in as many versions/sizes as you need with the three methods `Resize`, `Fill` and `Fit`.
* Processed images are cached inside `resources/_gen/images` (default) in your project.
* Symbolic links (both files and dirs) are now allowed anywhere inside /content
* A new table based build summary
* The "Total in nn ms" now reports the total including the handling of the files inside /static. So if it now reports more than you're used to, it is just **more real** and probably faster than before (see below).
A site building benchmark run compared to `v0.31.1` shows that this should be slightly faster and use less memory:
```bash
▶ ./benchSite.sh "TOML,num_langs=.*,num_root_sections=5,num_pages=(500|1000),tags_per_page=5,shortcodes,render"
benchmark old ns/op new ns/op delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 101785785 78067944 -23.30%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 185481057 149159919 -19.58%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 103149918 85679409 -16.94%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 203515478 169208775 -16.86%
benchmark old allocs new allocs delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 532464 391539 -26.47%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1056549 772702 -26.87%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 555974 406630 -26.86%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1086545 789922 -27.30%
benchmark old bytes new bytes delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 53243246 43598155 -18.12%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 105811617 86087116 -18.64%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 54558852 44545097 -18.35%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 106903858 86978413 -18.64%
```
Fixes #3651
Closes #3158
Fixes #1014
Closes #2021
Fixes #1240
Updates #3757
2017-07-24 03:00:23 -04:00
|
|
|
parts := strings.Split(strings.TrimPrefix(createpath, helpers.FilePathSeparator), helpers.FilePathSeparator)
|
|
|
|
if len(parts) > 0 {
|
|
|
|
section = parts[0]
|
|
|
|
}
|
|
|
|
|
2015-05-12 12:12:58 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
return createpath, section
|
|
|
|
}
|