[{"result":{"data":{"id":471,"owner":"windwp","name":"nvim-autopairs","type":"github","source":"awesome-neovim","category":"editing-support","link":"https://github.com/windwp/nvim-autopairs","shortDescription":"autopairs for neovim written by lua","createdAt":"2023-03-22T19:35:21.656Z","lastSyncedAt":"2023-04-13T06:23:45.075Z","stars":1919,"readme":"## nvim-autopairs\n\nA super powerful autopair plugin for Neovim that supports multiple characters.\n\nRequires neovim 0.7\n\n## Installation\n\nInstall the plugin with your preferred package manager:\n\n### [vim-plug](https://github.com/junegunn/vim-plug)\n\n```vim\nPlug 'windwp/nvim-autopairs'\n\nlua << EOF\nrequire(\"nvim-autopairs\").setup {}\nEOF\n```\n\n### [packer](https://github.com/wbthomason/packer.nvim)\n\n```lua\nuse {\n\t\"windwp/nvim-autopairs\",\n config = function() require(\"nvim-autopairs\").setup {} end\n}\n```\n\n## Default values\n\n``` lua\nlocal disable_filetype = { \"TelescopePrompt\", \"spectre_panel\" }\nlocal disable_in_macro = false -- disable when recording or executing a macro\nlocal disable_in_visualblock = false -- disable when insert after visual block mode\nlocal disable_in_replace_mode = true\nlocal ignored_next_char = [=[[%w%%%'%[%\"%.%`%$]]=]\nlocal enable_moveright = true\nlocal enable_afterquote = true -- add bracket pairs after quote\nlocal enable_check_bracket_line = true --- check bracket in same line\nlocal enable_bracket_in_quote = true --\nlocal enable_abbr = false -- trigger abbreviation\nlocal break_undo = true -- switch for basic rule break undo sequence\nlocal check_ts = false\nlocal map_cr = true\nlocal map_bs = true -- map the key\nlocal map_c_h = false -- Map the key to delete a pair\nlocal map_c_w = false -- map to delete a pair if possible\n\n```\n\n### Override default values\n\n``` lua\nrequire('nvim-autopairs').setup({\n disable_filetype = { \"TelescopePrompt\" , \"vim\" },\n})\n```\n\n\n#### Mapping ``\n```\nBefore Input After\n------------------------------------\n{|} {\n |\n }\n------------------------------------\n```\n\n

nvim-cmp

\nYou need to add mapping `CR` on nvim-cmp setup.\nCheck readme.md on nvim-cmp repo.\n

\n\n``` lua\n-- If you want insert `(` after select function or method item\nlocal cmp_autopairs = require('nvim-autopairs.completion.cmp')\nlocal cmp = require('cmp')\ncmp.event:on(\n 'confirm_done',\n cmp_autopairs.on_confirm_done()\n)\n```\n\nYou can customize the kind of completion to add `(` or any character.\n\n```lua\nlocal handlers = require('nvim-autopairs.completion.handlers')\n\ncmp.event:on(\n 'confirm_done',\n cmp_autopairs.on_confirm_done({\n filetypes = {\n -- \"*\" is a alias to all filetypes\n [\"*\"] = {\n [\"(\"] = {\n kind = {\n cmp.lsp.CompletionItemKind.Function,\n cmp.lsp.CompletionItemKind.Method,\n },\n handler = handlers[\"*\"]\n }\n },\n lua = {\n [\"(\"] = {\n kind = {\n cmp.lsp.CompletionItemKind.Function,\n cmp.lsp.CompletionItemKind.Method\n },\n ---@param char string\n ---@param item table item completion\n ---@param bufnr number buffer number\n ---@param rules table\n ---@param commit_character table\n handler = function(char, item, bufnr, rules, commit_character)\n -- Your handler function. Inpect with print(vim.inspect{char, item, bufnr, rules, commit_character})\n end\n }\n },\n -- Disable for tex\n tex = false\n }\n })\n)\n```\n\nDon't use `nil` to disable a filetype. If a filetype is `nil` then `*` is used as fallback.\n\n

coq_nvim

\n\n``` lua\nlocal remap = vim.api.nvim_set_keymap\nlocal npairs = require('nvim-autopairs')\n\nnpairs.setup({ map_bs = false, map_cr = false })\n\nvim.g.coq_settings = { keymap = { recommended = false } }\n\n-- these mappings are coq recommended mappings unrelated to nvim-autopairs\nremap('i', '', [[pumvisible() ? \"\" : \"\"]], { expr = true, noremap = true })\nremap('i', '', [[pumvisible() ? \"

\" : \"\"]], { expr = true, noremap = true })\nremap('i', '', [[pumvisible() ? \"\" : \"\"]], { expr = true, noremap = true })\nremap('i', '', [[pumvisible() ? \"\" : \"\"]], { expr = true, noremap = true })\n\n-- skip it, if you use another global object\n_G.MUtils= {}\n\nMUtils.CR = function()\n if vim.fn.pumvisible() ~= 0 then\n if vim.fn.complete_info({ 'selected' }).selected ~= -1 then\n return npairs.esc('')\n else\n return npairs.esc('') .. npairs.autopairs_cr()\n end\n else\n return npairs.autopairs_cr()\n end\nend\nremap('i', '', 'v:lua.MUtils.CR()', { expr = true, noremap = true })\n\nMUtils.BS = function()\n if vim.fn.pumvisible() ~= 0 and vim.fn.complete_info({ 'mode' }).mode == 'eval' then\n return npairs.esc('') .. npairs.autopairs_bs()\n else\n return npairs.autopairs_bs()\n end\nend\nremap('i', '', 'v:lua.MUtils.BS()', { expr = true, noremap = true })\n```\n

without completion plugin

\n\n```lua\n-- add option map_cr\nnpairs.setup({ map_cr = true })\n```\n

\n\n[another completion plugin](https://github.com/windwp/nvim-autopairs/wiki/Completion-plugin)\n\nIf you have a problem with indent after you press ` `\nplease check the settings of treesitter indent or install a plugin that has indent support for your filetype.\n\n### Rule\n\nnvim-autopairs uses rules with conditions to check pairs.\n\n``` lua\nlocal Rule = require('nvim-autopairs.rule')\nlocal npairs = require('nvim-autopairs')\n\nnpairs.add_rule(Rule(\"$$\",\"$$\",\"tex\"))\n\n-- you can use some built-in conditions\n\nlocal cond = require('nvim-autopairs.conds')\nprint(vim.inspect(cond))\n\nnpairs.add_rules({\n Rule(\"$\", \"$\",{\"tex\", \"latex\"})\n -- don't add a pair if the next character is %\n :with_pair(cond.not_after_regex(\"%%\"))\n -- don't add a pair if the previous character is xxx\n :with_pair(cond.not_before_regex(\"xxx\", 3))\n -- don't move right when repeat character\n :with_move(cond.none())\n -- don't delete if the next character is xx\n :with_del(cond.not_after_regex(\"xx\"))\n -- disable adding a newline when you press \n :with_cr(cond.none())\n },\n -- disable for .vim files, but it work for another filetypes\n Rule(\"a\",\"a\",\"-vim\")\n)\n\nnpairs.add_rules({\n Rule(\"$$\",\"$$\",\"tex\")\n :with_pair(function(opts)\n print(vim.inspect(opts))\n if opts.line==\"aa $$\" then\n -- don't add pair on that line\n return false\n end\n end)\n }\n)\n\n-- you can use regex\n-- press u1234 => u1234number\nnpairs.add_rules({\n Rule(\"u%d%d%d%d$\", \"number\", \"lua\")\n :use_regex(true)\n})\n\n\n\n-- press x1234 => x12341234\nnpairs.add_rules({\n Rule(\"x%d%d%d%d$\", \"number\", \"lua\")\n :use_regex(true)\n :replace_endpair(function(opts)\n -- print(vim.inspect(opts))\n return opts.prev_char:sub(#opts.prev_char - 3,#opts.prev_char)\n end)\n})\n\n\n-- you can do anything with regex +special key\n-- example press tab to uppercase text:\n-- press b1234s => B1234S1234S\n\nnpairs.add_rules({\n Rule(\"b%d%d%d%d%w$\", \"\", \"vim\")\n :use_regex(true,\"\")\n :replace_endpair(function(opts)\n return\n opts.prev_char:sub(#opts.prev_char - 4,#opts.prev_char)\n ..\"viwU\"\n end)\n})\n\n-- you can exclude filetypes\nnpairs.add_rule(\n Rule(\"$$\",\"$$\")\n :with_pair(cond.not_filetypes({\"lua\"}))\n)\n--- check ./lua/nvim-autopairs/rules/basic.lua\n\n```\n[Rules API](https://github.com/windwp/nvim-autopairs/wiki/Rules-API)\n\n### Treesitter\nYou can use treesitter to check for a pair.\n\n```lua\nlocal npairs = require(\"nvim-autopairs\")\nlocal Rule = require('nvim-autopairs.rule')\n\nnpairs.setup({\n check_ts = true,\n ts_config = {\n lua = {'string'},-- it will not add a pair on that treesitter node\n javascript = {'template_string'},\n java = false,-- don't check treesitter on java\n }\n})\n\nlocal ts_conds = require('nvim-autopairs.ts-conds')\n\n\n-- press % => %% only while inside a comment or string\nnpairs.add_rules({\n Rule(\"%\", \"%\", \"lua\")\n :with_pair(ts_conds.is_ts_node({'string','comment'})),\n Rule(\"$\", \"$\", \"lua\")\n :with_pair(ts_conds.is_not_ts_node({'function'}))\n})\n```\n\n### Don't add pairs if it already has a close pair in the same line\nif **next character** is a close pair and it doesn't have an open pair in same line, then it will not add a close pair\n\n``` text\nBefore Input After\n------------------------------------\n( |)) ( ( (|))\n\n```\n\n``` lua\nrequire('nvim-autopairs').setup({\n enable_check_bracket_line = false\n})\n```\n\n### Don't add pairs if the next char is alphanumeric\n\nYou can customize how nvim-autopairs will behave if it encounters a specific\ncharacter\n``` lua\nrequire('nvim-autopairs').setup({\n ignored_next_char = \"[%w%.]\" -- will ignore alphanumeric and `.` symbol\n})\n```\n\n``` text\nBefore Input After\n------------------------------------\n|foobar ( (|foobar\n|.foobar ( (|.foobar\n```\n\n### Plugin Integration\n``` lua\n require('nvim-autopairs').disable()\n require('nvim-autopairs').enable()\n require('nvim-autopairs').remove_rule('(') -- remove rule (\n require('nvim-autopairs').clear_rules() -- clear all rules\n -- get rule \" then modify it. It can return a list of rule or just a rule\n require('nvim-autopairs').get_rule('\"')\n```\n\n* Sample\n```lua\n-- remove add single quote on filetype scheme or lisp\nrequire(\"nvim-autopairs\").get_rule(\"'\")[1].not_filetypes = { \"scheme\", \"lisp\" }\nrequire(\"nvim-autopairs\").get_rule(\"'\")[1]:with_pair(cond.not_after_text(\"[\"}))\n```\n\n### FastWrap\n\n``` text\nBefore Input After\n--------------------------------------------------\n(|foobar then press $ (|foobar)\n(|)(foobar) then press q (|(foobar))\n```\n\n```lua\n-- put this to setup function and press to use fast_wrap\nnpairs.setup({\n fast_wrap = {},\n})\n\n-- change default fast_wrap\nnpairs.setup({\n fast_wrap = {\n map = '',\n chars = { '{', '[', '(', '\"', \"'\" },\n pattern = [=[[%'%\"%>%]%)%}%,]]=],\n end_key = '$',\n keys = 'qwertyuiopzxcvbnmasdfghjkl',\n check_comma = true,\n highlight = 'Search',\n highlight_grey='Comment'\n },\n})\n```\n\n### autotag html and tsx\n\n[autotag](https://github.com/windwp/nvim-ts-autotag)\n\n### Endwise\n\n[endwise](https://github.com/windwp/nvim-autopairs/wiki/Endwise)\n\n### Custom rules\n[rules](https://github.com/windwp/nvim-autopairs/wiki/Custom-rules)\n\n## Sponsors\n\nThanks to everyone who sponsors my projects and makes continued development maintenance possible!\n $\"\"$ \n","configCount":272}}}]