Merge pull request #2427 from cdr/link-docs-0cc3

cli: Show beta flags in help output
This commit is contained in:
Anmol Sethi 2020-12-14 05:19:50 -05:00 committed by GitHub
commit 88b8cff8e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 31 deletions

View File

@ -33,10 +33,10 @@ When done, the install script prints out instructions for running and starting c
We also have an in-depth [setup and configuration](./doc/guide.md) guide.
### Alpha Program 🐣
### Cloud Program ☁️
We're working on a cloud platform that makes deploying and managing code-server easier.
Consider updating to the latest version and running code-server with our experimental flag `--link` if you don't want to worry about
Consider running code-server with the beta flag `--link` if you don't want to worry about
- TLS
- Authentication

View File

@ -74,7 +74,7 @@ interface Option<T> {
description?: string
/**
* If marked as beta, the option is not printed unless $CS_BETA is set.
* If marked as beta, the option is marked as beta in help.
*/
beta?: boolean
}
@ -193,8 +193,6 @@ const options: Options<Required<Args>> = {
Securely bind code-server via Coder Cloud with the passed name. You'll get a URL like
https://myname.coder-cloud.com at which you can easily access your code-server instance.
Authorization is done via GitHub.
This is presently beta and requires being accepted for testing.
See https://github.com/cdr/code-server/discussions/2137
`,
beta: true,
},
@ -209,32 +207,24 @@ export const optionDescriptions = (): string[] => {
}),
{ short: 0, long: 0 },
)
return entries
.filter(([, v]) => {
// If CS_BETA is set, we show beta options but if not, then we do not want
// to show beta options.
return process.env.CS_BETA || !v.beta
})
.map(([k, v]) => {
const help = `${" ".repeat(widths.short - (v.short ? v.short.length : 0))}${
v.short ? `-${v.short}` : " "
} --${k} `
return (
help +
v.description
?.trim()
.split(/\n/)
.map((line, i) => {
line = line.trim()
if (i === 0) {
return " ".repeat(widths.long - k.length) + line
}
return " ".repeat(widths.long + widths.short + 6) + line
})
.join("\n") +
(typeof v.type === "object" ? ` [${Object.values(v.type).join(", ")}]` : "")
)
})
return entries.map(([k, v]) => {
const help = `${" ".repeat(widths.short - (v.short ? v.short.length : 0))}${v.short ? `-${v.short}` : " "} --${k} `
return (
help +
v.description
?.trim()
.split(/\n/)
.map((line, i) => {
line = line.trim()
if (i === 0) {
return " ".repeat(widths.long - k.length) + (v.beta ? "(beta) " : "") + line
}
return " ".repeat(widths.long + widths.short + 6) + line
})
.join("\n") +
(typeof v.type === "object" ? ` [${Object.values(v.type).join(", ")}]` : "")
)
})
}
export const parse = (