Skip to content

fix: improve handling of cli boolean params #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mnahkies merged 1 commit into from
May 25, 2024
Merged

fix: improve handling of cli boolean params #205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions packages/openapi-code-generator/src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,37 @@

import "source-map-support/register"

import {Command, Option} from "@commander-js/extra-typings"
import {
Command,
InvalidArgumentError,
Option,
} from "@commander-js/extra-typings"
import {NodeFsAdaptor} from "./core/file-system/node-fs-adaptor"
import {OperationGroupStrategy} from "./core/input"
import {logger} from "./core/logger"
import {generate} from "./index"
import {templates} from "./templates"
import {TypescriptFormatter} from "./typescript/common/typescript-formatter"

const boolParser = (arg: string): boolean => {
const TRUTHY_VALUES = ["true", "1", "on"]
const FALSY_VALUES = ["false", "0", "off", ""]

if (TRUTHY_VALUES.includes(arg.toLowerCase())) {
return true
} else if (FALSY_VALUES.includes(arg.toLowerCase())) {
return false
}

throw new InvalidArgumentError(
`'${arg}' is not a valid boolean parameter. Valid truthy values are: ${TRUTHY_VALUES.map(
(it) => JSON.stringify(it),
).join(", ")}; falsy values are: ${FALSY_VALUES.map((it) =>
JSON.stringify(it),
).join(", ")}`,
)
}

const program = new Command()
.addOption(
new Option("-i --input <value>", "input file to generate from")
Expand Down Expand Up @@ -54,34 +77,38 @@ const program = new Command()
)
.addOption(
new Option(
"--ts-allow-any",
"--ts-allow-any [bool]",
"(typescript) whether to use `any` or `unknown` for unspecified types",
)
.env("OPENAPI_TS_ALLOW_ANY")
.argParser(boolParser)
.default(false),
)
.addOption(
new Option(
"--enable-runtime-response-validation",
"--enable-runtime-response-validation [bool]",
"(experimental) whether to validate response bodies using the chosen runtime schema library",
)
.env("OPENAPI_ENABLE_RUNTIME_RESPONSE_VALIDATION")
.argParser(boolParser)
.default(false),
)
.addOption(
new Option(
"--extract-inline-schemas",
"--extract-inline-schemas [bool]",
"(experimental) Generate names and extract types/schemas for inline schemas",
)
.env("OPENAPI_EXTRACT_INLINE_SCHEMAS")
.argParser(boolParser)
.default(false),
)
.addOption(
new Option(
"--allow-unused-imports",
"--allow-unused-imports [bool]",
"Keep unused imports. Especially useful if there is a bug in the unused-import elimination.",
)
.env("OPENAPI_ALLOW_UNUSED_IMPORTS")
.argParser(boolParser)
.default(false),
)
.addOption(
Expand Down