✨ Add g:gitmoji_abbreviations setting and iabbrev generation

📝 Add documentation for g:gitmoji_abbreviations
📝 Update wording for documentation.
🔥 Remove doc/tags and add it to .gitignore

Author: bruxisma

.gitignore

@@ -0,0 +1 @@
+/doc/tags

after/ftplugin/gitcommit.vim

@@ -1,2 +1,8 @@
 setlocal completefunc=gitmoji#complete
 setlocal omnifunc=gitmoji#complete
+
+if g:gitmoji_abbreviations && g:gitmoji_insert_emoji
+  for [name, gitmoji] in gitmoji#builtins()->items()
+    execute 'iabbrev' gitmoji.code gitmoji.emoji
+  endfor
+endif

autoload/gitmoji.vim

@@ -62,10 +62,15 @@ function s:load()
   return result
 endfunction
 
-function gitmoji#complete(findstart, base)
+function gitmoji#builtins()
   if !exists('s:gitmoji')
     let s:gitmoji = s:load()
   endif
+  return s:gitmoji
+endfunction
+
+function gitmoji#complete(findstart, base)
+  call gitmoji#builtins()
   " TODO: Permit configuration setting to allow 'matching' if the line is
   " empty
   if a:base->empty() && a:findstart == 1
@@ -78,3 +83,7 @@ function gitmoji#complete(findstart, base)
   endif
   return keys->map(function('s:builtin'))
 endfunction
+
+" Registers aliases from a dictionary to be usable as gitmoji names.
+function gitmoji#register(aliases)
+endfunction

doc/gitmoji.txt

@@ -35,17 +35,25 @@ CONFIGURATION                                             *gitmoji-configuration
 
                                                          *g:gitmoji_insert_emoji*
 g:gitmoji_insert_emoji~
-	When set to `1` or `v:true`, the actual emoji will be inserted on
+	When set to or |v:true|, the actual emoji will be inserted on
 	completion instead of the gitmoji text code. e.g., if selecting
-	`test-tube`, and `g:gitmoji_insert_emoji` is `v:true`, 🧪 will be
-	inserted, instead of the gitmoji code `:test_tube:`.
-	The default is `v:true`.
+	"test-tube", and |g:gitmoji_insert_emoji| is |v:true|, 🧪 will be
+	inserted, instead of the gitmoji code ":test_tube:".
+	The default is |v:true|.
 
                                                     *g:gitmoji_complete_anywhere*
 g:gitmoji_complete_anywhere~
-	When set to `1` or `v:true`, both the 'omnifunc' and 'completefunc' can
+	When set to |v:true|, both the 'omnifunc' and 'completefunc' can
 	activate anywhere.
-	The default is `v:false`
+	The default is |v:false|
+
+                                                        *g:gitmoji_abbreviations*
+g:gitmoji_abbreviations~
+	If set to |v:true| and |g:gitmoji_insert_emoji| is also set to
+	|v:true|, |:iabbrev| commands are injected that will also replace
+	gitmoji codes with their respective emoji. This works separately from
+	the 'omnifunc' or 'completefunc' that gitmoji sets.
+	The default is |v:true|
 
 ===============================================================================
  vim:ft=help:tw=78

doc/tags

@@ -8,3 +8,8 @@ endif
 if !exists('g:gitmoji_complete_anywhere')
   let g:gitmoji_complete_anywhere = v:false
 endif
+
+" TODO: This is not yet implemented
+if !exists('g:gitmoji_abbreviations')
+  let g:gitmoji_abbreviations = v:true
+endif