summaryrefslogtreecommitdiff
path: root/lua/99/ops/init.lua
diff options
context:
space:
mode:
Diffstat (limited to 'lua/99/ops/init.lua')
-rw-r--r--lua/99/ops/init.lua29
1 files changed, 27 insertions, 2 deletions
diff --git a/lua/99/ops/init.lua b/lua/99/ops/init.lua
index 1f8e9f8..e4596c2 100644
--- a/lua/99/ops/init.lua
+++ b/lua/99/ops/init.lua
@@ -1,10 +1,35 @@
--- @class _99.ops.Opts
+--- The options that are used throughout all the interations with 99. This
+--- includes search, visual, and others
+---
+--- @docs included
--- @field additional_prompt? string
+--- by providing `additional_prompt` you will not be required to provide a prompt.
+--- this allows you to define actions based on remaps
+---
+--- ```lua
+--- remap("n", "<leader>9d", function()
+--- --- this function could be used to auto debug your project
+--- _99.search({
+--- additional_prompt = [[
+--- run `make test` and debug the test failures and provide me a comprehensive set of steps where
+--- the tests are breaking ]]
+--- })
+--- end)
+--- ```
+---
+--- This would kick off a search job that will run your tests in the background.
+--- the resulting failures would be diagnosed and search results would be transfered
+--- into a quick fix list.
--- @field additional_rules? _99.Agents.Rule[]
+--- can be used to provide extra args. If you have a skill called "cloudflare" you could
+--- provide the rule for cloudflare and its context will be injected into your request
--- @class _99.ops.SearchOpts : _99.ops.Opts
---- @field open_on_results? boolean
---- @field open_to_qfix? boolean
+--- See `_99.opts.Opts` for more information.
+---
+--- There are no properties yet. But i would like to tweek some behavior based on opts
+--- @docs included
return {
search = require("99.ops.search"),