bettervim / better-tmux Goto Github PK

In addition to supporting UI customizations, we plan to offer a basic way to create custom bindings:

export default {
   bindings: [
    {
      key:  'C-c',
      command: 'new-window',
   },
   {
     key: 'h',
     command: 'select-pane',
     options: ['-L']
    }
}

# tmux.conf
bind C-c new-window -L
bind h select-pane -L

We're currently lacking documentation. Since it's crucial for the developer experience (DX), we need to create comprehensive documentation, tutorials, and examples. We can start by creating a docs/ directory and adding some .md files.

For this initial version, we should document:

• Motivation
• Installation / Update
• Basic usage
• API Reference:
  • widgets
  • hooks
  • better-tmux exported functions, objects, etc

As I have been using tmux for a long time, I have configured oh-my-tmux on my machine. I think many users will have this pre-configured. The idea would be to have instructions in the documentation on how to install better-tmux for those who already have oh-my-zsh configured.

In this case, I managed to remove it here by removing the oh-my-tmux repo from my environment, but it may be recurring for other users.

Reference:
gpakosz/.tmux#678 (comment)

Since the configurations are simply objects exported and read by the CLI, we could offer pre-built configurations with various options for the status bar (left), window management, theming, and more.

import { minimal } from 'better-tmux/presets''

export default minimal

Customizing:

import { minimal } from 'better-tmux/presets'

export default {
  ...minimal, 
  theme: 'nord'
}

We plan to offer a way to modify global options with the following API:

export default {
  options: {
    prefix: 'C-a',
    baseIndex: 1,
    historyLimit: 10000,
    defaultTerminal: 'screen-256color',
    mouse: true,
    renumberWindows: true,
    aggressiveResize: true,
  }
}