commands: Use punctuation consistently in short description

diff --git a/commands/gen.go b/commands/gen.go
index 3cb05927d43f11a525380e9b32cf6db56ed31ef6..5e49d9e7de706b2e203d17bce78059ac02e22f41 100644 (file)
--- a/commands/gen.go
+++ b/commands/gen.go
@@ -149,7 +149,7 @@ url: %s
 
                return &simpleCommand{
                        name:  "doc",
-                       short: "Generate Markdown documentation for the Hugo CLI.",
+                       short: "Generate Markdown documentation for the Hugo CLI",
                        long: `Generate Markdown documentation for the Hugo CLI.
                        This command is, mostly, used to create up-to-date documentation
        of Hugo's command-line interface for https://gohugo.io/.
@@ -201,7 +201,7 @@ url: %s
        newDocsHelper := func() simplecobra.Commander {
                return &simpleCommand{
                        name:  "docshelper",
-                       short: "Generate some data files for the Hugo docs.",
+                       short: "Generate some data files for the Hugo docs",
 
                        run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
                                r.Println("Generate docs data to", docsHelperTarget)

diff --git a/commands/mod.go b/commands/mod.go
index dda7840ccdfc58b1a685eec85eb3660ddae1688f..58155f9bea6f03f00f09cada2cd7aff598957a78 100644 (file)
--- a/commands/mod.go
+++ b/commands/mod.go
@@ -44,16 +44,16 @@ func newModCommands() *modCommands {
 
        npmCommand := &simpleCommand{
                name:  "npm",
-               short: "Various npm helpers.",
+               short: "Various npm helpers",
                long:  `Various npm (Node package manager) helpers.`,
                commands: []simplecobra.Commander{
                        &simpleCommand{
                                name:  "pack",
-                               short: "Experimental: Prepares and writes a composite package.json file for your project.",
+                               short: "Experimental: Prepares and writes a composite package.json file for your project",
                                long: `Prepares and writes a composite package.json file for your project.
 
 On first run it creates a "package.hugo.json" in the project root if not already there. This file will be used as a template file
-with the base dependency set. 
+with the base dependency set.
 
 This set will be merged with all "package.hugo.json" files found in the dependency tree, picking the version closest to the project.
 
@@ -80,12 +80,12 @@ so this may/will change in future versions of Hugo.
                commands: []simplecobra.Commander{
                        &simpleCommand{
                                name:  "init",
-                               short: "Initialize this project as a Hugo Module.",
+                               short: "Initialize this project as a Hugo Module",
                                long: `Initialize this project as a Hugo Module.
        It will try to guess the module path, but you may help by passing it as an argument, e.g:
-       
+
                hugo mod init github.com/gohugoio/testshortcodes
-       
+
        Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module
        inside a subfolder on GitHub, as one example.
        `,
@@ -111,7 +111,7 @@ so this may/will change in future versions of Hugo.
                        },
                        &simpleCommand{
                                name:  "verify",
-                               short: "Verify dependencies.",
+                               short: "Verify dependencies",
                                long:  `Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded.`,
                                withc: func(cmd *cobra.Command, r *rootCommand) {
                                        cmd.ValidArgsFunction = cobra.NoFileCompletions
@@ -129,7 +129,7 @@ so this may/will change in future versions of Hugo.
                        },
                        &simpleCommand{
                                name:  "graph",
-                               short: "Print a module dependency graph.",
+                               short: "Print a module dependency graph",
                                long: `Print a module dependency graph with information about module status (disabled, vendored).
 Note that for vendored modules, that is the version listed and not the one from go.mod.
 `,
@@ -149,7 +149,7 @@ Note that for vendored modules, that is the version listed and not the one from
                        },
                        &simpleCommand{
                                name:  "clean",
-                               short: "Delete the Hugo Module cache for the current project.",
+                               short: "Delete the Hugo Module cache for the current project",
                                long:  `Delete the Hugo Module cache for the current project.`,
                                withc: func(cmd *cobra.Command, r *rootCommand) {
                                        cmd.ValidArgsFunction = cobra.NoFileCompletions
@@ -175,7 +175,7 @@ Note that for vendored modules, that is the version listed and not the one from
                        },
                        &simpleCommand{
                                name:  "tidy",
-                               short: "Remove unused entries in go.mod and go.sum.",
+                               short: "Remove unused entries in go.mod and go.sum",
                                withc: func(cmd *cobra.Command, r *rootCommand) {
                                        cmd.ValidArgsFunction = cobra.NoFileCompletions
                                        applyLocalFlagsBuildConfig(cmd, r)
@@ -190,7 +190,7 @@ Note that for vendored modules, that is the version listed and not the one from
                        },
                        &simpleCommand{
                                name:  "vendor",
-                               short: "Vendor all module dependencies into the _vendor directory.",
+                               short: "Vendor all module dependencies into the _vendor directory",
                                long: `Vendor all module dependencies into the _vendor directory.
        If a module is vendored, that is where Hugo will look for it's dependencies.
        `,
@@ -209,16 +209,16 @@ Note that for vendored modules, that is the version listed and not the one from
 
                        &simpleCommand{
                                name:  "get",
-                               short: "Resolves dependencies in your current Hugo Project.",
+                               short: "Resolves dependencies in your current Hugo project",
                                long: `
-Resolves dependencies in your current Hugo Project.
+Resolves dependencies in your current Hugo project.
 
 Some examples:
 
 Install the latest version possible for a given module:
 
     hugo mod get github.com/gohugoio/testshortcodes
-    
+
 Install a specific version:
 
     hugo mod get github.com/gohugoio/testshortcodes@v0.3.0

diff --git a/commands/release.go b/commands/release.go
index b05226d35aabd482e2f6fe6d472e7ba790ba5d83..059f04eb8bd9aef68ac4d26bbbdba6f0e65958a9 100644 (file)
--- a/commands/release.go
+++ b/commands/release.go
@@ -32,7 +32,7 @@ func newReleaseCommand() simplecobra.Commander {
 
        return &simpleCommand{
                name:  "release",
-               short: "Release a new version of Hugo.",
+               short: "Release a new version of Hugo",
                run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
                        rel, err := releaser.New(skipPush, try, step)
                        if err != nil {

diff --git a/commands/server.go b/commands/server.go
index 828c78a3afa7253d7bd875d46c72ce98e45e123b..d42ce6d29c46890a857852683b92ff8e3bfae769 100644 (file)
--- a/commands/server.go
+++ b/commands/server.go
@@ -119,7 +119,7 @@ func newServerCommand() *serverCommand {
                commands: []simplecobra.Commander{
                        &simpleCommand{
                                name:  "trust",
-                               short: "Install the local CA in the system trust store.",
+                               short: "Install the local CA in the system trust store",
                                run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
                                        action := "-install"
                                        if uninstall {

diff --git a/testscripts/commands/hugo__errors.txt b/testscripts/commands/hugo__errors.txt
index 2400ce69b05cdf55e6687f7aac8f41f68b82f15a..975d11616ec8efb5260ecf4e300455dded0d38d4 100644 (file)
--- a/testscripts/commands/hugo__errors.txt
+++ b/testscripts/commands/hugo__errors.txt
@@ -2,7 +2,7 @@
 
 # The hugo mod get command handles flags a little special, but the -h flag should print the help.
 hugo mod get -h
-stdout 'Resolves dependencies in your current Hugo Project'
+stdout 'Resolves dependencies in your current Hugo project'
 
 # Invalid flag. Should print an error message to stderr and the help to stdout.
 ! hugo --asdf
@@ -15,4 +15,4 @@ stdout 'hugo is the main command'
 stderr 'failed to load config'
 
 -- hugo.toml --
-invalid: toml
\ No newline at end of file
+invalid: toml