|
| 1 | +Use this example as a convention for helper functions: |
| 2 | +``` |
| 3 | +---@param name string # name of the augroup |
| 4 | +---@param opts table | nil # options for the augroup |
| 5 | +---@return number # returns augroup id |
| 6 | +_H.create_augroup = function(name, opts) |
| 7 | + ... |
| 8 | +end |
| 9 | +
|
| 10 | +---@param file_name string # name of the file for which to get buffer |
| 11 | +---@return number | nil # buffer number |
| 12 | +_H.get_buffer = function(file_name) |
| 13 | + ... |
| 14 | +end |
| 15 | +``` |
| 16 | + |
| 17 | +The function assignment is preferred over: |
| 18 | +``` |
| 19 | +function _H.create_augroup(name, opts) |
| 20 | + ... |
| 21 | +end |
| 22 | +``` |
| 23 | + |
| 24 | +Module has following structure: |
| 25 | +```lua |
| 26 | +local uv = vim.uv or vim.loop |
| 27 | + |
| 28 | +local config = require("gp.config") |
| 29 | + |
| 30 | +local M = { |
| 31 | + _Name = "Gp", -- plugin name |
| 32 | + _state = {}, -- table of state variables |
| 33 | + agents = {}, -- table of agents |
| 34 | + cmd = {}, -- default command functions |
| 35 | + config = {}, -- config variables |
| 36 | + hooks = {}, -- user defined command functions |
| 37 | + defaults = require("gp.defaults"), -- some useful defaults |
| 38 | + deprecator = require("gp.deprecator"), -- handle deprecated options |
| 39 | + helpers = require("gp.helper"), -- helper functions |
| 40 | + imager = require("gp.imager"), -- imager module |
| 41 | + logger = require("gp.logger"), -- logger module |
| 42 | + render = require("gp.render"), -- render module |
| 43 | + spinner = require("gp.spinner"), -- spinner module |
| 44 | + tasker = require("gp.tasker"), -- tasker module |
| 45 | + vault = require("gp.vault"), -- vault module |
| 46 | + whisper = require("gp.whisper"), -- whisper module |
| 47 | +} |
| 48 | +``` |
| 49 | + |
0 commit comments