compcmd

package module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 30, 2022 License: Apache-2.0 Imports: 3 Imported by: 3

README

🌳 Go Bonzai™ Command Completer

GoDoc License

This is the default bonzai.Completer assigned to Z.Comp. All bonzai.Commands that do not have a completer already assigned will use this one unless the Bonzai command tree developer overrides the Z.Comp package global.

Style Guidelines

  • Everything through go fmt or equiv, no exceptions
  • In Vim set textwidth=72 (not 80 to line numbers fit)
  • Use /* */ for package documentation comment, // elsewhere
  • Smallest possible names for given scope while still clear
  • Favor additional packages (possibly in internal) over long names
  • Package globals that will be used a lot can be single capital
  • Must be good reason to use more than 4 character pkg name
  • Avoid unnecessary comments
  • Use "deciduous tree" emoji 🌳 to mark Bonzai stuff

Copyright 2022 Robert S. Muhlestein (mailto:rob@rwx.gg)
SPDX-License-Identifier: Apache-2.0

"Bonzai" and "bonzai" are legal trademarks of Robert S. Muhlestein but can be used freely to refer to the Bonzai™ project https://github.com/rwxrob/bonzai without limitation. To avoid potential developer confusion, intentionally using these trademarks to refer to other projects --- free or proprietary --- is prohibited.

Documentation

Overview

Package compcmd is a completion driver for Bonzai command trees and fulfills the bonzai.Completer package interface. See Complete method for details.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() *comp

New returns a private struct that fulfills the bonzai.Completer interface. See Complete method for details.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL