chezmoi init

dot_oh-my-zsh/plugins/emoji/README.md

@@ -0,0 +1,127 @@
+# emoji plugin
+
+Support for conveniently working with Unicode emoji in Zsh.
+
+## Features
+
+This plugin provides support for working with Unicode emoji characters in `zsh` using human-readable identifiers. It provides global variables which map emoji names to the actual characters, country names to their flags, and some named groupings of emoji. It also provides associated functions for displaying them.
+
+#### Variables
+
+Variable          | Description
+----------------- | --------------------------------
+  $emoji          | Maps emoji names to characters (except flags)
+  $emoji_flags    | Maps country names to flag characters (using region indicators)
+  $emoji_groups   | Named groups of emoji. Keys are group names; values are whitespace-separated lists of character names
+
+You may define new emoji groups at run time by modifying `$emoji_groups`. The special group name `all` is reserved for use by the plugin. You should not modify `$emoji` or `$emoji_flags`.
+
+#### Functions
+
+Function         | Description
+---------------- | -------------------------------
+  random_emoji   | Prints a random emoji character
+  display_emoji  | Displays emoji, along with their names
+
+## Usage and Examples
+
+To output a specific emoji, use:
+```
+$> echo $emoji[<name>]
+```
+E.g.:
+```
+$> echo $emoji[mouse_face]
+```
+
+To output a random emoji, use:
+```
+$> random_emoji
+```
+To output a random emoji from a particular group, use:
+```
+$> random_emoji <group>
+```
+E.g.:
+```
+$> random_emoji fruits
+$> random_emoji animals
+$> random_emoji vehicles
+$> random_emoji faces
+```
+
+The defined group names can be found with `echo ${(k)emoji_groups}`.
+
+To list all available emoji with their names, use:
+```
+$> display_emoji
+$> display_emoji faces
+$> display_emoji people
+```
+
+To use emoji in a prompt:
+```
+PROMPT="$emoji[penguin]  > ""
+PROMPT='$(random_emoji fruits)  > '
+surfer=$emoji[surfer]
+PROMPT="$surfer  > "
+```
+
+##  Technical Details
+
+The emoji names and codes are sourced from Unicode Technical Report \#51, which provides information on emoji support in Unicode. It can be found at https://www.unicode.org/reports/tr51/index.html.
+
+The group definitions are added by this OMZ plugin. They are not based on external definitions.
+
+The values in the `$emoji*` maps are the emoji characters themselves, not escape sequences or other forms that require interpretation. They can be used in any context and do not require escape sequence support from commands like `echo` or `print`.
+
+The emoji in the main `$emoji` map are standalone character sequences which can all be output on their own, without worrying about combining characters. The values may actually be multi-code-point sequences, instead of a single code point, and may include combining characters in those sequences. But they're arranged so their effects do not extend beyond that sequence.
+
+The exception to this is the skin tone / hair style variation selectors. These are included in the main `$emoji` map because they can be displayed on their own, as well as used as combining characters. (If they follow a character that is not one of the emoji characters they combine with, they are displayed as color swatches.)
+
+
+##  Experimental Features
+
+This defines some additional variables and functions, but these are experimental and subject to change at any time. You shouldn't rely on them being available. They're mostly for the use of emoji plugin developers to help decide what to include in future revisions.
+
+Variables:
+
+Variable          | Description
+----------------- | --------------------------------
+  $emoji_skintone | Skin tone modifiers (from Unicode 8.0)
+
+
+#### Skin Tone Variation Selection
+
+This includes experimental support for the skin tone Variation Selectors introduced with Unicode 8.0, which let you select different skin tones for emoji involving humans.
+
+NOTE: This really is experimental. The skin tone selectors are a relatively new feature and may not be supported by all systems. And the support in this plugin is a work in progress. It may not work in all places. In fact, I haven't gotten it to work anywhere yet. -apjanke
+
+The "variation selectors" are combining characters which change the appearance of the preceding character. A variation selector character can be output immediately following a human emoji to change its skin tone color. You can also output a variation selector on its own to display a color swatch of that skin tone.
+
+The `$emoji_skintone` associative array maps skin tone IDs to the variation selector characters. To use one, output it immediately following a smiley or other human emoji.
+
+```
+echo $emoji[waving_hand]$emoji_skintone[5]
+```
+
+Note that `$emoji_skintone` is an associative array, and its keys are the *names* of "Fitzpatrick Skin Type" groups, not linear indexes into a normal array. The names are `1_2`, `3`, `4`, `5`, and `6`. (Types 1 and 2 are combined into a single color.) See the [Diversity section in Unicode TR 51](https://www.unicode.org/reports/tr51/index.html#Diversity) for details.
+
+####  Gemoji support
+
+The [gemoji project](https://github.com/github/gemoji) seems to be the de facto main source for short names and other emoji-related metadata that isn't included in the official Unicode reports. So, our list of emojis incorporates some of their aliases to make your life more convenient:
+
+```
+echo $emoji[grinning_face_with_smiling_eyes]
+echo $emoji[smile]
+```
+
+These two commands yield the same emoji (😄). The first name is the official one, in the Unicode reference, and the second one is the alias that was in Gemoji's database.
+
+##  TODO
+
+These are things that could be enhanced in future revisions of the plugin.
+
+* Incorporate CLDR data for ordering and groupings
+* Short :bracket: style names (from gemoji)
+* ZWJ combining function?

dot_oh-my-zsh/plugins/emoji/emoji.plugin.zsh

@@ -0,0 +1,110 @@
+# emoji plugin
+#
+# Makes emoji support available within ZSH
+#
+# See the README for documentation.
+
+# Handle $0 according to the standard:
+# https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html
+0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}"
+0="${${(M)0:#/*}:-$PWD/$0}"
+
+_omz_emoji_plugin_dir="${0:h}"
+
+() {
+
+local LC_ALL=en_US.UTF-8
+
+typeset -gAH emoji_skintone
+
+source "$_omz_emoji_plugin_dir/emoji-char-definitions.zsh"
+unset _omz_emoji_plugin_dir
+
+# These additional emoji are not in the definition file, but are useful in conjunction with it
+
+# This is a combining character that can be placed after any other character to surround
+# it in a "keycap" symbol.
+# The digits 0-9 are already in the emoji table as keycap_digit_<N>, keycap_ten, etc.
+# It's unclear whether this should be in the $emoji array, because those characters are all ones
+# which can be displayed on their own.
+
+emoji[regional_indicator_symbol_letter_d_regional_indicator_symbol_letter_e]=$'\xF0\x9F\x87\xA9\xF0\x9F\x87\xAA'
+emoji[regional_indicator_symbol_letter_g_regional_indicator_symbol_letter_b]=$'\xF0\x9F\x87\xAC\xF0\x9F\x87\xA7'
+emoji[regional_indicator_symbol_letter_c_regional_indicator_symbol_letter_n]=$'\xF0\x9F\x87\xA8\xF0\x9F\x87\xB3'
+emoji[regional_indicator_symbol_letter_j_regional_indicator_symbol_letter_p]=$'\xF0\x9F\x87\xAF\xF0\x9F\x87\xB5'
+emoji[regional_indicator_symbol_letter_k_regional_indicator_symbol_letter_r]=$'\xF0\x9F\x87\xB0\xF0\x9F\x87\xB7'
+emoji[regional_indicator_symbol_letter_f_regional_indicator_symbol_letter_r]=$'\xF0\x9F\x87\xAB\xF0\x9F\x87\xB7'
+emoji[regional_indicator_symbol_letter_e_regional_indicator_symbol_letter_s]=$'\xF0\x9F\x87\xAA\xF0\x9F\x87\xB8'
+emoji[regional_indicator_symbol_letter_i_regional_indicator_symbol_letter_t]=$'\xF0\x9F\x87\xAE\xF0\x9F\x87\xB9'
+emoji[regional_indicator_symbol_letter_u_regional_indicator_symbol_letter_s]=$'\xF0\x9F\x87\xBA\xF0\x9F\x87\xB8'
+emoji[regional_indicator_symbol_letter_r_regional_indicator_symbol_letter_u]=$'\xF0\x9F\x87\xB7\xF0\x9F\x87\xBA'
+
+# Easier access to skin tone modifiers
+emoji_skintone[1_2]=$'\U1F3FB'
+emoji_skintone[3]=$'\U1F3FC'
+emoji_skintone[4]=$'\U1F3FD'
+emoji_skintone[5]=$'\U1F3FE'
+emoji_skintone[6]=$'\U1F3FF'
+}
+
+# Prints a random emoji character
+#
+#  random_emoji [group]
+#
+function random_emoji() {
+  local group=$1
+  local names
+  if [[ -z "$group" || "$group" == "all" ]]; then
+  	names=(${(k)emoji})
+  else
+	names=(${=emoji_groups[$group]})
+  fi
+  local list_size=${#names}
+  [[ $list_size -eq 0 ]] && return 1
+  local random_index=$(( ( RANDOM % $list_size ) + 1 ))
+  local name=${names[$random_index]}
+  if [[ "$group" == "flags" ]]; then
+    echo ${emoji_flags[$name]}
+  else
+    echo ${emoji[$name]}
+  fi
+}
+
+# Displays a listing of emoji with their names
+#
+# display_emoji [group]
+#
+function display_emoji() {
+  local group=$1
+  local names
+  if [[ -z "$group" || "$group" == "all" ]]; then
+  	names=(${(k)emoji})
+  else
+    names=(${=emoji_groups[$group]})
+  fi
+  # The extra spaces in output here are a hack for readability, since some
+  # terminals treat these emoji chars as single-width.
+  local counter=1
+  for i in $names; do
+    if [[ "$group" == "flags" ]]; then
+      printf '%s  ' "$emoji_flags[$i]"
+    else
+      printf '%s  ' "$emoji[$i]"
+    fi
+    # New line every 20 emoji, to avoid weirdnesses
+    if (($counter % 20 == 0)); then
+      printf "\n"
+    fi
+    let counter=$counter+1
+  done
+  print
+  for i in $names; do
+    if [[ "$group" == "flags" ]]; then
+      echo "${emoji_flags[$i]}  = $i"
+    else
+      echo "${emoji[$i]}  = $i"
+    fi
+  done
+}
+
+

dot_oh-my-zsh/plugins/emoji/update_emoji.py

@@ -0,0 +1,213 @@
+"""
+Update Emoji.py
+Refreshes OMZ emoji database based on the latest Unicode spec
+"""
+import re
+import json
+
+spec = open("emoji-data.txt", "r")
+
+# Regexes
+# regex_emoji will return, respectively:
+# the code points, its type (status), the actual emoji, and its official name
+regex_emoji = r"^([\w ].*?\S)\s*;\s*([\w-]+)\s*#\s*(.*?)\s(\S.*).*$"
+# regex_group returns the group of subgroup that a line opens
+regex_group = r"^#\s*(group|subgroup):\s*(.*)$"
+
+headers = """
+# emoji-char-definitions.zsh - Emoji definitions for oh-my-zsh emoji plugin
+#
+# This file is auto-generated by update_emoji.py. Do not edit it manually.
+#
+# This contains the definition for:
+#   $emoji         - which maps character names to Unicode characters
+#   $emoji_flags   - maps country names to Unicode flag characters using region
+#                    indicators
+#   $emoji_mod     - maps modifier components to Unicode characters
+#   $emoji_groups  - a single associative array to avoid cluttering up the
+#                    global namespace, and to allow adding additional group
+#                    definitions at run time. The keys are the group names, and
+#                    the values are whitespace-separated lists of emoji
+#                    character names.
+
+# Main emoji
+typeset -gAH emoji
+# National flags
+typeset -gAH emoji_flags
+# Combining modifiers
+typeset -gAH emoji_mod
+# Emoji groups
+typeset -gAH emoji_groups
+"""
+
+#######
+# Adding country codes
+#######
+# This is the only part of this script that relies on an external library
+# (country_converter), and is hence commented out by default.
+# You can uncomment it to have country codes added as aliases for flag
+# emojis. (By default, when you install this extension, country codes are
+# included as aliases, but not if you re-run this script without uncommenting.)
+# Warning: country_converter is very verbose, and will print warnings all over
+# your terminal.
+
+# import country_converter as coco # pylint: disable=wrong-import-position
+# cc = coco.CountryConverter()
+
+# def country_iso(_all_names, _omz_name):
+#     """ Using the external library country_converter,
+#         this function can detect the ISO2 and ISO3 codes
+#         of the country. It takes as argument the array
+#         with all the names of the emoji, and returns that array."""
+#     omz_no_underscore = re.sub(r'_', r' ', _omz_name)
+#     iso2 = cc.convert(names=[omz_no_underscore], to='ISO2')
+#     if iso2 != 'not found':
+#         _all_names.append(iso2)
+#         iso3 = cc.convert(names=[omz_no_underscore], to='ISO3')
+#         _all_names.append(iso3)
+#     return _all_names
+
+
+#######
+# Helper functions
+#######
+
+def code_to_omz(_code_points):
+    """ Returns a ZSH-compatible Unicode string from the code point(s) """
+    return r'\U' + r'\U'.join(_code_points.split(' '))
+
+def name_to_omz(_name, _group, _subgroup, _status):
+    """ Returns a reasonable snake_case name for the emoji. """
+    def snake_case(_string):
+        """ Does the regex work of snake_case """
+        remove_dots = re.sub(r'\.\(\)', r'', _string)
+        replace_ands = re.sub(r'\&', r'and', remove_dots)
+        remove_whitespace = re.sub(r'[^\#\*\w]', r'_', replace_ands)
+        return re.sub(r'__', r'_', remove_whitespace)
+
+    shortname = ""
+    split_at_colon = lambda s: s.split(": ")
+    # Special treatment by group and subgroup
+    # If the emoji is a flag, we strip "flag" from its name
+    if _group == "Flags" and len(split_at_colon(_name)) > 1:
+        shortname = snake_case(split_at_colon(_name)[1])
+    else:
+        shortname = snake_case(_name)
+    # Special treatment by status
+    # Enables us to have every emoji combination,
+    # even the one that are not officially sanctioned
+    # and are implemented by, say, only one vendor
+    if _status == "unqualified":
+        shortname += "_unqualified"
+    elif _status == "minimally-qualified":
+        shortname += "_minimally"
+    return shortname
+
+def increment_name(_shortname):
+    """ Increment the short name by 1. If you get, say,
+    'woman_detective_unqualified', it returns
+    'woman_detective_unqualified_1', and then
+    'woman_detective_unqualified_2', etc. """
+    last_char = _shortname[-1]
+    if last_char.isdigit():
+        num = int(last_char)
+        return _shortname[:-1] + str(num + 1)
+    return _shortname + "_1"
+
+########
+# Going through every line
+########
+
+group, subgroup, short_name_buffer = "", "", ""
+emoji_database = []
+for line in spec:
+    # First, test if this line opens a group or subgroup
+    group_match = re.findall(regex_group, line)
+    if group_match != []:
+        gr_or_sub, name = group_match[0]
+        if gr_or_sub == "group":
+            group = name
+        elif gr_or_sub == "subgroup":
+            subgroup = name
+        continue # Moving on...
+    # Second, test if this line references one emoji
+    emoji_match = re.findall(regex_emoji, line)
+    if emoji_match != []:
+        code_points, status, emoji, name = emoji_match[0]
+        omz_codes = code_to_omz(code_points)
+        omz_name = name_to_omz(name, group, subgroup, status)
+        # If this emoji has the same shortname as the preceding one
+        if omz_name in short_name_buffer:
+            omz_name = increment_name(short_name_buffer)
+        short_name_buffer = omz_name
+        emoji_database.append(
+            [omz_codes, status, emoji, omz_name, group, subgroup])
+spec.close()
+
+########
+# Write to emoji-char-definitions.zsh
+########
+
+# Aliases for emojis are retrieved through the DB of Gemoji
+# Retrieved on Aug 9 2019 from the following URL:
+# https://raw.githubusercontent.com/github/gemoji/master/db/emoji.json
+
+gemoji_db = open("gemoji_db.json")
+j = json.load(gemoji_db)
+aliases_map = {entry['emoji']: entry['aliases'] for entry in j}
+all_omz_names = [emoji_data[3] for emoji_data in emoji_database]
+
+# Let's begin writing to this file
+output = open("emoji-char-definitions.zsh", "w")
+output.write(headers)
+
+emoji_groups = {"fruits": "\n", "vehicles": "\n", "hands": "\n",
+                "people": "\n", "animals": "\n", "faces": "\n",
+                "flags": "\n"}
+
+# First, write every emoji down
+for _omz_codes, _status, _emoji, _omz_name, _group, _subgroup in emoji_database:
+
+    # One emoji can be mapped to multiple names (aliases or country codes)
+    names_for_this_emoji = [_omz_name]
+
+    # Variable that indicates in which map the emoji will be located
+    emoji_map = "emoji"
+    if _status == "component":
+        emoji_map = "emoji_mod"
+    if _group == "Flags":
+        emoji_map = "emoji_flags"
+        # Adding country codes (Optional, see above)
+        # names_for_this_emoji = country_iso(names_for_this_emoji, _omz_name)
+
+    # Check if there is an alias available in the Gemoji DB
+    if _emoji in aliases_map.keys():
+        for alias in aliases_map[_emoji]:
+            if alias not in all_omz_names:
+                names_for_this_emoji.append(alias)
+
+    # And now we write to the definitions file
+    for one_name in names_for_this_emoji:
+        output.write(f"{emoji_map}[{one_name}]=$'{_omz_codes}'\n")
+
+    # Storing the emoji in defined subgroups for the next step
+    if _status == "fully-qualified":
+        if _subgroup == "food-fruit":
+            emoji_groups["fruits"] += f"  {_omz_name}\n"
+        elif "transport-" in _subgroup:
+            emoji_groups["vehicles"] += f"  {_omz_name}\n"
+        elif "hand-" in _subgroup:
+            emoji_groups["hands"] += f"  {_omz_name}\n"
+        elif "person-" in _subgroup or _subgroup == "family":
+            emoji_groups["people"] += f"  {_omz_name}\n"
+        elif "animal-" in _subgroup:
+            emoji_groups["animals"] += f"  {_omz_name}\n"
+        elif "face-" in _subgroup:
+            emoji_groups["faces"] += f"  {_omz_name}\n"
+        elif _group == "Flags":
+            emoji_groups["flags"] += f"  {_omz_name}\n"
+
+# Second, write the subgroups to the end of the file
+for name, string in emoji_groups.items():
+    output.write(f'\nemoji_groups[{name}]="{string}"\n')
+output.close()