mirror of https://github.com/rwxrob/z
Initial commit
commit
57b5b6da4a
@ -0,0 +1,5 @@
|
||||
github: rwxrob
|
||||
patreon: rwxrob
|
||||
custom:
|
||||
- https://twitch.tv/rwxrob
|
||||
- https://youtube.com/rwxrob
|
@ -0,0 +1,59 @@
|
||||
By contributing to this project Git repo, you are deemed to have
|
||||
accepted the agreement (DCO, or Corporate or Individual CLA attached
|
||||
below) applicable to your contribution.
|
||||
|
||||
Any merge request, issue posts, commits, comments, wiki updates, and any
|
||||
other content development and contribution legally constitutes digitally
|
||||
signed acceptance of the terms in the attached DCO below, meaning that
|
||||
any contribution to this project -- in any way -- releases any legal
|
||||
claim on those contributions including copyright, patents, trademarks,
|
||||
and any other intellectual property rights. It is the responsibility of
|
||||
all would-be contributors to legally ensure that they indeed have those
|
||||
rights themselves including, but not limited to, authorization from
|
||||
their employers to whom they may have given up those rights, knowingly
|
||||
or otherwise. Any contribution, including those in violation of this
|
||||
agreement, shall become the legal intellectual property of this project
|
||||
and its owners. Any violation of this agreement must be resolved between
|
||||
the contributors and those with whom such disputes exist and shall in no
|
||||
way involve this project, its owners, maintainers, or any other
|
||||
contributors who have legally submitted content to this project without
|
||||
violation.
|
||||
|
||||
------------------ Developer Certificate of Origin -----------------
|
||||
|
||||
Developer Certificate of Origin
|
||||
Version 1.1
|
||||
|
||||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||
1 Letterman Drive
|
||||
Suite D4700
|
||||
San Francisco, CA, 94129
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
Developer's Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
(a) The contribution was created in whole or in part by me and I
|
||||
have the right to submit it under the open source license
|
||||
indicated in the file; or
|
||||
|
||||
(b) The contribution is based upon previous work that, to the best
|
||||
of my knowledge, is covered under an appropriate open source
|
||||
license and I have the right under that license to submit that
|
||||
work with modifications, whether created in whole or in part
|
||||
by me, under the same open source license (unless I am
|
||||
permitted to submit under a different license), as indicated
|
||||
in the file; or
|
||||
|
||||
(c) The contribution was provided directly to me by some other
|
||||
person who certified (a), (b) or (c) and I have not modified
|
||||
it.
|
||||
|
||||
(d) I understand and agree that this project and the contribution
|
||||
are public and that a record of the contribution (including all
|
||||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2020 Rob Muhlestein
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
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.
|
@ -0,0 +1,56 @@
|
||||
# Bonzai™ Sample `foo` Command (Template)
|
||||
|
||||
*Create a new GitHub project using this template and change this
|
||||
README.md to match your project. Make all your template changes before
|
||||
making your first commit.*
|
||||
|
||||
![WIP](https://img.shields.io/badge/status-wip-red)
|
||||
![Go Version](https://img.shields.io/github/go-mod/go-version/rwxrob/foo)
|
||||
[![GoDoc](https://godoc.org/github.com/rwxrob/foo?status.svg)](https://godoc.org/github.com/rwxrob/foo)
|
||||
[![License](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](LICENSE)
|
||||
|
||||
## Install
|
||||
|
||||
This command can be installed as a standalone program or composed into
|
||||
a Bonzai command tree.
|
||||
|
||||
Standalone
|
||||
|
||||
```
|
||||
go install github.com/rwxrob/foo/foo@latest
|
||||
```
|
||||
|
||||
Composed
|
||||
|
||||
```go
|
||||
package cmds
|
||||
|
||||
import (
|
||||
"github.com/rwxrob/bonzai"
|
||||
"github.com/rwxrob/foo"
|
||||
)
|
||||
|
||||
var Cmd = &bonzai.Cmd{
|
||||
Name: `cmds`,
|
||||
Commands: []*bonzai.Cmd{help.Cmd, foo.Cmd},
|
||||
}
|
||||
```
|
||||
|
||||
## 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 foo foo
|
||||
```
|
||||
|
||||
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.
|
@ -0,0 +1,82 @@
|
||||
package foo
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"github.com/rwxrob/bonzai"
|
||||
"github.com/rwxrob/bonzai/comp"
|
||||
"github.com/rwxrob/bonzai/inc/help"
|
||||
)
|
||||
|
||||
var Cmd = &bonzai.Cmd{
|
||||
|
||||
Name: `foo`,
|
||||
Summary: `just a sample foo command`,
|
||||
Usage: `[B|bar|own|h|help]`,
|
||||
Version: `v0.0.1`,
|
||||
Copyright: `Copyright 2021 Robert S Muhlestein`,
|
||||
License: `Apache-2.0`,
|
||||
Commands: []*bonzai.Cmd{help.Cmd, Bar, own},
|
||||
|
||||
Description: `
|
||||
The foo commands do foo stuff. You can start the description here
|
||||
and wrap it to look nice and it will just work. Descriptions are
|
||||
written in BonzaiMark™, a simplification of CommonMark that that
|
||||
mostly follows Go documentation guidelines`,
|
||||
|
||||
Other: map[string]string{
|
||||
`foo`: `something about foo`,
|
||||
`another`: `something about another command`,
|
||||
},
|
||||
|
||||
// no Call since has Commands, if had Call would only call if
|
||||
// commands didn't match
|
||||
}
|
||||
|
||||
// Commands can be grouped into the same file or separately, public or
|
||||
// private. Public let's others compose specific subcommands (foo.Bar),
|
||||
// private just keeps it composed and only available within this Bonzai
|
||||
// command.
|
||||
|
||||
// Aliases are not commands but will be replaced by their target names.
|
||||
|
||||
var Bar = &bonzai.Cmd{
|
||||
Name: `bar`,
|
||||
Aliases: []string{"B", "notbar"}, // to make a point
|
||||
Commands: []*bonzai.Cmd{help.Cmd, file},
|
||||
|
||||
// Call first-class functions can be highly detailed, refer to an
|
||||
// existing function someplace else, or can call high-level package
|
||||
// library functions. Developers are encouraged to consider well where
|
||||
// they maintain the core logic of their applications. Often, it will
|
||||
// not be here within the bonzai.Cmd definition. One use case for
|
||||
// decoupled first-class Call functions is when creating multiple
|
||||
// binaries for different target languages. In such cases this
|
||||
// bonzai.Cmd definition is essentially just a wrapper for
|
||||
// documentation and other language-specific embedded assets.
|
||||
|
||||
Call: func(_ *bonzai.Cmd, _ ...string) error { // note conventional _
|
||||
log.Printf("would bar stuff")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
// Different completion methods are be set including the expected
|
||||
// standard ones from bash and other shells. Not that these completion
|
||||
// methods only work if the shell supports completion (including
|
||||
// the Bonzai Shell, which can be set as the default Cmd to provide rich
|
||||
// shell interactivity where normally no shell is available, such as in
|
||||
// FROM SCRATCH containers that use a Bonzai tree as the core binary).
|
||||
|
||||
var file = &bonzai.Cmd{
|
||||
Name: `file`,
|
||||
Commands: []*bonzai.Cmd{help.Cmd},
|
||||
Completer: comp.File,
|
||||
Call: func(x *bonzai.Cmd, args ...string) error {
|
||||
if len(args) == 0 {
|
||||
return x.UsageError()
|
||||
}
|
||||
log.Printf("would show file information about %v", args[0])
|
||||
return nil
|
||||
},
|
||||
}
|
@ -0,0 +1,5 @@
|
||||
package main
|
||||
|
||||
import "github.com/rwxrob/foo"
|
||||
|
||||
func main() { foo.Cmd.Run() }
|
@ -0,0 +1,32 @@
|
||||
package foo
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"log"
|
||||
"os"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// Unlike other Go projects, Bonzai commands don't really benefit from
|
||||
// Go's example-based tests (which normally would be in package
|
||||
// foo_test). Instead, testing should be against the first-class Call
|
||||
// functions directly (with nil callers) or the high-level functions
|
||||
// from a package library into which they call themselves (which might
|
||||
// have their own example and other tests).
|
||||
|
||||
func TestBar(t *testing.T) {
|
||||
|
||||
// capture the output
|
||||
buf := new(bytes.Buffer)
|
||||
log.SetFlags(0)
|
||||
log.SetOutput(buf)
|
||||
defer log.SetFlags(log.Flags())
|
||||
defer log.SetOutput(os.Stderr)
|
||||
|
||||
Bar.Call(nil)
|
||||
|
||||
t.Log(buf)
|
||||
if buf.String() != "would bar stuff\n" {
|
||||
t.Fail()
|
||||
}
|
||||
}
|
@ -0,0 +1,19 @@
|
||||
go 1.18
|
||||
|
||||
// Add relative paths to repos of things you don't want to `go get`
|
||||
// every time. Always include . or example tests requiring full
|
||||
// references to package imports will fail. Read go work -h for more.
|
||||
// Packages upon which bonzai depends have been included for convenience
|
||||
// but can be removed without worry by most.
|
||||
|
||||
use (
|
||||
.
|
||||
../bonzai
|
||||
../fn
|
||||
../fs
|
||||
../json
|
||||
../scan
|
||||
../structs
|
||||
../term
|
||||
../to
|
||||
)
|
@ -0,0 +1,21 @@
|
||||
package foo
|
||||
|
||||
// Go treats all files as if they are, more or less, in the same large
|
||||
// file. Create separate files to help you and others find the code you
|
||||
// need quickly.
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
// if typing bonzai becomes tedious use capital Z as a convention
|
||||
|
||||
Z "github.com/rwxrob/bonzai"
|
||||
)
|
||||
|
||||
var own = &Z.Cmd{
|
||||
Name: `own`,
|
||||
Call: func(caller *Z.Cmd, none ...string) error {
|
||||
log.Print("I'm in my own file.")
|
||||
return nil
|
||||
},
|
||||
}
|
Loading…
Reference in New Issue