chore: Do not link parallel command by default

Author: gabe565

README.md

@@ -11,7 +11,7 @@ Go rewrite of [moreutils](http://kitenet.net/~joey/code/moreutils/).
 - **[combine](docs/combine.md)**: Combine sets of lines from two files using boolean operations
 - **[ifne](docs/ifne.md)**: Run a command if the standard input is not empty
 - **[mispipe](docs/mispipe.md)**: Pipe two commands, returning the exit status of the first
-- **[parallel](docs/parallel.md)**: Run multiple jobs at once
+- **[parallel](docs/moreutils_parallel.md)**: Run multiple jobs at once
 - **[pee](docs/pee.md)**: Tee standard input to pipes
 - **[sponge](docs/sponge.md)**: Soak up standard input and write to a file
 - **[ts](docs/ts.md)**: Timestamp standard input

cmd/cmdutil/subcommands/subcommands.go

@@ -3,7 +3,9 @@ package subcommands
 import (
 	"errors"
 	"fmt"
+	"iter"
 	"path/filepath"
+	"slices"
 	"strings"
 
 	"github.com/gabe565/moreutils/cmd/chronic"
@@ -37,6 +39,25 @@ func All(opts ...cmdutil.Option) []*cobra.Command {
 	}
 }
 
+func DefaultExcludes() []string {
+	return []string{parallel.Name}
+}
+
+func Without(excludes []string, opts ...cmdutil.Option) iter.Seq[*cobra.Command] {
+	if len(excludes) == 0 {
+		excludes = DefaultExcludes()
+	}
+	return func(yield func(*cobra.Command) bool) {
+		for _, cmd := range All(opts...) {
+			if !slices.Contains(excludes, cmd.Name()) {
+				if !yield(cmd) {
+					return
+				}
+			}
+		}
+	}
+}
+
 var ErrUnknownCommand = errors.New("unknown command")
 
 func Choose(name string, opts ...cmdutil.Option) (*cobra.Command, error) {

cmd/install/install.go

@@ -14,6 +14,7 @@ const (
 	FlagSymbolic = "symbolic"
 	FlagForce    = "force"
 	FlagRelative = "relative"
+	FlagExclude  = "exclude"
 )
 
 func New() *cobra.Command {
@@ -29,6 +30,7 @@ func New() *cobra.Command {
 	cmd.Flags().BoolP(FlagSymbolic, "s", false, "Create symbolic links instead of hard links")
 	cmd.Flags().BoolP(FlagForce, "f", false, "Overwrite existing files")
 	cmd.Flags().BoolP(FlagRelative, "r", false, "Create relative symbolic links")
+	cmd.Flags().StringSlice(FlagExclude, subcommands.DefaultExcludes(), "Subcommands that will not be linked")
 
 	return cmd
 }
@@ -82,9 +84,14 @@ func run(cmd *cobra.Command, args []string) error {
 		src = filepath.Join(relPath, filepath.Base(src))
 	}
 
+	excludes, err := cmd.Flags().GetStringSlice(FlagExclude)
+	if err != nil {
+		panic(err)
+	}
+
 	var errs []error
-	for _, cmd := range subcommands.All() {
-		dst := path.Join(dst, cmd.Name())
+	for subCmd := range subcommands.Without(excludes) {
+		dst := path.Join(dst, subCmd.Name())
 		if err := link(symbolic, src, dst); err != nil {
 			if force {
 				if err := os.Remove(dst); err == nil {

docs/moreutils_install.md

@@ -9,10 +9,11 @@ moreutils install dir [flags]
 ### Options
 
 ```
-  -f, --force      Overwrite existing files
-  -h, --help       help for install
-  -r, --relative   Create relative symbolic links
-  -s, --symbolic   Create symbolic links instead of hard links
+      --exclude strings   Subcommands that will not be linked (default [parallel])
+  -f, --force             Overwrite existing files
+  -h, --help              help for install
+  -r, --relative          Create relative symbolic links
+  -s, --symbolic          Create symbolic links instead of hard links
 ```
 
 ### SEE ALSO

docs/parallel.md renamed to docs/moreutils_parallel.md

@@ -1,9 +1,9 @@
-## parallel
+## moreutils parallel
 
 Run multiple jobs at once
 
 ```
-parallel command -- arg... [flags]
+moreutils parallel command -- arg... [flags]
 ```
 
 ### Options
@@ -13,7 +13,6 @@ parallel command -- arg... [flags]
   -j, --jobs string    Number of jobs to run in parallel. Can be a number or a percentage of CPU cores. (default "10")
   -n, --num-args int   Number of arguments to pass to a command at a time. Default is 1. Incompatible with -i (default 1)
   -i, --replace        Normally the argument is added to the end of the command. With this option, instances of "{}" in the command are replaced with the argument.
-  -v, --version        version for parallel
 ```
 
 ### SEE ALSO

internal/generate/completions/main.go

@@ -3,6 +3,7 @@ package main
 import (
 	"os"
 	"path/filepath"
+	"slices"
 	"time"
 
 	"github.com/gabe565/moreutils/cmd"
@@ -39,12 +40,13 @@ func main() {
 		panic(err)
 	}
 
+	cmds := append(slices.Collect(subcommands.Without(nil)), cmd.New(cmd.Name))
 	for _, shell := range []string{shellBash, shellZsh, shellFish} {
 		basePath := filepath.Join("completions", shell)
 		if err := os.MkdirAll(basePath, 0o777); err != nil {
 			panic(err)
 		}
-		for _, subCmd := range append(subcommands.All(), cmd.New(cmd.Name)) {
+		for _, subCmd := range cmds {
 			var path string
 			switch shell {
 			case shellBash:

internal/generate/docs/main.go

@@ -11,7 +11,7 @@ import (
 	"github.com/gabe565/moreutils/cmd"
 	"github.com/gabe565/moreutils/cmd/cmdutil"
 	"github.com/gabe565/moreutils/cmd/cmdutil/subcommands"
-	"github.com/spf13/cobra"
+	"github.com/gabe565/moreutils/internal/util"
 	"github.com/spf13/cobra/doc"
 )
 
@@ -33,10 +33,10 @@ func main() {
 
 	opts := []cmdutil.Option{cmd.WithVersion("beta")}
 	root := cmd.New(cmd.Name, opts...)
-	cmds := append(subcommands.All(opts...), root)
+	cmds := append(slices.Collect(subcommands.Without(nil, opts...)), root)
 	for _, subCmd := range root.Commands() {
 		// Add any commands which aren't standalone
-		if !slices.ContainsFunc(cmds, func(cmd *cobra.Command) bool { return cmd.Name() == subCmd.Name() }) {
+		if !util.CmdsContains(cmds, subCmd) {
 			cmds = append(cmds, subCmd)
 		}
 	}
@@ -92,8 +92,13 @@ func main() {
 	}
 
 	var list []byte
+	linked := slices.Collect(subcommands.Without(nil))
 	for _, subCmd := range subcommands.All() {
-		list = append(list, []byte("- **["+subCmd.Name()+"](docs/"+subCmd.Name()+".md)**: "+subCmd.Short+"\n")...)
+		docPath := subCmd.Name() + ".md"
+		if !util.CmdsContains(linked, subCmd) {
+			docPath = cmd.Name + "_" + docPath
+		}
+		list = append(list, []byte("- **["+subCmd.Name()+"](docs/"+docPath+")**: "+subCmd.Short+"\n")...)
 	}
 
 	readmeContents = slices.Concat(beforeApplets, []byte(beforeMarker), list, []byte(afterMarker), afterApplets)

internal/generate/links/main.go

@@ -31,7 +31,7 @@ func main() {
 		panic(err)
 	}
 
-	for _, subCmd := range subcommands.All() {
+	for subCmd := range subcommands.Without(nil) {
 		path := filepath.Join("links", subCmd.Name())
 		if err := os.Symlink(cmd.Name, path); err != nil {
 			panic(err)

internal/generate/manpages/main.go

@@ -13,7 +13,7 @@ import (
 
 	"github.com/gabe565/moreutils/cmd"
 	"github.com/gabe565/moreutils/cmd/cmdutil/subcommands"
-	"github.com/spf13/cobra"
+	"github.com/gabe565/moreutils/internal/util"
 	"github.com/spf13/cobra/doc"
 	flag "github.com/spf13/pflag"
 )
@@ -45,14 +45,15 @@ func main() {
 	}
 
 	root := cmd.New(cmd.Name)
-	cmds := append(subcommands.All(), root)
+	cmds := append(slices.Collect(subcommands.Without(nil)), root)
 	for _, subCmd := range root.Commands() {
 		// Add any commands which aren't standalone
-		if !slices.ContainsFunc(cmds, func(cmd *cobra.Command) bool { return cmd.Name() == subCmd.Name() }) {
+		if !util.CmdsContains(cmds, subCmd) {
 			cmds = append(cmds, subCmd)
 		}
 	}
 
+	linked := slices.Collect(subcommands.Without(nil))
 	for _, subCmd := range cmds {
 		subCmd.DisableAutoGenTag = true
 		header := doc.GenManHeader{
@@ -64,8 +65,8 @@ func main() {
 		}
 
 		name := subCmd.Name() + ".1.gz"
-		if subCmd.HasParent() {
-			name = subCmd.Parent().Name() + "-" + name
+		if subCmd.Name() != cmd.Name && !util.CmdsContains(linked, subCmd) {
+			name = cmd.Name + "-" + name
 		}
 		path := filepath.Join("manpages", name)
 		out, err := os.Create(path)
@@ -107,7 +108,7 @@ func (s *seeAlsoWriter) Write(p []byte) (int, error) {
 		n := len(p)
 		headerIdx := bytes.Index(p, []byte(seeAlsoLine))
 		p, temp := p[:headerIdx], p[headerIdx:]
-		for _, subCmd := range subcommands.All() {
+		for subCmd := range subcommands.Without(nil) {
 			temp = bytes.ReplaceAll(temp, []byte(cmd.Name+"-"+subCmd.Name()), []byte(subCmd.Name()))
 		}
 		_, err := s.w.Write(append(p, temp...))

internal/util/cobra.go

@@ -0,0 +1,13 @@
+package util
+
+import (
+	"slices"
+
+	"github.com/spf13/cobra"
+)
+
+func CmdsContains(cmds []*cobra.Command, target *cobra.Command) bool {
+	return slices.ContainsFunc(cmds, func(cmd *cobra.Command) bool {
+		return cmd.Name() == target.Name()
+	})
+}