Improve boolean flag documentation generation

[gmargaritis]

Resolves#47

Updated the documentation generation logic to include values in Type and Default columns for boolean flags that have true as a default value. This change addresses the need for users to differentiate between boolean flags that require explicit negation.

[gmargaritis]

@thaJeztah Let me know if we want to also display the Type of boolean flags regardless of their default value

[crazy-max]

I think we want the same for yaml generation?

[crazy-max]

Can we also have a test for this case?

[thaJeztah]

@crazy-max I think we already unconditionally set the default value for YAML; at least looking at the fixture here, I see "false" as default;

cli-docs-tool/fixtures/docker_buildx_build.yaml

Lines 74 to 78 in f588677

	- option: compress
	value_type: bool
	default_value: "false"
	description: Compress the build context using gzip
	deprecated: false

[crazy-max]

@crazy-max I think we already unconditionally set the default value for YAML; at least looking at the fixture here, I see "false" as default;

cli-docs-tool/fixtures/docker_buildx_build.yaml

Lines 74 to 78 in f588677

	- option: compress
	value_type: bool
	default_value: "false"
	description: Compress the build context using gzip
	deprecated: false

Ah ok looks good then 👍

[gmargaritis]

That's correct! Do we want to make any changes here?

cli-docs-tool/clidocstool_yaml.go

Lines 271 to 290 in f588677

	flags.VisitAll(func(flag*pflag.Flag) {
	opt=cmdOption{
	Option: flag.Name,
	ValueType: flag.Value.Type(),
	Deprecated: len(flag.Deprecated) >0,
	Hidden: flag.Hidden,
	}
	vardefvalstring
	ifv, ok:=flag.Annotations[annotation.DefaultValue]; ok&&len(v) >0 {
	defval=v[0]
	ifcd, ok:=flag.Annotations[annotation.CodeDelimiter]; ok {
	defval=strings.ReplaceAll(defval, cd[0], "`")
	} elseifcd, ok:=cmd.Annotations[annotation.CodeDelimiter]; ok {
	defval=strings.ReplaceAll(defval, cd, "`")
	}
	} else {
	defval=flag.DefValue
	}
	opt.DefaultValue=forceMultiLine(defval, defaultValueMaxWidth)

[thaJeztah]

LGTM

we should probably look at some additional test-cases in a follow-up

[thaJeztah]

For a follow-up, we should probably look at splitting some of these up. Things start to become too complicated IMO (too many boolean conditions here, which makes it easy to introduce bugs).

[thaJeztah]

@crazy-max LGTY?

[crazy-max]

Can we have a test in https://github.com/docker/cli-docs-tool/blob/main/clidocstool_test.go#L38? Just a dummy new flag like --detach that will default to true and update fixtures as well in https://github.com/docker/cli-docs-tool/tree/main/fixtures

[gmargaritis]

@crazy-max Added the test case, we should be good to go!

[crazy-max]

LGTM thanks!