From 4d00df87a036603328cd618289934a2f9f16c3bc Mon Sep 17 00:00:00 2001 From: jasonBirchall Date: Sat, 28 Dec 2024 19:19:08 +0000 Subject: [PATCH] :recycle: Refactor command descriptions in lazycommit subcommands --- docs/lazycommit.md | 29 --------------- docs/lazycommit_commit.md | 24 ------------- docs/lazycommit_completion.md | 25 ------------- docs/lazycommit_completion_bash.md | 44 ----------------------- docs/lazycommit_completion_fish.md | 35 ------------------ docs/lazycommit_completion_powershell.md | 32 ----------------- docs/lazycommit_completion_zsh.md | 46 ------------------------ docs/lazycommit_docs.md | 24 ------------- docs/lazycommit_init.md | 24 ------------- docs/lazycommit_serve.md | 28 --------------- 10 files changed, 311 deletions(-) delete mode 100644 docs/lazycommit.md delete mode 100644 docs/lazycommit_commit.md delete mode 100644 docs/lazycommit_completion.md delete mode 100644 docs/lazycommit_completion_bash.md delete mode 100644 docs/lazycommit_completion_fish.md delete mode 100644 docs/lazycommit_completion_powershell.md delete mode 100644 docs/lazycommit_completion_zsh.md delete mode 100644 docs/lazycommit_docs.md delete mode 100644 docs/lazycommit_init.md delete mode 100644 docs/lazycommit_serve.md diff --git a/docs/lazycommit.md b/docs/lazycommit.md deleted file mode 100644 index 3903447..0000000 --- a/docs/lazycommit.md +++ /dev/null @@ -1,29 +0,0 @@ -## lazycommit - -A simple CLI tool to commit changes to git with a message - -### Synopsis - -A longer description that spans multiple lines and likely contains -examples and usage of using your application. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application. - -### Options - -``` - -h, --help help for lazycommit - -t, --toggle Help message for toggle -``` - -### SEE ALSO - -* [lazycommit commit](lazycommit_commit.md) - Prints out the diff in the current directory and suggests commit messages -* [lazycommit completion](lazycommit_completion.md) - Generate the autocompletion script for the specified shell -* [lazycommit docs](lazycommit_docs.md) - Generates Markdown documentation for the CLI -* [lazycommit init](lazycommit_init.md) - Initializes the configuration file in the user's Linux profile -* [lazycommit serve](lazycommit_serve.md) - A brief description of your command - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_commit.md b/docs/lazycommit_commit.md deleted file mode 100644 index f00351c..0000000 --- a/docs/lazycommit_commit.md +++ /dev/null @@ -1,24 +0,0 @@ -## lazycommit commit - -Prints out the diff in the current directory and suggests commit messages - -### Synopsis - -This command prints out the diff of the changes in the current directory. -It helps you see what changes have been made before committing them. It also suggests commit messages. - -``` -lazycommit commit [flags] -``` - -### Options - -``` - -h, --help help for commit -``` - -### SEE ALSO - -* [lazycommit](lazycommit.md) - A simple CLI tool to commit changes to git with a message - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_completion.md b/docs/lazycommit_completion.md deleted file mode 100644 index ab81a98..0000000 --- a/docs/lazycommit_completion.md +++ /dev/null @@ -1,25 +0,0 @@ -## lazycommit completion - -Generate the autocompletion script for the specified shell - -### Synopsis - -Generate the autocompletion script for lazycommit for the specified shell. -See each sub-command's help for details on how to use the generated script. - - -### Options - -``` - -h, --help help for completion -``` - -### SEE ALSO - -* [lazycommit](lazycommit.md) - A simple CLI tool to commit changes to git with a message -* [lazycommit completion bash](lazycommit_completion_bash.md) - Generate the autocompletion script for bash -* [lazycommit completion fish](lazycommit_completion_fish.md) - Generate the autocompletion script for fish -* [lazycommit completion powershell](lazycommit_completion_powershell.md) - Generate the autocompletion script for powershell -* [lazycommit completion zsh](lazycommit_completion_zsh.md) - Generate the autocompletion script for zsh - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_completion_bash.md b/docs/lazycommit_completion_bash.md deleted file mode 100644 index 0a53f7c..0000000 --- a/docs/lazycommit_completion_bash.md +++ /dev/null @@ -1,44 +0,0 @@ -## lazycommit completion bash - -Generate the autocompletion script for bash - -### Synopsis - -Generate the autocompletion script for the bash shell. - -This script depends on the 'bash-completion' package. -If it is not installed already, you can install it via your OS's package manager. - -To load completions in your current shell session: - - source <(lazycommit completion bash) - -To load completions for every new session, execute once: - -#### Linux: - - lazycommit completion bash > /etc/bash_completion.d/lazycommit - -#### macOS: - - lazycommit completion bash > $(brew --prefix)/etc/bash_completion.d/lazycommit - -You will need to start a new shell for this setup to take effect. - - -``` -lazycommit completion bash -``` - -### Options - -``` - -h, --help help for bash - --no-descriptions disable completion descriptions -``` - -### SEE ALSO - -* [lazycommit completion](lazycommit_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_completion_fish.md b/docs/lazycommit_completion_fish.md deleted file mode 100644 index df7a262..0000000 --- a/docs/lazycommit_completion_fish.md +++ /dev/null @@ -1,35 +0,0 @@ -## lazycommit completion fish - -Generate the autocompletion script for fish - -### Synopsis - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: - - lazycommit completion fish | source - -To load completions for every new session, execute once: - - lazycommit completion fish > ~/.config/fish/completions/lazycommit.fish - -You will need to start a new shell for this setup to take effect. - - -``` -lazycommit completion fish [flags] -``` - -### Options - -``` - -h, --help help for fish - --no-descriptions disable completion descriptions -``` - -### SEE ALSO - -* [lazycommit completion](lazycommit_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_completion_powershell.md b/docs/lazycommit_completion_powershell.md deleted file mode 100644 index ed73b19..0000000 --- a/docs/lazycommit_completion_powershell.md +++ /dev/null @@ -1,32 +0,0 @@ -## lazycommit completion powershell - -Generate the autocompletion script for powershell - -### Synopsis - -Generate the autocompletion script for powershell. - -To load completions in your current shell session: - - lazycommit completion powershell | Out-String | Invoke-Expression - -To load completions for every new session, add the output of the above command -to your powershell profile. - - -``` -lazycommit completion powershell [flags] -``` - -### Options - -``` - -h, --help help for powershell - --no-descriptions disable completion descriptions -``` - -### SEE ALSO - -* [lazycommit completion](lazycommit_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_completion_zsh.md b/docs/lazycommit_completion_zsh.md deleted file mode 100644 index a96350d..0000000 --- a/docs/lazycommit_completion_zsh.md +++ /dev/null @@ -1,46 +0,0 @@ -## lazycommit completion zsh - -Generate the autocompletion script for zsh - -### Synopsis - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need -to enable it. You can execute the following once: - - echo "autoload -U compinit; compinit" >> ~/.zshrc - -To load completions in your current shell session: - - source <(lazycommit completion zsh) - -To load completions for every new session, execute once: - -#### Linux: - - lazycommit completion zsh > "${fpath[1]}/_lazycommit" - -#### macOS: - - lazycommit completion zsh > $(brew --prefix)/share/zsh/site-functions/_lazycommit - -You will need to start a new shell for this setup to take effect. - - -``` -lazycommit completion zsh [flags] -``` - -### Options - -``` - -h, --help help for zsh - --no-descriptions disable completion descriptions -``` - -### SEE ALSO - -* [lazycommit completion](lazycommit_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_docs.md b/docs/lazycommit_docs.md deleted file mode 100644 index 8aa3487..0000000 --- a/docs/lazycommit_docs.md +++ /dev/null @@ -1,24 +0,0 @@ -## lazycommit docs - -Generates Markdown documentation for the CLI - -### Synopsis - -This command generates Markdown documentation for the CLI commands -and saves it in the docs directory. - -``` -lazycommit docs [flags] -``` - -### Options - -``` - -h, --help help for docs -``` - -### SEE ALSO - -* [lazycommit](lazycommit.md) - A simple CLI tool to commit changes to git with a message - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_init.md b/docs/lazycommit_init.md deleted file mode 100644 index d215085..0000000 --- a/docs/lazycommit_init.md +++ /dev/null @@ -1,24 +0,0 @@ -## lazycommit init - -Initializes the configuration file in the user's Linux profile - -### Synopsis - -This command initializes a configuration file named .lazycommit.yaml -in the user's home directory. - -``` -lazycommit init [flags] -``` - -### Options - -``` - -h, --help help for init -``` - -### SEE ALSO - -* [lazycommit](lazycommit.md) - A simple CLI tool to commit changes to git with a message - -###### Auto generated by spf13/cobra on 22-Nov-2024 diff --git a/docs/lazycommit_serve.md b/docs/lazycommit_serve.md deleted file mode 100644 index 2e5147c..0000000 --- a/docs/lazycommit_serve.md +++ /dev/null @@ -1,28 +0,0 @@ -## lazycommit serve - -A brief description of your command - -### Synopsis - -A longer description that spans multiple lines and likely contains examples -and usage of using your command. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application. - -``` -lazycommit serve [flags] -``` - -### Options - -``` - -h, --help help for serve -``` - -### SEE ALSO - -* [lazycommit](lazycommit.md) - A simple CLI tool to commit changes to git with a message - -###### Auto generated by spf13/cobra on 22-Nov-2024