runtime/help/plugins.md

   1 # Plugins
   2
   3 Micro supports creating plugins with a simple Lua system. Every plugin has a
   4 main script which is run at startup which should be placed in
   5 `~/.config/micro/plugins/pluginName/pluginName.lua`.
   6
   7 There are a number of callback functions which you can create in your
   8 plugin to run code at times other than startup. The naming scheme is
   9 `onAction(view)`. For example a function which is run every time the user saves
  10 the buffer would be:
  11
  12 ```lua
  13 function onSave(view)
  14     ...
  15     return false
  16 end
  17 ```
  18
  19 The `view` variable is a reference to the view the action is being executed on.
  20 This is almost always the current view, which you can get with `CurView()` as well.
  21
  22 All available actions are listed in the keybindings section of the help.
  23
  24 These functions should also return a boolean specifying whether the view
  25 should be relocated to the cursor or not after the action is complete.
  26
  27 Note that these callbacks occur after the action has been completed. If you
  28 want a callback before the action is executed, use `preAction()`. In this case
  29 the boolean returned specifies whether or not the action should be executed
  30 after the lua code completes.
  31
  32 Another useful callback to know about which is not a action is
  33 `onViewOpen(view)` which is called whenever a new view is opened and the new
  34 view is passed in. This is useful for setting local options based on the filetype,
  35 for example turning off `tabstospaces` only for Go files when they are opened.
  36
  37 ---
  38
  39 There are a number of functions and variables that are available to you in
  40 order to access the inner workings of micro. Here is a list (the type signatures
  41 for functions are given using Go's type system):
  42
  43 * `OS`: variable which gives the OS micro is currently running on (this is the same
  44 as Go's GOOS variable, so `darwin`, `windows`, `linux`, `freebsd`...)
  45
  46 * `configDir`: contains the path to the micro configuration files
  47
  48 * `tabs`: a list of all the tabs currently in use
  49
  50 * `curTab`: the index of the current tabs in the tabs list
  51
  52 * `messenger`: lets you send messages to the user or create prompts
  53
  54 * `RuneStr(r rune) string`: returns a string containing the given rune
  55
  56 * `Loc(x, y int) Loc`: returns a new `Loc` struct
  57
  58 * `JoinPaths(dir... string) string` combines multiple directories to a full path
  59
  60 * `GetOption(name string)`: returns the value of the requested option
  61
  62 * `AddOption(name string, value interface{})`: sets the given option with the given
  63    value (`interface{}` means any type in Go)
  64
  65 * `SetOption(option, value string)`: sets the given option to the value. This will
  66    set the option globally, unless it is a local only option.
  67
  68 * `SetLocalOption(option, value string, buffer *Buffer)`: sets the given option to
  69    the value locally in the given buffer
  70
  71 * `BindKey(key, action string)`: binds `key` to `action`
  72
  73 * `MakeCommand(name, function string, completions ...Completion)`:
  74    creates a command with `name` which will call `function` when executed.
  75    Use 0 for completions to get NoCompletion.
  76
  77 * `MakeCompletion(function string)`:
  78    creates a `Completion` to use with `MakeCommand`
  79
  80 * `CurView()`: returns the current view
  81
  82 * `HandleCommand(cmd string)`: runs the given command
  83
  84 * `HandleShellCommand(shellCmd string, interactive bool, waitToClose bool)`: runs the given shell
  85    command. The `interactive` bool specifies whether the command should run in the background. The
  86    `waitToClose` bool only applies if `interactive` is true and means that it should wait before
  87    returning to the editor.
  88
  89 * `JobStart(cmd string, onStdout, onStderr, onExit string, userargs ...string)`:
  90    Starts running the given shell command in the background. `onStdout` `onStderr` and `onExit`
  91    are callbacks to lua functions which will be called when the given actions happen
  92    to the background process.
  93    `userargs` are the arguments which will get passed to the callback functions
  94
  95 * `JobSend(cmd *exec.Cmd, data string)`: send a string into the stdin of the job process
  96
  97 * `JobStop(cmd *exec.Cmd)`: kill a job
  98
  99 This may seem like a small list of available functions but some of the objects
 100 returned by the functions have many methods. `CurView()` returns a view object
 101 which has all the actions which you can call. For example `CurView():Save(false)`.
 102 You can see the full list of possible actions in the keybindings help topic.
 103 The boolean on all the actions indicates whether or not the lua callbacks should
 104 be run. I would recommend generally sticking to false when making a plugin to
 105 avoid recursive problems, for example if you call `CurView():Save(true)` in `onSave()`.
 106 Just use `CurView():Save(false)` so that it won't call `onSave()` again.
 107
 108 Using the view object, you can also access the buffer associated with that view
 109 by using `CurView().Buf`, which lets you access the `FileType`, `Path`, `Name`...
 110
 111 The possible methods which you can call using the `messenger` variable are:
 112
 113 * `messenger.Message(msg ...interface{})`
 114 * `messenger.Error(msg ...interface{})`
 115 * `messenger.YesNoPrompt(prompt string) (bool, bool)`
 116 * `messenger.Prompt(prompt, historyType string, completionType Completion) (string, bool)`
 117
 118 If you want a standard prompt, just use `messenger.Prompt(prompt, "", 0)`
 119
 120 # Adding help files, syntax files, or colorschemes in your plugin
 121
 122 You can use the `AddRuntimeFile(name, type, path string)` function to add various kinds of
 123 files to your plugin. For example, if you'd like to add a help topic and to your plugin
 124 called `test`, you would create the `test.md` file for example, and runt the function:
 125
 126 ```lua
 127 AddRuntimeFile("test", "help", "test.md")
 128 ```
 129
 130 Use `AddRuntimeFilesFromDirectory(name, type, dir, pattern)` to add a number of files
 131 to the runtime.
 132
 133 # Autocomplete command arguments
 134
 135 See this example to learn how to use `MakeCompletion` and `MakeCommand`
 136
 137 ```lua
 138 local function StartsWith(String,Start)
 139   String = String:upper()
 140   Start = Start:upper()
 141   return string.sub(String,1,string.len(Start))==Start
 142 end
 143
 144 function complete(input)
 145   local allCompletions = {"Hello", "World", "Foo", "Bar"}
 146   local result = {}
 147
 148   for i,v in pairs(allCompletions) do
 149   if StartsWith(v, input) then
 150        table.insert(result, v)
 151      end
 152    end
 153    return result
 154 end
 155
 156 function foo(arg)
 157   messenger:Message(arg)
 158 end
 159
 160 MakeCommand("foo", "example.foo", MakeCompletion("example.complete"))
 161 ```
 162
 163 # Default plugins
 164
 165 For examples of plugins, see the default plugins `linter`, `go`, and `autoclose`.
 166 They are stored in Micro's GitHub repository [here](https://github.com/zyedidia/micro/tree/master/runtime/plugins).