https://github.com/google/vim-maktaba

Consistent Vimscript
https://github.com/google/vim-maktaba

vim

Last synced: 3 months ago
JSON representation

Consistent Vimscript

• Host: GitHub
• URL: https://github.com/google/vim-maktaba
• Owner: google
• License: apache-2.0
• Created: 2013-12-05T21:59:43.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-03-21T11:14:43.000Z (over 1 year ago)
• Last Synced: 2024-06-16T09:36:08.724Z (5 months ago)
• Topics: vim
• Language: Vim Script
• Homepage:
• Size: 784 KB
• Stars: 588
• Watchers: 29
• Forks: 42
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Maktaba is a vimscript plugin library. It is designed for plugin authors.

Features include:

* Plugin objects (for manipulating plugins in vimscript)

* Plugin flags (used to configure plugins without global settings)

* Universal logger interface

* Dependency management tools

* Real closures

Maktaba advocates a plugin structure that, when adhered to, gives the plugin

access to many powerful tools such as configuration flags. Within Google, these

conventions standardize behavior across a wide variety of plugins.

Also contained are many utility functions that ease the pain of working with

vimscript. This includes, among other things:

* Exception handling

* Variable type enforcement

* Filepath manipulation

# Usage example

Maktaba plugins can be installed using any plugin manager. However, maktaba

plugins make heavy use of dependency management, so it's recommended to use a

plugin manager with dependency management capabilities, like

[VAM](https://github.com/MarcWeber/vim-addon-manager).

Installation of a few plugins using VAM looks something like

```vim

set runtimepath+=~/.vim/bundle/vim-addon-manager/

" Loads glaive, vtd, and their maktaba dependency.

call vam#ActivateAddons(['glaive', 'vtd'])

" Initializes all maktaba plugins.

call maktaba#plugin#Detect()

```

# Plugins Using Maktaba

Several vim plugins are

[already using maktaba](https://github.com/google/maktaba/wiki/Plugins-Using-Maktaba).

As a user, you can generally expect these plugins to be configurable using

[Glaive](https://github.com/google/glaive) and be more well-behaved in terms of

things like defining unwanted global mappings and variables and avoiding

annoying side-effects like moving your cursor.

Plugin authors should consider developing plugins using maktaba to simplify

code, support modular plugins with hassle-free dependency management, and avoid

common pitfalls. If you've written a plugin using maktaba, please add it to the

list above and share feedback.

# Further reading

In the `vroom/` directory you'll find literate test files that walk you through

maktaba features in depth. `vroom/main.vroom` is a good place to start.

In the `examples/` directory you can find an example maktaba plugin to give you

a feel for how maktaba plugins look.

In the `doc/` directory you'll find helpfiles for maktaba. These are also

available via `:help maktaba` if maktaba has been installed and helptags have

been generated. The help files document the maktaba API in its entirety.