feat(): allow to not preselect correct word

fix #12, fix #13

README.md

@@ -5,15 +5,16 @@
 ## Setup
 
 ```lua
-require('cmp').setup({
+require("cmp").setup({
     sources = {
         {
-            name = 'spell',
+            name = "spell",
             option = {
                 keep_all_entries = false,
                 enable_in_context = function()
                     return true
                 end,
+                preselect_correct_word = true,
             },
         },
     },
@@ -24,7 +25,7 @@ Setting `spell` (and `spelllang`) is mandatory to use `spellsuggest`.
 
 ```lua
 vim.opt.spell = true
-vim.opt.spelllang = { 'en_us' }
+vim.opt.spelllang = { "en_us" }
 ```
 
 ## Options
@@ -43,7 +44,7 @@ Default: `false`
 For example, one can enable this source only when in a `@spell` treesitter capture. See `:help treesitter-highlight-spell`.
 
 ```lua
-enable_in_context = function()
+enable_in_context = function(params)
     return require('cmp.config.context').in_treesitter_capture('spell')
 end,
 ```
@@ -53,13 +54,20 @@ Return: boolean
 Default:
 
 ```lua
-enable_in_context = function()
+enable_in_context = function(params)
     return true
 end,
 ```
 
 Note: this option will be removed when hrsh7th/nvim-cmp#632 is implemented.
 
+### `preselect_correct_word`
+
+If true and the spelling of a word is correct, the word is displayed as the first entry and preselected. 
+
+Type: boolean  
+Default: `true`
+
 ## Credit
 
 - [compe-spell](https://github.com/hrsh7th/nvim-compe/blob/master/lua/compe_spell/init.lua)

after/plugin/cmp-spell.lua

@@ -1 +1 @@
-require('cmp').register_source('spell', require('cmp-spell').new())
+require("cmp").register_source("spell", require("cmp-spell").new())

lua/cmp-spell/init.lua

@@ -5,6 +5,7 @@ local defaults = {
     enable_in_context = function()
         return true
     end,
+    preselect_correct_word = true,
 }
 
 function source.new()
@@ -20,10 +21,11 @@ function source:get_keyword_pattern()
 end
 
 local function validate_option(params)
-    local option = vim.tbl_deep_extend('keep', params.option, defaults)
+    local option = vim.tbl_deep_extend("keep", params.option, defaults)
     vim.validate({
-        keep_all_entries = { option.keep_all_entries, 'boolean' },
-        enable_in_context = { option.enable_in_context, 'function' },
+        keep_all_entries = { option.keep_all_entries, "boolean" },
+        enable_in_context = { option.enable_in_context, "function" },
+        preselect_correct_word = { option.preselect_correct_word, "boolean" },
     })
     return option
 end
@@ -33,15 +35,15 @@ local function len_to_loglen(len)
 end
 
 local function number_to_text(input, number, loglen)
-    return string.format(input .. '%0' .. loglen .. 'd', number)
+    return string.format(input .. "%0" .. loglen .. "d", number)
 end
 
 local function candidates(input, option)
     local items = {}
     local entries = vim.fn.spellsuggest(input)
     local offset
     local loglen
-    if vim.tbl_isempty(vim.spell.check(input)) then
+    if option.preselect_correct_word and vim.tbl_isempty(vim.spell.check(input)) then
         offset = 1
         loglen = len_to_loglen(#entries + offset)
 
@@ -84,7 +86,7 @@ function source:complete(params, callback)
     end
 end
 
-local debug_name = 'spell'
+local debug_name = "spell"
 function source:get_debug_name()
     return debug_name
 end