📝 Add documentation for g:gitmoji_aliases

✨ Add support for user defined aliases for abbreviations

Author: bruxisma

after/ftplugin/gitcommit.vim

@@ -1,8 +1,23 @@
 setlocal completefunc=gitmoji#complete
 setlocal omnifunc=gitmoji#complete
 
+function s:warn(...)
+  echohl WarningMsg
+  echomsg "gitmoji.vim: " a:000->join()
+  echohl None
+endfunction
+
+let s:builtins = gitmoji#builtins()
+let s:aliases = gitmoji#aliases()
+
 if g:gitmoji_abbreviations && g:gitmoji_insert_emoji
-  for [name, gitmoji] in gitmoji#builtins()->items()
+  for [name, gitmoji] in s:builtins->items()
     execute 'iabbrev' gitmoji.code gitmoji.emoji
+    for alias in s:aliases->get(name, [])
+      " NOTE: For some reason not assigning this to a variable before use
+      " results in an invalid argument error, with no additional information :/
+      let code = printf(":%s:", alias)
+      execute 'iabbrev' code gitmoji.emoji
+    endfor
   endfor
 endif

autoload/gitmoji.vim

@@ -3,6 +3,12 @@ let g:gitmoji = 1
 
 let s:directory = expand('<sfile>:p')->resolve()->fnamemodify(':h')
 
+function s:warn(...)
+  echohl WarningMsg
+  echomsg "gitmoji.vim: " a:000->join()
+  echohl None
+endfunction
+
 function s:compare(lhs, rhs)
   if a:lhs.name == a:rhs.name
     return 0
@@ -20,35 +26,18 @@ function s:findlocal(filename)
   return findfile(a:filename, s:directory)
 endfunction
 
-" There needs to be a better way to handle this
-" TODO: We need to provide a separate way for users to define their aliases
-" where kind: is set to *not* gitmoji, but 'user', or 'plugin'
 " TODO: Look into applying iabbrev(s) during the CompleteDonePre or
 " CompleteDone event.
 function s:builtin(idx, name)
   let gitmoji = s:gitmoji[a:name]
-  echomsg "Gitmoji.code: " gitmoji.code
   let word = g:gitmoji_insert_emoji ? gitmoji.emoji : gitmoji.code
-  let result =<< trim EOT
-    #{
-      word: g:gitmoji_insert_emoji ? gitmoji.emoji : gitmoji.code,
-      abbr: gitmoji.emoji .. ' ' .. gitmoji.name,
-      menu: gitmoji.description,
-      kind: 'gitmoji',
-    }
-  EOT
-  return result->join()->eval()
-endfunction
-
-function s:warn(...)
-  echohl WarningMsg
-  echomsg "gitmoji.vim: " a:000->join()
-  echohl None
+  let abbr = printf('%s %s', gitmoji.emoji, gitmoji.name)
+  let menu = gitmoji.description
+  let kind = 'builtin'
+  return #{ word: word, abbr: abbr, menu: menu, kind: kind }
 endfunction
 
-" This will be configurable at some point for additional things, like custom
-" files
-function s:load()
+function s:builtins()
   let data = s:findlocal('gitmojis.json')->s:readjson()
   let result = {}
   if !has_key(data, 'gitmojis')
@@ -62,13 +51,40 @@ function s:load()
   return result
 endfunction
 
+function s:aliases()
+  if !exists('g:gitmoji_aliases')
+    return {}
+  endif
+  let type = type(g:gitmoji_aliases)
+  let data = {}
+  if type == v:t_string
+    let data = s:readjson(g:gitmoji_aliases)
+  elseif type == v:t_dict
+    let data = g:gitmoji_aliases
+  elseif type == v:t_func
+    let data = call g:gitmoji_aliases
+    if type(data) != v:t_dict
+      s:warn('gitmoji.vim', 'g:gitmoji_aliases function did not return a dictionary')
+      return {}
+    endif
+  endif
+  return data
+endfunction
+
 function gitmoji#builtins()
   if !exists('s:gitmoji')
-    let s:gitmoji = s:load()
+    let s:gitmoji = s:builtins()
   endif
   return s:gitmoji
 endfunction
 
+function gitmoji#aliases()
+  if !exists('s:aliases')
+    let s:aliases = s:aliases()
+  endif
+  return s:aliases
+endfunction
+
 function gitmoji#complete(findstart, base)
   call gitmoji#builtins()
   " TODO: Permit configuration setting to allow 'matching' if the line is
@@ -83,7 +99,3 @@ 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

@@ -8,9 +8,9 @@ Author:         Isabella Muerte
 ===============================================================================
 CONTENTS                                               *gitmoji* *gitmoji-contents*
 
-        1. Introduction .............................. |gitmoji-introduction|
-        2. Installation .............................. |gitmoji-installation|
-        3. Configuration ............................. |gitmoji-configuration|
+	1. Introduction .............................. |gitmoji-introduction|
+	2. Installation .............................. |gitmoji-installation|
+	3. Configuration ............................. |gitmoji-configuration|
 
 ===============================================================================
 INTRODUCTION                                                      *gitmoji-intro*
@@ -28,7 +28,7 @@ INSTALLATION                                               *gitmoji-installation
 
 Using your vim package manager of choice, simply add gitmoji.vim to your list
 of plugins. For example, if using vim-plug: >
-    Plug 'slurps-mad-rips/gitmoji.vim'
+	Plug 'slurps-mad-rips/gitmoji.vim'
 <
 ===============================================================================
 CONFIGURATION                                             *gitmoji-configuration*
@@ -45,6 +45,8 @@ g:gitmoji_insert_emoji~
 g:gitmoji_complete_anywhere~
 	When set to |v:true|, both the 'omnifunc' and 'completefunc' can
 	activate anywhere.
+	NOTE: This is not currently implemented in the most recent release of
+	gitmoji.vim
 	The default is |v:false|
 
                                                         *g:gitmoji_abbreviations*
@@ -55,5 +57,26 @@ g:gitmoji_abbreviations~
 	the 'omnifunc' or 'completefunc' that gitmoji sets.
 	The default is |v:true|
 
+                                                              *g:gitmoji_aliases*
+g:gitmoji_aliases~
+	The gitmoji names mentioned on https://gitmoji.dev are not always easy
+	to remember for what they do exactly. For this reason, users can supply
+	a |g:gitmoji_aliases| variable. This variable can be either a
+	|String|, a |Dict|, or a |Funcref|.
+	If |g:gitmoji_aliases| is a |String|, it is read as a JSON file,
+	converted to a |Dict| and treated AS IF |g:gitmoji_aliases| is a
+	|Dict|.
+	If |g:gitmoji_aliases| is a |Funcref|, it MUST return a |Dict|, and
+	this returned value will be treated AS IF |g:gitmoji_aliases| was a
+	|Dict| the entire time.
+	If |g:gitmoji_aliases| is a |Dict|, each key MUST be the NAME (not the
+	emoji or code) of a gitmoji name. If it is not, it will be ignored and
+	a warning will be |:echo|ed to the |:messages| log. Each value of the
+	|Dict| MUST be a |List| of |Strings|.
+	Each alias is used to create an |:iabbrev| if both
+	|g:gitmoji_abbreviations| and |g:gitmoji_insert_emoji| are |v:true|.
+	NOTE: These aliases are not used in the complete function at this time,
+	but will be in the near future.
+
 ===============================================================================
  vim:ft=help:tw=78

plugin/gitmoji.vim

@@ -9,7 +9,6 @@ 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