Migrate from bonzai to kong (#29)

* Migrate from bonzai to kong

Significant changes where made between the version of Bonzai I wrote this with and latest. Further, the author deleted their packages meaning we cannot rebuild on machines that don't have them cached.

Signed-off-by: Daniel Michaels <dan@danielms.site>

* Only run go-releaser on push tag

Signed-off-by: Daniel Michaels <dan@danielms.site>

* Update build instructions

Signed-off-by: Daniel Michaels <dan@danielms.site>

* Fix interactive term, use idomatic kong for nested commands

Signed-off-by: Daniel Michaels <dan@danielms.site>

---------

Signed-off-by: Daniel Michaels <dan@danielms.site>

Author: danielmichaels

.github/workflows/goreleaser.yaml

@@ -1,10 +1,10 @@
 name: goreleaser
 
 on:
-  pull_request:
+  workflow_dispatch:
   push:
     tags:
-      - '*'
+      - 'v*'
 
 permissions:
   contents: write

ARCHITECTURE.md

@@ -38,48 +38,6 @@ Zet will use github and git as its storage medium.  Each new zet will get a dire
 
 Tags are used for quicker searching. Terminal tools and github do well searching for hashtag prepended names.
 
-### Implementation
-
-Many facets will be stolen from rwxrob/Zet-cmd
-https://github.com/rwxrob/cmd-zet
-
-This will be a standalone bonzai branch which can be imported into ds
-
-
-
-## Commands
-
-Zet commands required to create, read and edit zet's
-
-### Create
-
-Creating a new Zet is the most common command. 
-
-create flow
-  
-  1. Zet create $1
-  2. Create $dir
-  3. Vim $dir/README.md
-  4. Write contents (see $contents)
-  5. Git commit -s -a -m $1
-  6. Git pull -q (prevent conflicts)
-  7. Git push -s
-  8. Echo zet pushed as $isosec ($dir name)
- 
-### Edit
-
-Editing any previous Zet is achieved by appending the isosec after Zet edit. 
-
-### Last
-
-This should open the last Zet in vim.
-
-Finding the last Zet could probably be achieved by identifying the latest dir from the list of dirs
-
-### View
-
-This could be a search option for reading or finding a Zet to edit
-
 ## Notes
 Todo:
 

BUILD.md

@@ -2,7 +2,6 @@
 
 When updating this repository to a new release the following steps need to be undertaken.
 
-1. Update `Cmd.Version` in `zet-cmd/cmd/zet/main.go`
-2. Merge to `main` all changes required for the new release
-3. Create a new tag to match the `Cmd.Version` with `git tag -a v0.0.0 -m "v0.0.0" -s`
-4. Push the tag with `git push --tags` which will trigger `goreleaser` to build new binaries
+1. Merge to `main` all changes required for the new release
+2. Create a new with `git tag -a v0.0.0 -m "v0.0.0" -s`
+3. Push the tag with `git push --tags` which will trigger `goreleaser` to build new binaries

README.md

@@ -1,34 +1,21 @@
 # Zet-cmd
 
-[![License](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](LICENSE)
-
-## Install
+> A command line tool for managing a personal Zettelkasten
 
-This command can be installed as a standalone program or composed into a
-Bonzai command tree.
+This is a CLI tool for managing zet's or notes. It allows me to capture ideas and thoughts from the command line.
+GitHub is used as the "database" for note storage. This has the added benefit of being publicly available without
+the need for the CLI.
 
-Standalone
+These *zet's* are also available on my [blog](https://danielms.site/zet). I have written a [blog post](https://danielms.site/blog/github-actions-auto-publish-zettelkasten-notes/)
+about how I use GitHub Actions to automatically publish these notes.
 
-```
-go install github.com/danielmichaels/zet-cmd/cmd/zet@latest
-```
-Composed
-
-```go
-package zet
+[![License](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](LICENSE)
 
-import (
-	Z "github.com/rwxrob/bonzai/z"
-	"github.com/rwxrob/help"
-	"github.com/danielmichaels/zet-cmd"
-)
+## Install
 
-var Cmd = &Z.Cmd{
-	Name:     `zet`,
-	Commands: []*Z.Cmd{help.Cmd, zet.Cmd},
-}
+```bash
+go install github.com/danielmichaels/zet-cmd/cmd/zet@latest
 ```
-
 ## Requirements
 
 `zet-cmd` must have a GitHub repository to push commits to named `zet`. For instance, my 
@@ -49,28 +36,8 @@ On a new machine (but existing `zet` repo), you will need to `git clone` to the
 paths. Any `false` values or empty `Repo` entries will need to be rectified or your `zet-cmd` may
 not function as expected, or at all.
 
-## Tab Completion
-
-To activate bash completion just use the `complete -C` option from your
-`.bashrc` or command line. There is no messy sourcing required. All the
-completion is done by the program itself.
-
-```
-complete -C zet zet
-```
-
-If you don't have bash or tab completion check use the shortcut
-commands instead.
-
-## Embedded Documentation
-
-All documentation (like manual pages) has been embedded into the source
-code of the application. See the source or run the program with help to
-access it.
+### Inspiration
 
-## Other Examples
+A lot of this was inspired by [rwxrob](https://github.com/rwxrob/)
 
-* <https://github.com/rwxrob/cmd-zet> - with heavy inspiration
-* <https://github.com/danielmichaels/ds> - my personal Bonzai commander
- 
 [ghzet]: https://github.com/danielmichaels/zet

cmd.go

@@ -1,9 +1,71 @@
-// Copyright 2022-2024 zet-cmd Authors
-// SPDX-License-Identifier: Apache-2.0
-
 package main
 
-import "github.com/danielmichaels/zet-cmd"
+import (
+	"fmt"
+	"github.com/danielmichaels/zet-cmd"
+	"github.com/danielmichaels/zet-cmd/internal/version"
+	"os"
+
+	"github.com/alecthomas/kong"
+)
+
+const appName = "zet"
+
+type VersionFlag string
+
+func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
+func (v VersionFlag) IsBool() bool                       { return true }
+func (v VersionFlag) BeforeApply(app *kong.Kong, vars kong.Vars) error {
+	fmt.Println(vars["version"])
+	app.Exit(0)
+	return nil
+}
+
+type CLI struct {
+	Version VersionFlag `help:"Print version information and quit" name:"version"`
+	zet.Globals
+
+	// Commands
+	Create zet.CreateCmd `cmd:"" aliases:"new" help:"Create a new zet"`
+	Last   zet.LastCmd   `cmd:"" help:"Show the last created zet's isosec (location)'"`
+	Edit   zet.EditCmd   `cmd:"" help:"Edit a zet"`
+	Find   zet.FindCmd   `cmd:"" help:"Search for a zet title and retrieve any matching entry"`
+	Check  zet.CheckCmd  `cmd:"" help:"Check zettelkasten for issues"`
+	Tags   zet.TagsCmd   `cmd:"" help:"Search for a zet by tag and retrieve any entries with that tag"`
+	Git    zet.GitCmd    `cmd:"" help:"Git operations for zettelkasten"`
+	View   zet.ViewCmd   `cmd:"" help:"View supports both direct 'isosec' lookup's and keyword searches"`
+}
+
+func run() error {
+	ver := version.Get()
+	if ver == "unavailable" {
+		ver = "development"
+	}
+	cli := CLI{
+		Version: VersionFlag(ver),
+	}
+	// Display help if no args are provided instead of an error message
+	if len(os.Args) < 2 {
+		os.Args = append(os.Args, "--help")
+	}
 
-// tree grown from branch
-func main() { zet.Cmd.Run() }
+	ctx := kong.Parse(&cli,
+		kong.Name(appName),
+		kong.Description(fmt.Sprintf("%s is a zettelkasten tool", appName)),
+		kong.UsageOnError(),
+		kong.ConfigureHelp(kong.HelpOptions{
+			Compact: true,
+		}),
+		kong.DefaultEnvars(appName),
+		kong.Vars{
+			"version": string(cli.Version),
+		})
+	err := ctx.Run(cli.Globals)
+	ctx.FatalIfErrorf(err)
+	return nil
+}
+func main() {
+	if err := run(); err != nil {
+		os.Exit(1)
+	}
+}