Now that embed is fully supported and rather mature it makes sense to begin maintaining the documentation that goes into the Description fields in its own text/template. As such, breaking out the Other sections makes less sense. I propose adding support for double-hashtag Markdown headings that signal the creation of a new headings (forced to upper case when rendered). We should also deprecate use of Other in general because it is only supported when displaying main help, and not itemized.

Note that this is a change to the help.Cmd and the bonzai/z.Mark* stuff together.

Should look at Version detect an VERSION file within the Source URL location making intelligent decisions about the Source URL expansion required by the hosting service (github.com, for example). If not VERSION file is found and the service is github.com use the GitHub API to determine the latest release. It is important that there be no dependency on Git for checking for a latest version allowing distribution of binaries to take place on a simple web server with a VERSION file next to the binaries.

Hello Rob

There seems to be a problem with the newest version of Bonsai where 2022/11/27 23:43:52 runtime error: index out of range [1] with length 1 is always reported by the runtime.

Steps to reproduce:

1. Create new Bonsai tree like so

package main

import (
	Z "github.com/rwxrob/bonzai/z"
	"log"
)

var Cmd = &Z.Cmd {
	Name: `j`,
	Description: `
		Blank
		`,

	Commands: []*Z.Cmd {
		HelloCmd,
	},
}

var HelloCmd = &Z.Cmd {
	Name: `hello`,

	Call: func(_ *Z.Cmd, args ...string) error {
		name := args[0]
		log.Printf("Hello, %v!\n", name)
		return nil
	},

}


func main() {


	Cmd.Run()
}

2. Build using go build .
3. Get Error

I was hoping you could solve this, because it is very annoying

Regards, foehammer

Since help accepts arguments having NoArgs on the base command that composes in help.Cmd doesn't allow those args to be picked up my help.Cmd.

z version  (breaks and should not with NoArgs set)

Z.Aliases is a misnomer. They are shortcuts. Plus, by changing this we can move them into Cmd.Shortcuts so that they are relative to a given command. Keeping the two allows the developer creating the composite tree to add their own shortcuts as well as allowing branch developers to provide alternatives (foo var set <name> <value -> foo set <name> <value>).

Note that shortcuts are different than aliases, which are simply other names for the current command itself. Shortcuts relate to all the commands under that command.

Need to be able to expand the template language of anything in a given Bonzai branch (Z package scope) rather than just for a given command. This way the following will overwrite in layers with the last one winning:

1. Z builtins (indent, cmd, pre, exename, etc.)
2. Z.Dynamic
3. Cmd.Dynamic

The -- "into" operator (end of options in other shells) is the equivalent of a pipe in BonzaiShell. It signifies that one command has ended and that any output to os.Stdout should be redirected into a buffer and set as the last argument to the command immediately following the "into" operator. This is the exact behavior of text/template when adding FuncMap functions that take piped input and should feel normal to any Go programmer who has worked with templates.

We cannot use the actual pipe operator (|) because it would have to be quoted or escaped constantly (like find command requires). By using -- the hosting shell (if there is one) will ignore it. And since we are doing our own argument parsing (and not using getopt) use of -- is fine. In fact, because -- does have special meaning to getopt we can purposefully ensure that no Bonzai command ever adds getopt (since technically it could be added now). This conflict, therefore, has a purpose.

These need to be their own repos:

• https://github.com/rwxrob/comp-cmd
• https://github.com/rwxrob/comp-file

There should be another base template repo created for creating your own completers:

• https://github.com/rwxrob/comp-template

We really want to make it drop-dead easy to create your own bonzai.Completers so we can jump start the ecosystem of completions. Writing a completer is a great first Go programming experience and potentially much more entertaining than the others.

Also, by breaking completers out into their own repos we are more likely to get people making their own FOSS contributions because they get all the credit since they made the repo.

The mergeFuncs function should make a number of easy to use template functions available to Bonzai developers, all of which can be overridden by whatever they assign to Cmd.Dynamic.

We need a way to set a cached variable persistence engine for the entire Bonzai binary executable (like with Conf). The https://github.com/rwxrob/cache bonzai branch and pkg lib is being created as first example implementation.

Since we have added the entire bonzai.Command interface might as well take advantage of all those method calls to support text/template replacements of any of the resulting values, starting with GetDescription. This would mean that the Cmd.Description (in this case) is the raw template string. And GetDescription would have the template filled in. This will require reworking the help.Cmd as well but will provide very dynamic documentation possibilities.

Now that embed is the conventional way to add documentation to commands, it makes sense to explore ways to put all the documentation for a given command into a single file within the desc directory. In fact, where it is stored does matter, we simply have to use Reflect to look for a string that matches the name of the command.

//go:embed desc/foo.md
var fooCmdDoc string

var fooCmd := &Z.Cmd{
  // ...
}

The performance hit from using Reflect is minimal for this type of operation since it is only to display help and would not affect anything else being called dynamically from the help command itself.

The use of docs should, however, be discouraged since it is used for other things like KEG and GitHub pages sites.

Previously, backticks in Markdown for Description would conflict with the multi-line string backticks required for Go, but now that adding such things in desc/help.md file is preferred, such is no longer needed.

Hi, thanks for your work and streams. Bonzai is an excellent idea and I am planning to move my scritps as well to it after I understand how to use it.

I have pyenv on my environment, running any bonzai command that calls a help command fails with pyenv: no such command "tmp/hlpe-XXXXX"

If I remove pyenv from my $PATH bonzai help command works. Why would the pyenv executable be called ? I never encountered this issue.

Is there a way to traceback command exection ? I am willing to fix it if I can the debug the call. strace was not helpfulp.

It should be easy to reproduce by just installing pyenv. The bug happen under any shell (bash, zsh, fish ...)

Thanks.

Windows doesn't follow any of the normal pager conventions, but should be able to find more on the system for it. Detecting the pager will also cover the problem with command-line dos prompts not doing color since piping to more disables all color.