Adjust description and flags

Author: BrunoQuaresma

config.go

@@ -39,242 +39,227 @@ type Config struct {
 func (c *Config) Options() serpent.OptionSet {
 	return serpent.OptionSet{
 		{
-			Name:  "Setup Script",
-			Env:   "SETUP_SCRIPT",
 			Flag:  "setup-script",
+			Env:   "SETUP_SCRIPT",
 			Value: serpent.StringOf(&c.SetupScript),
-			Description: `SetupScript is the script to run before the init script.
-			It runs as the root user regardless of the user specified
-			in the devcontainer.json file.
-			
-			SetupScript is ran as the root user prior to the init script.
-			It is used to configure envbuilder dynamically during the runtime.
-			e.g. specifying whether to start ` + "`systemd`" + ` or ` + "`tiny init`" + ` for PID 1.`,
+			Description: "SetupScript is the script to run before the init script. It runs as " +
+				"the root user regardless of the user specified in the devcontainer.json " +
+				"file.\n\nSetupScript is ran as the root user prior to the init script. " +
+				"It is used to configure envbuilder dynamically during the runtime. e.g. " +
+				"specifying whether to start systemd or tiny init for PID 1.",
 		},
 		{
-			Name:        "Init Script",
+			Flag:        "init-script",
 			Env:         "INIT_SCRIPT",
 			Default:     "sleep infinity",
 			Value:       serpent.StringOf(&c.InitScript),
 			Description: "InitScript is the script to run to initialize the workspace.",
 		},
 		{
-			Name:        "Init Command",
+			Flag:        "init-command",
 			Env:         "INIT_COMMAND",
 			Default:     "/bin/sh",
 			Value:       serpent.StringOf(&c.InitCommand),
 			Description: "InitCommand is the command to run to initialize the workspace.",
 		},
 		{
-			Name:  "Init Args",
+			Flag:  "init-args",
 			Env:   "INIT_ARGS",
 			Value: serpent.StringOf(&c.InitArgs),
-			Description: `InitArgs are the arguments to pass to the init command.
-			They are split according to ` + "`/bin/sh`" + ` rules with
-			https://github.com/kballard/go-shellquote.`,
+			Description: "InitArgs are the arguments to pass to the init command. They are " +
+				"split according to /bin/sh rules with " +
+				"https://github.com/kballard/go-shellquote.",
 		},
 		{
-			Name:  "Cache Repo",
+			Flag:  "cache-repo",
 			Env:   "CACHE_REPO",
 			Value: serpent.StringOf(&c.CacheRepo),
-			Description: `CacheRepo is the name of the container registry
-			to push the cache image to. If this is empty, the cache
-			will not be pushed.`,
+			Description: "CacheRepo is the name of the container registry to push the cache " +
+				"image to. If this is empty, the cache will not be pushed.",
 		},
 		{
-			Name:  "Base Image Cache Dir",
+			Flag:  "base-image-cache-dir",
 			Env:   "BASE_IMAGE_CACHE_DIR",
 			Value: serpent.StringOf(&c.BaseImageCacheDir),
-			Description: `BaseImageCacheDir is the path to a directory where the base
-			image can be found. This should be a read-only directory
-			solely mounted for the purpose of caching the base image.`,
+			Description: "BaseImageCacheDir is the path to a directory where the base image " +
+				"can be found. This should be a read-only directory solely mounted " +
+				"for the purpose of caching the base image.",
 		},
 		{
-			Name:  "Layer Cache Dir",
+			Flag:  "layer-cache-dir",
 			Env:   "LAYER_CACHE_DIR",
 			Value: serpent.StringOf(&c.LayerCacheDir),
-			Description: `LayerCacheDir is the path to a directory where built layers
-			will be stored. This spawns an in-memory registry to serve
-			the layers from.`,
+			Description: "LayerCacheDir is the path to a directory where built layers will " +
+				"be stored. This spawns an in-memory registry to serve the layers " +
+				"from.",
 		},
 		{
-			Name:  "Devcontainer Dir",
+			Flag:  "devcontainer-dir",
 			Env:   "DEVCONTAINER_DIR",
 			Value: serpent.StringOf(&c.DevcontainerDir),
-			Description: `DevcontainerDir is a path to the folder containing
-			the devcontainer.json file that will be used to build the
-			workspace and can either be an absolute path or a path
-			relative to the workspace folder. If not provided, defaults to
-			` + "`.devcontainer`" + `.`,
+			Description: "DevcontainerDir is a path to the folder containing the " +
+				"devcontainer.json file that will be used to build the workspace " +
+				"and can either be an absolute path or a path relative to the " +
+				"workspace folder. If not provided, defaults to `.devcontainer`.",
 		},
 		{
-			Name:  "Devcontainer JSON Path",
+			Flag:  "devcontainer-json-path",
 			Env:   "DEVCONTAINER_JSON_PATH",
 			Value: serpent.StringOf(&c.DevcontainerJSONPath),
-			Description: `DevcontainerJSONPath is a path to a devcontainer.json file
-			that is either an absolute path or a path relative to
-			DevcontainerDir. This can be used in cases where one wants
-			to substitute an edited devcontainer.json file for the one
-			that exists in the repo.`,
+			Description: "DevcontainerJSONPath is a path to a devcontainer.json file that " +
+				"is either an absolute path or a path relative to DevcontainerDir. " +
+				"This can be used in cases where one wants to substitute an edited " +
+				"devcontainer.json file for the one that exists in the repo.",
 		},
 		{
-			Name:  "Dockerfile Path",
+			Flag:  "dockerfile-path",
 			Env:   "DOCKERFILE_PATH",
 			Value: serpent.StringOf(&c.DockerfilePath),
-			Description: `DockerfilePath is a relative path to the Dockerfile that
-			will be used to build the workspace. This is an alternative
-			to using a devcontainer that some might find simpler.`,
+			Description: "DockerfilePath is a relative path to the Dockerfile that will " +
+				"be used to build the workspace. This is an alternative to using " +
+				"a devcontainer that some might find simpler.",
 		},
 		{
-			Name:  "Build Context Path",
-			Env:   `BUILD_CONTEXT_PATH`,
+			Flag:  "build-context-path",
+			Env:   "BUILD_CONTEXT_PATH",
 			Value: serpent.StringOf(&c.BuildContextPath),
-			Description: `BuildContextPath can be specified when a DockerfilePath is specified outside the base WorkspaceFolder.
-			This path MUST be relative to the WorkspaceFolder path into which the repo is cloned.`,
+			Description: "BuildContextPath can be specified when a DockerfilePath is " +
+				"specified outside the base WorkspaceFolder. This path MUST be " +
+				"relative to the WorkspaceFolder path into which the repo is cloned.",
 		},
 		{
-			Name:  "Cache TTL Days",
+			Flag:  "cache-ttl-days",
 			Env:   "CACHE_TTL_DAYS",
 			Value: serpent.Int64Of(&c.CacheTTLDays),
-			Description: `CacheTTLDays is the number of days to use cached layers before
-			expiring them. Defaults to 7 days.`,
+			Description: "CacheTTLDays is the number of days to use cached layers before " +
+				"expiring them. Defaults to 7 days.",
 		},
 		{
-			Name:  "Docker Config Base64",
+			Flag:  "docker-config-base64",
 			Env:   "DOCKER_CONFIG_BASE64",
 			Value: serpent.StringOf(&c.DockerConfigBase64),
-			Description: `DockerConfigBase64 is a base64 encoded Docker config
-			file that will be used to pull images from private
-			container registries.`,
+			Description: "DockerConfigBase64 is a base64 encoded Docker config file that " +
+				"will be used to pull images from private container registries.",
 		},
 		{
-			Name:  "Fallback Image",
+			Flag:  "fallback-image",
 			Env:   "FALLBACK_IMAGE",
 			Value: serpent.StringOf(&c.FallbackImage),
-			Description: `FallbackImage specifies an alternative image to use when neither
-			an image is declared in the devcontainer.json file nor a Dockerfile is present.
-			If there's a build failure (from a faulty Dockerfile) or a misconfiguration,
-			this image will be the substitute.
-			Set ` + "`ExitOnBuildFailure`" + ` to true to halt the container if the build faces an issue.`,
+			Description: "FallbackImage specifies an alternative image to use when neither " +
+				"an image is declared in the devcontainer.json file nor a Dockerfile " +
+				"is present. If there's a build failure (from a faulty Dockerfile) " +
+				"or a misconfiguration, this image will be the substitute. Set " +
+				"ExitOnBuildFailure to true to halt the container if the build " +
+				"faces an issue.",
 		},
 		{
+			Flag:  "exit-on-build-failure",
 			Env:   "EXIT_ON_BUILD_FAILURE",
 			Value: serpent.BoolOf(&c.ExitOnBuildFailure),
-			Description: `ExitOnBuildFailure terminates the container upon a build failure.
-			This is handy when preferring the ` + "`FALLBACK_IMAGE`" + ` in cases where
-			no devcontainer.json or image is provided. However, it ensures
-			that the container stops if the build process encounters an error.`,
+			Description: "ExitOnBuildFailure terminates the container upon a build failure. " +
+				"This is handy when preferring the FALLBACK_IMAGE in cases where " +
+				"no devcontainer.json or image is provided. However, it ensures " +
+				"that the container stops if the build process encounters an error.",
 		},
 		{
-			Name:  "Force Safe",
+			Flag:  "force-safe",
 			Env:   "FORCE_SAFE",
 			Value: serpent.BoolOf(&c.ForceSafe),
-			Description: `ForceSafe ignores any filesystem safety checks.
-			This could cause serious harm to your system!
-			This is used in cases where bypass is needed
-			to unblock customers.`,
+			Description: "ForceSafe ignores any filesystem safety checks. This could cause " +
+				"serious harm to your system! This is used in cases where bypass " +
+				"is needed to unblock customers.",
 		},
 		{
-			Name:  "Insecure",
+			Flag:  "insecure",
 			Env:   "INSECURE",
 			Value: serpent.BoolOf(&c.Insecure),
-			Description: `Insecure bypasses TLS verification when cloning
-			and pulling from container registries.`,
+			Description: "Insecure bypasses TLS verification when cloning and pulling from " +
+				"container registries.",
 		},
 		{
-			Name:  "Ignore Paths",
-			Env:   "IGNORE_PATHS",
-			Value: serpent.StringArrayOf(&c.IgnorePaths),
-			// Kubernetes frequently stores secrets in /var/run/secrets, and
-			// other applications might as well. This seems to be a sensible
-			// default, but if that changes, it's simple to adjust.
+			Flag:    "ignore-paths",
+			Env:     "IGNORE_PATHS",
+			Value:   serpent.StringArrayOf(&c.IgnorePaths),
 			Default: "/var/run",
-			Description: `IgnorePaths is a comma separated list of paths
-			to ignore when building the workspace.`,
+			Description: "IgnorePaths is a comma separated list of paths to ignore when " +
+				"building the workspace.",
 		},
 		{
-			Name:  "Skip Rebuild",
+			Flag:  "skip-rebuild",
 			Env:   "SKIP_REBUILD",
 			Value: serpent.BoolOf(&c.SkipRebuild),
-			Description: `SkipRebuild skips building if the MagicFile exists.
-			This is used to skip building when a container is
-			restarting. e.g. docker stop -> docker start
-			This value can always be set to true - even if the
-			container is being started for the first time.`,
+			Description: "SkipRebuild skips building if the MagicFile exists. This is used " +
+				"to skip building when a container is restarting. e.g. docker stop -> " +
+				"docker start This value can always be set to true - even if the " +
+				"container is being started for the first time.",
 		},
 		{
-			Name:  "Git URL",
-			Env:   "GIT_URL",
-			Value: serpent.StringOf(&c.GitURL),
-			Description: `GitURL is the URL of the Git repository to clone.
-			This is optional.`,
+			Flag:        "git-url",
+			Env:         "GIT_URL",
+			Value:       serpent.StringOf(&c.GitURL),
+			Description: "GitURL is the URL of the Git repository to clone. This is optional.",
 		},
 		{
-			Name:  "Git Clone Depth",
-			Env:   "GIT_CLONE_DEPTH",
-			Value: serpent.Int64Of(&c.GitCloneDepth),
-			Description: `GitCloneDepth is the depth to use when cloning
-			the Git repository.`,
+			Flag:        "git-clone-depth",
+			Env:         "GIT_CLONE_DEPTH",
+			Value:       serpent.Int64Of(&c.GitCloneDepth),
+			Description: "GitCloneDepth is the depth to use when cloning the Git repository.",
 		},
 		{
-			Name:  "Git Clone Single Branch",
-			Env:   "GIT_CLONE_SINGLE_BRANCH",
-			Value: serpent.BoolOf(&c.GitCloneSingleBranch),
-			Description: `GitCloneSingleBranch clones only a single branch
-			of the Git repository.`,
+			Flag:        "git-clone-single-branch",
+			Env:         "GIT_CLONE_SINGLE_BRANCH",
+			Value:       serpent.BoolOf(&c.GitCloneSingleBranch),
+			Description: "GitCloneSingleBranch clones only a single branch of the Git repository.",
 		},
 		{
-			Name:  "Git Username",
-			Env:   "GIT_USERNAME",
-			Value: serpent.StringOf(&c.GitUsername),
-			Description: `GitUsername is the username to use for Git authentication.
-			This is optional.`,
+			Flag:        "git-username",
+			Env:         "GIT_USERNAME",
+			Value:       serpent.StringOf(&c.GitUsername),
+			Description: "GitUsername is the username to use for Git authentication. This is optional.",
 		},
 		{
-			Name:  "Git Password",
-			Env:   "GIT_PASSWORD",
-			Value: serpent.StringOf(&c.GitPassword),
-			Description: `GitPassword is the password to use for Git authentication.
-			This is optional.`,
+			Flag:        "git-password",
+			Env:         "GIT_PASSWORD",
+			Value:       serpent.StringOf(&c.GitPassword),
+			Description: "GitPassword is the password to use for Git authentication. This is optional.",
 		},
 		{
-			Name:  "Git HTTP Proxy URL",
-			Env:   "GIT_HTTP_PROXY_URL",
-			Value: serpent.StringOf(&c.GitHTTPProxyURL),
-			Description: `GitHTTPProxyURL is the url for the http proxy.
-			This is optional.`,
+			Flag:        "git-http-proxy-url",
+			Env:         "GIT_HTTP_PROXY_URL",
+			Value:       serpent.StringOf(&c.GitHTTPProxyURL),
+			Description: "GitHTTPProxyURL is the url for the http proxy. This is optional.",
 		},
 		{
-			Name:  "Workspace Folder",
+			Flag:  "workspace-folder",
 			Env:   "WORKSPACE_FOLDER",
 			Value: serpent.StringOf(&c.WorkspaceFolder),
-			Description: `WorkspaceFolder is the path to the workspace folder
-			that will be built. This is optional.`,
+			Description: "WorkspaceFolder is the path to the workspace folder that will " +
+				"be built. This is optional.",
 		},
 		{
-			Name:  "SSL Cert Base64",
+			Flag:  "ssl-cert-base64",
 			Env:   "SSL_CERT_BASE64",
 			Value: serpent.StringOf(&c.SSLCertBase64),
-			Description: `SSLCertBase64 is the content of an SSL cert file.
-			This is useful for self-signed certificates.`,
+			Description: "SSLCertBase64 is the content of an SSL cert file. This is useful " +
+				"for self-signed certificates.",
 		},
 		{
-			Name:  "Export Env File",
+			Flag:  "export-env-file",
 			Env:   "EXPORT_ENV_FILE",
 			Value: serpent.StringOf(&c.ExportEnvFile),
-			Description: `ExportEnvFile is an optional file path to a .env file where
-			envbuilder will dump environment variables from devcontainer.json and
-			the built container image.`,
+			Description: "ExportEnvFile is an optional file path to a .env file where " +
+				"envbuilder will dump environment variables from devcontainer.json " +
+				"and the built container image.",
 		},
 		{
-			Name:  "Post Start Script Path",
+			Flag:  "post-start-script-path",
 			Env:   "POST_START_SCRIPT_PATH",
 			Value: serpent.StringOf(&c.PostStartScriptPath),
-			Description: `PostStartScriptPath is the path to a script that will be created by
-			envbuilder based on the ` + "`postStartCommand`" + ` in devcontainer.json, if any
-			is specified (otherwise the script is not created). If this is set, the
-			specified InitCommand should check for the presence of this script and
-			execute it after successful startup.`,
+			Description: "PostStartScriptPath is the path to a script that will be created " +
+				"by envbuilder based on the postStartCommand in devcontainer.json, " +
+				"if any is specified (otherwise the script is not created). If this " +
+				"is set, the specified InitCommand should check for the presence of " +
+				"this script and execute it after successful startup.",
 		},
 	}
 }