pkg/gui/services/custom_commands/keybinding_creator.go - master - githubmirror/lazygit

pkg/gui/services/custom_commands/keybinding_creator.go
88 строк3 KB
Stefan Haller
Convert custom command Key fields to Keybinding
25 май 2026, 16:32
25 май 2026, 16:32fbcf562
package custom_commands

import (
	"fmt"
	"strings"

	"github.com/jesseduffield/lazygit/pkg/config"
	"github.com/jesseduffield/lazygit/pkg/gui/context"
	"github.com/jesseduffield/lazygit/pkg/gui/controllers/helpers"
	"github.com/jesseduffield/lazygit/pkg/gui/types"
	"github.com/samber/lo"
)

// KeybindingCreator takes a custom command along with its handler and returns a corresponding keybinding
type KeybindingCreator struct {
	c *helpers.HelperCommon
}

func NewKeybindingCreator(c *helpers.HelperCommon) *KeybindingCreator {
	return &KeybindingCreator{
		c: c,
	}
}

func (self *KeybindingCreator) call(customCommand config.CustomCommand, handler func() error) ([]*types.Binding, error) {
	if customCommand.Context == "" {
		return nil, formatContextNotProvidedError(customCommand)
	}

	viewNames, err := self.getViewNamesAndContexts(customCommand)
	if err != nil {
		return nil, err
	}

	return lo.Map(viewNames, func(viewName string, _ int) *types.Binding {
		return &types.Binding{
			ViewName:    viewName,
			Keys:        config.GetValidatedKeyBindingKeys(customCommand.Key),
			Handler:     handler,
			Description: customCommand.GetDescription(),
		}
	}), nil
}

func (self *KeybindingCreator) getViewNamesAndContexts(customCommand config.CustomCommand) ([]string, error) {
	if customCommand.Context == "global" {
		return []string{""}, nil
	}

	contexts := strings.Split(customCommand.Context, ",")
	contexts = lo.Map(contexts, func(context string, _ int) string {
		return strings.TrimSpace(context)
	})

	viewNames := []string{}
	for _, context := range contexts {
		ctx, ok := self.contextForContextKey(types.ContextKey(context))
		if !ok {
			return []string{}, formatUnknownContextError(customCommand)
		}

		viewNames = append(viewNames, ctx.GetViewName())
	}

	return viewNames, nil
}

func (self *KeybindingCreator) contextForContextKey(contextKey types.ContextKey) (types.Context, bool) {
	for _, context := range self.c.Contexts().Flatten() {
		if context.GetKey() == contextKey {
			return context, true
		}
	}

	return nil, false
}

func formatUnknownContextError(customCommand config.CustomCommand) error {
	allContextKeyStrings := lo.Map(context.AllContextKeys, func(key types.ContextKey, _ int) string {
		return string(key)
	})

	return fmt.Errorf("Error when setting custom command keybindings: unknown context: %s. Key: %s, Command: %s.\nPermitted contexts: %s", customCommand.Context, customCommand.Key.String(), customCommand.Command, strings.Join(allContextKeyStrings, ", "))
}

func formatContextNotProvidedError(customCommand config.CustomCommand) error {
	return fmt.Errorf("Error parsing custom command keybindings: context not provided (use context: 'global' for the global context). Key: %s, Command: %s", customCommand.Key.String(), customCommand.Command)
}