mirror of
https://github.com/Belphemur/CBZOptimizer.git
synced 2026-01-11 16:17:04 +01:00
3a2fb2a97e
- Add detailed docstring to setupFormatFlag explaining parameters and usage - Add detailed docstring to setupTestCommand explaining return values - Use constant.DefaultConversion instead of hard-coded constant.WebP for better maintainability - Clarify when bindViper should be true vs false Co-authored-by: Belphemur <197810+Belphemur@users.noreply.github.com>
33 lines
1.1 KiB
Go
33 lines
1.1 KiB
Go
package commands
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/belphemur/CBZOptimizer/v2/pkg/converter/constant"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/viper"
|
|
"github.com/thediveo/enumflag/v2"
|
|
)
|
|
|
|
// setupFormatFlag sets up the format flag for a command.
|
|
//
|
|
// Parameters:
|
|
// - cmd: The Cobra command to add the format flag to
|
|
// - converterType: Pointer to the ConversionFormat variable that will store the flag value
|
|
// - bindViper: If true, binds the flag to viper for configuration file support.
|
|
// Set to true for commands that use viper for configuration (e.g., watch command),
|
|
// and false for commands that don't (e.g., optimize command).
|
|
func setupFormatFlag(cmd *cobra.Command, converterType *constant.ConversionFormat, bindViper bool) {
|
|
formatFlag := enumflag.New(converterType, "format", constant.CommandValue, enumflag.EnumCaseInsensitive)
|
|
_ = formatFlag.RegisterCompletion(cmd, "format", constant.HelpText)
|
|
|
|
cmd.Flags().VarP(
|
|
formatFlag,
|
|
"format", "f",
|
|
fmt.Sprintf("Format to convert the images to: %s", constant.ListAll()))
|
|
|
|
if bindViper {
|
|
_ = viper.BindPFlag("format", cmd.Flags().Lookup("format"))
|
|
}
|
|
}
|