From 7c05701eedc190a7c69e5d46f9be95583378afdb Mon Sep 17 00:00:00 2001 From: chrisgrieser Date: Sat, 7 Oct 2023 10:02:22 +0000 Subject: [PATCH] chore: Auto generate docs --- doc/spider.txt | 47 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/doc/spider.txt b/doc/spider.txt index 31bc85e..35cfffb 100644 --- a/doc/spider.txt +++ b/doc/spider.txt @@ -1,4 +1,4 @@ -*spider.txt* For NVIM v0.8.0 Last change: 2023 September 14 +*spider.txt* For NVIM v0.8.0 Last change: 2023 October 07 ============================================================================== Table of Contents *spider-table-of-contents* @@ -19,9 +19,10 @@ Table of Contents *spider-table-of-contents* Usethe `w`, `e`, `b` motions like a spider. Move by subwords and skip insignificant punctuation. -Lua implementation of CamelCaseMotion, with extra consideration of punctuation. -Works in normal, visual, and operator-pending mode. Supports counts and -dot-repeat. +A lua implementation of CamelCaseMotion +, with extra consideration of +punctuation. Works in normal, visual, and operator-pending mode. Supports +counts and dot-repeat. - |spider-features| - |spider-subword-motion| @@ -103,10 +104,30 @@ No keybindings are created by default. Below are the mappings to replace the default `w`, `e`, and `b` motions with this plugin’s version of them. >lua - vim.keymap.set({"n", "o", "x"}, "w", "lua require('spider').motion('w')", { desc = "Spider-w" }) - vim.keymap.set({"n", "o", "x"}, "e", "lua require('spider').motion('e')", { desc = "Spider-e" }) - vim.keymap.set({"n", "o", "x"}, "b", "lua require('spider').motion('b')", { desc = "Spider-b" }) - vim.keymap.set({"n", "o", "x"}, "ge", "lua require('spider').motion('ge')", { desc = "Spider-ge" }) + vim.keymap.set( + { "n", "o", "x" }, + "w", + "lua require('spider').motion('w')", + { desc = "Spider-w" } + ) + vim.keymap.set( + { "n", "o", "x" }, + "e", + "lua require('spider').motion('e')", + { desc = "Spider-e" } + ) + vim.keymap.set( + { "n", "o", "x" }, + "b", + "lua require('spider').motion('b')", + { desc = "Spider-b" } + ) + vim.keymap.set( + { "n", "o", "x" }, + "ge", + "lua require('spider').motion('ge')", + { desc = "Spider-ge" } + ) < @@ -121,15 +142,15 @@ skipping of insignificant punctuation: >lua -- default value - require("spider").setup({ - skipInsignificantPunctuation = true - }) + require("spider").setup { + skipInsignificantPunctuation = true, + } < You can also pass this configuration table to the `motion` function: >lua - require('spider').motion('w', { skipInsignificantPunctuation = false }) + require("spider").motion("w", { skipInsignificantPunctuation = false }) < Any options passed here will be used, and any options not passed will use the @@ -154,7 +175,7 @@ option for the keymap.) SUBWORD TEXT OBJECT *spider-nvim-spider--subword-text-object* -This plugins supports `w`, `e`, and `b` in operater-pending mode, but does not +This plugin supports `w`, `e`, and `b` in operater-pending mode, but does not include a subword-variant of `iw`. For a version of `iw` that considers camelCase, check out the `subword` text object of nvim-various-textobjs .