Add Configuration

[TheReptar]

Resolves (partially) #45 Resolves (partially) #51 Resolves #73

Context:

• There are a couple open issues that request alternative mappings to existing actions.

  • 45

  • 51

  • 73

• Users will likely continue to request alternative mappings well into the future to accommodate preference or accessibility needs.
• It's neither feasible nor desirable to manually add every possible alternative mapping to the codebase.
• Some users may not like the new or additional mappings, or may wish to disable certain functionality altogether.

Changes (Functional):

• Users can configure mappings for any keyXYZ action using a json configuration file.
  • By default this configuration file will be searched for at ~/.config/llama/config.json, but this may be overridden using the LLAMA_CONFIG environment variable.
  • Any of the properties contained in the charmbracelet/bubbles key.Binding struct may be overridden.
• Example configuration file:

  {
  "bindings": [
    // {
    //   action   : string
    //   keys     : string[]
    //   disabled : boolean
    //   help     : { key : string, desc: string }
    // }
    {
      "action": "keyQuit",
      "keys": [ "q", "tab" ],  // Bind keyQuit to activate with 'q' or 'tab' instead of `esc`
    },
    {
      "action": "keyDelete",
      "disabled": true         // Disable the keyDelete action
    }
  ]
  }

Code Changes:

• New file in main package: configuration.go
  • Resolves LLAMA_CONFIG environment variable or default configuration path and reads the configuration file.
  • Maps action strings to key.Binding struct references, and overrides the binding's properties with any values found in the configuration file.
• Add configuration processing as the first step during application launch.

Additional Notes & Tech Debt:

• As new actions are added in main.go, those actions should be added to the map in configuration.go to ensure user's can configure their key bindings.

[guy-av]

Very cool @TheReptar !

I see you add help for bindings, what about adding help text to the bottom of llama's tui? Bubbletea provides such functionality already via help.Model.

[TheReptar]

Force pushed to rebase on #53

[TheReptar]

Very cool @TheReptar !

I see you add help for bindings, what about adding help text to the bottom of llama's tui? Bubbletea provides such functionality already via help.Model.

I added the help property to the bindings config because I wanted the config to match the existing charmbracelet/bubbles key.Binding struct as much as possible.

As you point out though, we're not currently using the help for anything but some help text at the bottom of the tui would be cool! As far as the configuration is concerned it should basically be plug and play; users will have fine-grained control over what shows up after it's been implemented as long as we leverage the charmbracelet/bubbles key.Help struct.

I may be able to tackle that in a separate PR if that's something y'all would be interested in.

[guy-av]

It is a cool concept, I already started tackling it and will open a PR soon, would love to rebase on top of your PR to make it configurable.

[TheReptar]

@antonmedv What are your thoughts on merging this PR? Is there anything missing?

[antonmedv]

Will try to review PR soon. Got lot of work on other projects)

[TheReptar]

Force pushed to rebase on #67

[TheReptar]

@antonmedv I cleaned up the branch to accommodate recent activity on master, so should be safe to review/merge whenever you're ready 👍

[TheReptar]

Closing because this project appears to be unmaintained or there isn't sufficient interest in configurability to merge this PR.