From 9aee63d550da52fb208bdbbf28dcfdf4c0edcfd5 Mon Sep 17 00:00:00 2001 From: 00JCIV00 Date: Wed, 23 Oct 2024 11:02:22 -0400 Subject: [PATCH] Changed the 'log_enum' example to 'logger' - Changed the 'log_enum' example filename to 'logger'. - Changed the internal Command. - Recreated the example Meta Docs. - Deleted old 'log_enum' artifacts. --- build.zig | 6 +++--- examples/{log-enum.zig => logger.zig} | 2 +- .../arg_templates/logger-template.json} | 8 ++++---- .../arg_templates/logger-template.kdl} | 6 +++--- .../help_docs/manpages/logger.1} | 6 +++--- .../help_docs/markdown/logger.md} | 10 +++++----- .../tab_completions/_logger-completion.zsh} | 16 ++++++++-------- .../tab_completions/logger-completion.bash} | 12 ++++++------ .../tab_completions/logger-completion.ps1} | 10 +++++----- 9 files changed, 38 insertions(+), 38 deletions(-) rename examples/{log-enum.zig => logger.zig} (98%) rename examples/{log_enum_meta/arg_templates/log_enum-template.json => logger_meta/arg_templates/logger-template.json} (83%) rename examples/{log_enum_meta/arg_templates/log_enum-template.kdl => logger_meta/arg_templates/logger-template.kdl} (83%) rename examples/{log_enum_meta/help_docs/manpages/log_enum.1 => logger_meta/help_docs/manpages/logger.1} (82%) rename examples/{log_enum_meta/help_docs/markdown/log_enum.md => logger_meta/help_docs/markdown/logger.md} (71%) rename examples/{log_enum_meta/tab_completions/_log_enum-completion.zsh => logger_meta/tab_completions/_logger-completion.zsh} (79%) rename examples/{log_enum_meta/tab_completions/log_enum-completion.bash => logger_meta/tab_completions/logger-completion.bash} (78%) rename examples/{log_enum_meta/tab_completions/log_enum-completion.ps1 => logger_meta/tab_completions/logger-completion.ps1} (86%) diff --git a/build.zig b/build.zig index 8036669..21c41b4 100644 --- a/build.zig +++ b/build.zig @@ -52,7 +52,7 @@ pub fn build(b: *std.Build) void { //========================================== // Examples //========================================== - const examples = &.{ "cova-demo", "basic-app", "log-enum" }; + const examples = &.{ "cova-demo", "basic-app", "logger" }; var ex_arena = std.heap.ArenaAllocator.init(b.allocator); defer ex_arena.deinit(); const ex_alloc = ex_arena.allocator(); @@ -82,8 +82,8 @@ pub fn build(b: *std.Build) void { ex_exe, .{ .kinds = &.{ .all }, - .version = "0.10.1", - .ver_date = "27 AUG 2024", + .version = "0.10.2", + .ver_date = "23 OCT 2024", .author = "00JCIV00", .copyright = "MIT License", .help_docs_config = .{ diff --git a/examples/log-enum.zig b/examples/logger.zig similarity index 98% rename from examples/log-enum.zig rename to examples/logger.zig index 4fea8c8..629c8a6 100644 --- a/examples/log-enum.zig +++ b/examples/logger.zig @@ -9,7 +9,7 @@ pub const CommandT = cova.Command.Custom(.{ }, }); pub const setup_cmd = CommandT{ - .name = "log_enum", + .name = "logger", .description = "A small demo of using the Log Level Enum as an Option.", .opts = &.{ .{ diff --git a/examples/log_enum_meta/arg_templates/log_enum-template.json b/examples/logger_meta/arg_templates/logger-template.json similarity index 83% rename from examples/log_enum_meta/arg_templates/log_enum-template.json rename to examples/logger_meta/arg_templates/logger-template.json index 8dd6a0b..d56df3d 100644 --- a/examples/log_enum_meta/arg_templates/log_enum-template.json +++ b/examples/logger_meta/arg_templates/logger-template.json @@ -1,13 +1,13 @@ "Meta Info": { - "name": "log_enum", + "name": "logger", "description": "A small demo of using the Log Level Enum as an Option.", - "version": "0.10.1", - "ver_date": "27 AUG 2024", + "version": "0.10.2", + "ver_date": "23 OCT 2024", "author": "00JCIV00", "copyright": "MIT License" }, "Arguments": { - "name": "log_enum", + "name": "logger", "description": "A small demo of using the Log Level Enum as an Option.", "opts": [ { diff --git a/examples/log_enum_meta/arg_templates/log_enum-template.kdl b/examples/logger_meta/arg_templates/logger-template.kdl similarity index 83% rename from examples/log_enum_meta/arg_templates/log_enum-template.kdl rename to examples/logger_meta/arg_templates/logger-template.kdl index 44048da..60f1bc0 100644 --- a/examples/log_enum_meta/arg_templates/log_enum-template.kdl +++ b/examples/logger_meta/arg_templates/logger-template.kdl @@ -1,9 +1,9 @@ # This KDL template is formatted to match the `usage` tool as detailed here: https://sr.ht/~jdx/usage/ -name "log_enum" -bin "log_enum" +name "logger" +bin "logger" about "A small demo of using the Log Level Enum as an Option." -version "0.10.1" +version "0.10.2" author "00JCIV00" flag "--log-level" help="An Option using the `log.Level` Enum." diff --git a/examples/log_enum_meta/help_docs/manpages/log_enum.1 b/examples/logger_meta/help_docs/manpages/logger.1 similarity index 82% rename from examples/log_enum_meta/help_docs/manpages/log_enum.1 rename to examples/logger_meta/help_docs/manpages/logger.1 index f54ba98..8053b98 100644 --- a/examples/log_enum_meta/help_docs/manpages/log_enum.1 +++ b/examples/logger_meta/help_docs/manpages/logger.1 @@ -1,10 +1,10 @@ -.TH log_enum 1 "27 AUG 2024" "0.10.1" +.TH logger 1 "23 OCT 2024" "0.10.2" .SH NAME -.B log_enum +.B logger .SH SYNOPSIS -.B log_enum +.B logger .RB [OPTIONS] .SH DESCRIPTION diff --git a/examples/log_enum_meta/help_docs/markdown/log_enum.md b/examples/logger_meta/help_docs/markdown/logger.md similarity index 71% rename from examples/log_enum_meta/help_docs/markdown/log_enum.md rename to examples/logger_meta/help_docs/markdown/logger.md index c8d2240..244536d 100644 --- a/examples/log_enum_meta/help_docs/markdown/log_enum.md +++ b/examples/logger_meta/help_docs/markdown/logger.md @@ -1,8 +1,8 @@ -# log_enum +# logger A small demo of using the Log Level Enum as an Option. -__Version:__ 0.10.1
-__Date:__ 27 AUG 2024
+__Version:__ 0.10.2
+__Date:__ 23 OCT 2024
__Author:__ 00JCIV00
__Copyright:__ MIT License
___ @@ -10,8 +10,8 @@ ___ ## Usage ```shell USAGE: - log_enum ​​--log-level - log_enum + logger ​​--log-level + logger ``` diff --git a/examples/log_enum_meta/tab_completions/_log_enum-completion.zsh b/examples/logger_meta/tab_completions/_logger-completion.zsh similarity index 79% rename from examples/log_enum_meta/tab_completions/_log_enum-completion.zsh rename to examples/logger_meta/tab_completions/_logger-completion.zsh index 4c7af3d..a49b3d1 100644 --- a/examples/log_enum_meta/tab_completions/_log_enum-completion.zsh +++ b/examples/logger_meta/tab_completions/_logger-completion.zsh @@ -1,15 +1,15 @@ -#compdef log_enum +#compdef logger # This Tab Completion script was generated by the Cova Library. # Details at https://github.com/00JCIV00/cova -# Zsh Completion Installation Instructions for log_enum +# Zsh Completion Installation Instructions for logger # 1. Place this script in a directory specified in your $fpath, or a new one such as # ~/.zsh/completion/ # # 2. Ensure the script has executable permissions: -# chmod +x _log_enum-completion.zsh +# chmod +x _logger-completion.zsh # # 3. Add the script's directory to your $fpath in your .zshrc if not already included: # fpath=(~/.zsh/completion $fpath) @@ -24,13 +24,13 @@ # Associative array to hold Commands, Options, and their descriptions with arbitrary depth typeset -A cmd_args cmd_args=( - "log_enum" "help usage --log-level --help --usage" + "logger" "help usage --log-level --help --usage" ) # Generic function for command completions -_log_enum_completions() { +_logger_completions() { local -a completions # Determine the current command context - local context="log_enum" + local context="logger" for word in "${words[@]:1:$CURRENT-1}"; do if [[ -n $cmd_args[${context}_${word}] ]]; then context="${context}_${word}" @@ -39,7 +39,7 @@ _log_enum_completions() { # Generate completions for the current context completions=(${(s: :)cmd_args[$context]}) if [[ -n $completions ]]; then - _describe -t commands "log_enum" completions && return 0 + _describe -t commands "logger" completions && return 0 fi } -_log_enum_completions "$@" \ No newline at end of file +_logger_completions "$@" \ No newline at end of file diff --git a/examples/log_enum_meta/tab_completions/log_enum-completion.bash b/examples/logger_meta/tab_completions/logger-completion.bash similarity index 78% rename from examples/log_enum_meta/tab_completions/log_enum-completion.bash rename to examples/logger_meta/tab_completions/logger-completion.bash index 980c00e..d620e8a 100644 --- a/examples/log_enum_meta/tab_completions/log_enum-completion.bash +++ b/examples/logger_meta/tab_completions/logger-completion.bash @@ -4,28 +4,28 @@ # Details at https://github.com/00JCIV00/cova -# Bash Completion Installation Instructions for log_enum +# Bash Completion Installation Instructions for logger # 1. Place this script in a directory like /etc/bash_completion.d/ (Linux) # or /usr/local/etc/bash_completion.d/ (Mac, if using Homebrew and bash-completion) # # 2. Ensure the script has executable permissions: -# chmod +x log_enum-completion.bash +# chmod +x logger-completion.bash # # 3. Source this script from your .bashrc or .bash_profile by adding: -# . /path/to/log_enum-completion.bash +# . /path/to/logger-completion.bash # # 4. Restart your terminal session or source your profile again: # source ~/.bashrc # or ~/.bash_profile -_log_enum_completions() { +_logger_completions() { local cur prev COMPREPLY=() cur="${COMP_WORDS[COMP_CWORD]}" prev="${COMP_WORDS[COMP_CWORD - 1]}" case "${prev}" in - "log_enum") + "logger") COMPREPLY=($(compgen -W "help usage --log-level --help --usage" -- ${cur})) ;; *) @@ -34,4 +34,4 @@ _log_enum_completions() { } -complete -F _log_enum_completions log_enum \ No newline at end of file +complete -F _logger_completions logger \ No newline at end of file diff --git a/examples/log_enum_meta/tab_completions/log_enum-completion.ps1 b/examples/logger_meta/tab_completions/logger-completion.ps1 similarity index 86% rename from examples/log_enum_meta/tab_completions/log_enum-completion.ps1 rename to examples/logger_meta/tab_completions/logger-completion.ps1 index 40ca531..fe7b4ab 100644 --- a/examples/log_enum_meta/tab_completions/log_enum-completion.ps1 +++ b/examples/logger_meta/tab_completions/logger-completion.ps1 @@ -4,9 +4,9 @@ # Details at https://github.com/00JCIV00/cova -# PowerShell Completion Installation Instructions for log_enum +# PowerShell Completion Installation Instructions for logger # 1. Load the completion script into your current PowerShell session: -# . .\log_enum-completion.ps1 +# . .\logger-completion.ps1 # # 2. Ensure your Execution Policy allows the script to be run. Example: # Set-ExecutionPolicy RemoteSigned @@ -14,13 +14,13 @@ # 3. To ensure this completion script is loaded automatically in future sessions, # add the above sourcing command to your PowerShell profile: # Notepad $PROFILE -# Add the line: . C:\path\to\log_enum-completion.ps1 +# Add the line: . C:\path\to\logger-completion.ps1 # # 4. Restart your PowerShell session or source your profile again: # . $PROFILE -function _log_enum { +function _logger { param($wordToComplete, $commandAst) $suggestions = @( 'help', @@ -32,7 +32,7 @@ function _log_enum { return $suggestions | Where-Object { $_ -like "$wordToComplete*" } } -Register-ArgumentCompleter -CommandName 'log_enum.exe' -ScriptBlock { +Register-ArgumentCompleter -CommandName 'logger.exe' -ScriptBlock { param($wordToComplete, $commandAst, $cursorPos) $functionName = "_" + $($commandAst.Extent.Text.replace(' ', '-').replace(".exe", ""))