Mirrors/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-03-23 05:49:27 +01:00
Code Issues Projects Releases Packages Wiki Activity

cmd: fmt: --write -> --overwrite to make it clear it's destructive

Browse source
This commit is contained in:
Matthew Holt 2020-03-15 21:18:31 -06:00
parent 8f8ecd2e2a
commit c67c8e60cc
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
2 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
cmd/commandfuncs.go
View file

@ -514,14 +514,12 @@ func cmdValidateConfig(fl Flags) (int, error) {
return caddy.ExitCodeSuccess, nil return caddy.ExitCodeSuccess, nil
} }
func cmdFormatConfig(fl Flags) (int, error) { func cmdFmt(fl Flags) (int, error) {
// Default path of file is Caddyfile
formatCmdConfigFile := fl.Arg(0) formatCmdConfigFile := fl.Arg(0)
if formatCmdConfigFile == "" { if formatCmdConfigFile == "" {
formatCmdConfigFile = "Caddyfile" formatCmdConfigFile = "Caddyfile"
} }
overwrite := fl.Bool("overwrite")
formatCmdWriteFlag := fl.Bool("write")
input, err := ioutil.ReadFile(formatCmdConfigFile) input, err := ioutil.ReadFile(formatCmdConfigFile)
if err != nil { if err != nil {
@ -531,7 +529,7 @@ func cmdFormatConfig(fl Flags) (int, error) {
output := caddyfile.Format(input) output := caddyfile.Format(input)
if formatCmdWriteFlag { if overwrite {
err = ioutil.WriteFile(formatCmdConfigFile, output, 0644) err = ioutil.WriteFile(formatCmdConfigFile, output, 0644)
if err != nil { if err != nil {
return caddy.ExitCodeFailedStartup, nil return caddy.ExitCodeFailedStartup, nil

6
cmd/commands.go
View file

@ -244,8 +244,8 @@ provisioning stages.`,
RegisterCommand(Command{ RegisterCommand(Command{
Name: "fmt", Name: "fmt",
Func: cmdFormatConfig, Func: cmdFmt,
Usage: "[--write] [<path>]", Usage: "[--overwrite] [<path>]",
Short: "Formats a Caddyfile", Short: "Formats a Caddyfile",
Long: ` Long: `
Formats the Caddyfile by adding proper indentation and spaces to improve Formats the Caddyfile by adding proper indentation and spaces to improve
@ -255,7 +255,7 @@ If --write is specified, the output will be written to the config file
directly instead of printing it.`, directly instead of printing it.`,
Flags: func() *flag.FlagSet { Flags: func() *flag.FlagSet {
fs := flag.NewFlagSet("format", flag.ExitOnError) fs := flag.NewFlagSet("format", flag.ExitOnError)
fs.Bool("write", false, "Over-write the output to specified file") fs.Bool("overwrite", false, "Overwrite the input file with the results")
return fs return fs
}(), }(),
}) })