zsh-plugin-cli 0.2.1

A command-line tool to generate new Zsh plugins.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# -*- mode: sh; eval: (sh-set-shell "zsh") -*-
#
# @name {{ plugin_display_name }}
{% if short_description -%}
# @brief {{ short_description }}
{% endif -%}
# @repository https://github.com/{{ github_user }}/zsh-{{ plugin_name }}-plugin
# @homepage **include if different from repository URL**
# @version **use semantic versioning, e.g. 0.1.0, or remove**
# @license **use license expressions, e.g., MIT AND Apache-2.0, or remove**
# @copyright **copyright notice in lieu of license, e.g., ©️ YEAR FULL_NAME <EMAIL>, or remove**
#
# @description
#
# Long description TBD.
#
# ### Public Variables
#
# * **{{ plugin_var }}_EXAMPLE**: if set it does something magical.
#

typeset -gi EC_SUCCESS

###################################################################################################
# @section Globals
# @description
#
# Import any globals from other plugins (using `typeset -g`) and initialize any plugin globals
# using either `declare` or `declare -g` for exported values.
#
# ### Internal Variables
#
# * **{{ plugin_var }}_PLUGIN_PATH**: The complete file path to the plugin's file.
#

declare -g { plugin_var }}_EXAMPLE

declare {{ plugin_var }}_PLUGIN_PATH="$(@zplugins_normalize_zero "$0")"

###################################################################################################
# @section Lifecycle
# @description
#
# Plugin core lifecycle components.
#
# 1. Declare any dependencies here, it needs to be done **before** the plugin manager calls the plugin's `_init` function.
# 2. Declare the function `{{ plugin_name }}_plugin_init` to perform any special initialization, this may not be necessary.
# 3. Declare the function `{{ plugin_name }}_plugin_unload` to perform any special clean-up, this may not be necessary.
#

@zplugins_declare_plugin_dependencies {{ plugin_name }} shlog

#
# @description
#
# Called when the plugin is loaded, allows for additional actions beyond those performed by
# the plugin manager.
#
# @noargs
#
{{ plugin_name }}_plugin_init() {
    builtin emulate -L zsh

    # Add any additional path/fpath entries.
    # @zplugins_add_to_path {{ plugin_name }} <PATH>
    # @zplugins_add_to_fpath {{ plugin_name }} <PATH>

    # Save, and set, any public environment variables here.
    @zplugins_envvar_save {{ plugin_name }} {{ plugin_var }}_EXAMPLE
    {{ plugin_var }}_EXAMPLE={{ _shv_start }}{{ plugin_var }}_EXAMPLE:-1{{ _shv_end }}

    {% if include_aliases -%}
    # Define any aliases here.
    # @zplugins_define_alias {{ plugin_name }} <NAME> '<EXPANSION>'
    {%- endif %}

    return ${EC_SUCCESS}
}

#
# @description
#
# Called when the plugin is unloaded to clean up after itself.
#
# @noargs
#
{{ plugin_name }}_plugin_unload() {
    builtin emulate -L zsh

    # Reset any public environment variables.
    @zplugins_envvar_restore {{ plugin_name }} {{ plugin_var }}_EXAMPLE

    # Unset any plugin-specific globals not saved with `@zplugins_envvar_save`.
    unset {{ plugin_var }}_PLUGIN_PATH

    return ${EC_SUCCESS}
}

###################################################################################################
# @section Public
# @description Public functions and aliases.
#

{% if not include_functions_dir -%}
#
# @description Some function that does some thing.
#
# @noargs
#
{{ plugin_name }}_example() {
    builtin emulate -L zsh

    printf "An example function in {{plugin_name}}, var: {{ _shv_start }}{{ plugin_var }}_EXAMPLE{{ _shv_end }}"
}
@zplugins_remember_fn {{ plugin_name }} {{ plugin_name }}_example
{%- endif %}