-
Notifications
You must be signed in to change notification settings - Fork 884
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.
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
Add cURL's boolean options #270
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
// This script generates a list of all of cURL's options | ||
// by parsing `curl --help` | ||
|
||
const { execSync } = require('child_process') | ||
|
||
const stdin = execSync('curl --help').toString() | ||
|
||
// https://github.com/curl/curl/pull/7378 | ||
const actuallyNotBooleanOpts = ['tlspassword', 'stderr', 'request-target', 'quote'] | ||
|
||
const booleanOpts = [] | ||
// Use Map to maintain the same order as `curl --help` to reduce churn in diffs | ||
// TODO: format Map as object instead of having to do it by hand | ||
const aliases = new Map() | ||
for (const line of stdin.split('\n')) { | ||
if (line.startsWith('Usage: ') || !line) { | ||
continue | ||
} | ||
const match = line.match(/^( -(?<short>.),)? +--(?<long>\S+) /) | ||
if (!match) { | ||
console.error('failed to match line:', line) | ||
continue | ||
} | ||
const short = match.groups.short | ||
let long = match.groups.long | ||
|
||
// All of cURL's short options have a long form | ||
if (short && !long) { | ||
console.error('short option doesn\'t have long option', line) | ||
} | ||
|
||
// If line looks something like | ||
// --user-agent <name> | ||
// or | ||
// --proxy [protocol://]host[:port] | ||
// it's not a boolean option. | ||
const isBooleanOpt = !(line.match(/^( -(?<short>.),)? +--(?<long>\S+) +[[<]/)) && !actuallyNotBooleanOpts.includes(long) | ||
// Should be checked by hand | ||
// console.error((isBooleanOpt + '').padEnd(5), line) | ||
|
||
if (long.startsWith('no-')) { | ||
if (!isBooleanOpt) { | ||
console.error('non-boolean option starts with negation prefix "no-"', line) | ||
} | ||
// Yargs' 'boolean-negation' (enabled by default) takes care of these. | ||
// | ||
// There's a -N short option which is short for --no-buffer, but because we remove the | ||
// "no-" here, -N is incorrectly aliased to --buffer instead. | ||
// This is okay because we don't do anything with --buffer's value, we just need yargs to | ||
// parse it as a boolean option. | ||
// https://github.com/yargs/yargs-parser/issues/406 | ||
long = long.slice(3) | ||
} | ||
|
||
if (short && long) { | ||
aliases.set(short, long) | ||
} | ||
if (isBooleanOpt) { | ||
booleanOpts.push(long) | ||
} | ||
} | ||
|
||
console.dir({ | ||
boolean: booleanOpts, | ||
alias: aliases, | ||
configuration: {} | ||
}, { maxArrayLength: null }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides have a different API that chains method calls instead of passing an object, I don't understand what yargs actually does for us over plain yargs-parser, so I removed it.