Skip to content
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

Jump to bottom

Improve completion script #351

Open
rsenden opened this issue Jul 19, 2023 · 1 comment
Open

Improve completion script #351

rsenden opened this issue Jul 19, 2023 · 1 comment
Labels
consistency Issues related to code not being consistent or following conventions effort:low Easy to implement/fix enhancement New feature or request prio:medium Medium priority
Milestone
2.x

Comments

@rsenden
Copy link
Contributor

rsenden commented Jul 19, 2023 •
edited
Loading

Related to #336, fcli should provide proper completion candidates where applicable. The new CompletionCandidatesTest currently outputs the following options/parameters that may need to be improved to provide proper completion candidates:

INFO: AbstractFortifyCLICommand.GenericOptionsArgGroup::logFile: Should change to File or Path
INFO: OutputOptionsArgGroup::outputFile: Should change to File or Path
INFO: LanguageSetCommand::language: Can we generate list of supported languages?
INFO: AbstractProxyOptions.ProxyTargetHostsArgGroup::includedHosts: Does it make sense to use InetAddress?
INFO: AbstractProxyOptions.ProxyTargetHostsArgGroup::excludedHosts: Does it make sense to use InetAddress?
INFO: AbstractProxyOptions::modules: Can we predefine/have modules enum?
INFO: TrustStoreSetCommand::trustStoreType: Can we predefine/have trustStoreType enum?
INFO: TrustStoreSetCommand::trustStorePath: Should change to File or Path
INFO: FoDAppCreateAppCommand::notifications: Option has no completion candidates
INFO: FoDSastScanSetupCommand::technologyStack: Option has no completion candidates
INFO: FoDSastScanSetupCommand::languageLevel: Option has no completion candidates
INFO: FoDMobileScanStartCommand::timezone: Option has no completion candidates
INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::whileAll: Ideally, each wait-for command should provide appropriate completion candidates
INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::whileAny: Ideally, each wait-for command should provide appropriate completion candidates
INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::untilAll: Ideally, each wait-for command should provide appropriate completion candidates
INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::untilAny: Ideally, each wait-for command should provide appropriate completion candidates
INFO: AbstractRestCallCommand::httpMethod: Can we generate completion candidates/change to enum?
INFO: CommonOptionMixins.OptionalDestinationFile::destination: Should change to File or Path
INFO: SSCArtifactDownloadOptions::destination: Should change to File or Path
INFO: SSCIssueTemplateDownloadCommand::destination: Should change to File or Path
INFO: SSCJobUpdateCommand::priority: Can we provide completion candidates, like specific range of numbers?
INFO: SSCReportTemplateCreateCommand::templatePath: Should change to File or Path
INFO: SSCReportTemplateCreateCommand::answerFile: Should change to File or Path
INFO: SSCReportTemplateDownloadCommand::destination: Should change to File or Path
INFO: SSCSeedBundleUploadCommand::seedBundle: Should change to File or Path
INFO: SSCTokenCreateCommand::type: We can potentially provide list of commonly used token types
INFO: SSCVulnerabilityCountCommand::groupingType: Can we provide list of commonly used grouping types?
INFO: AbstractToolInstallCommand::installDir: Should change to File or Path
INFO: AbstractToolInstallCommand::version: Can we generate completion candidates from tool config file?
INFO: AbstractToolUninstallCommand::version: Can we generate completion candidates from tool config file?
@rsenden rsenden mentioned this issue Jul 19, 2023
Closed
rsenden added a commit that referenced this issue Jul 19, 2023
@rsenden
chore: Improve handling of file/dir options/parameters (fixes #345, p…
b5559d3 
…artial fix for #336 & #351)

fix: Enable auto-completion on all options/parameters taking a file/directory (partial fix for #336 & #351)

fix: Improve handling of destination directories contain .. for tool * install commands (fixes #345)
@rsenden rsenden modified the milestones: backlog, 2.x Jul 25, 2023
@rsenden rsenden added enhancement New feature or request consistency Issues related to code not being consistent or following conventions labels Jul 25, 2023
@rsenden
Copy link
Contributor Author

rsenden commented Jul 25, 2023

Fixed most/all options/parameters taking paths. Currently remaining:

    INFO: LanguageSetCommand::language: Can we generate list of supported languages?
    INFO: AbstractProxyOptions.ProxyTargetHostsArgGroup::includedHosts: Does it make sense to use InetAddress?
    INFO: AbstractProxyOptions.ProxyTargetHostsArgGroup::excludedHosts: Does it make sense to use InetAddress?
    INFO: AbstractProxyOptions::modules: Can we predefine/have modules enum?
    INFO: TrustStoreSetCommand::trustStoreType: Can we predefine/have trustStoreType enum?
    INFO: FoDAppCreateAppCommand::notifications: Option has no completion candidates
    INFO: FoDSastScanSetupCommand::technologyStack: Option has no completion candidates
    INFO: FoDSastScanSetupCommand::languageLevel: Option has no completion candidates
    INFO: FoDMobileScanStartCommand::timezone: Option has no completion candidates
    INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::whileAll: Ideally, each wait-for command should provide appropriate completion candidates
    INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::whileAny: Ideally, each wait-for command should provide appropriate completion candidates
    INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::untilAll: Ideally, each wait-for command should provide appropriate completion candidates
    INFO: WaitHelperWaitOptions.WaitHelperWaitOptionsArgGroup::untilAny: Ideally, each wait-for command should provide appropriate completion candidates
    INFO: AbstractRestCallCommand::httpMethod: Can we generate completion candidates/change to enum?
    INFO: AbstractRestCallCommand.TransformArgGroup::transformExpression: Option has no completion candidates
    INFO: SSCJobUpdateCommand::priority: Can we provide completion candidates, like specific range of numbers?
    INFO: SSCTokenCreateCommand::type: We can potentially provide list of commonly used token types
    INFO: SSCVulnerabilityCountCommand::groupingType: Can we provide list of commonly used grouping types?
    INFO: AbstractToolInstallCommand::version: Can we generate completion candidates from tool config file?
    INFO: AbstractToolUninstallCommand::version: Can we generate completion candidates from tool config file?

@github-actions github-actions bot mentioned this issue Aug 18, 2023
Closed
@rsenden rsenden added prio:medium Medium priority effort:low Easy to implement/fix labels May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
consistency Issues related to code not being consistent or following conventions effort:low Easy to implement/fix enhancement New feature or request prio:medium Medium priority
Projects
None yet
Milestone
2.x
Development

No branches or pull requests
1 participant
@rsenden