Skip to content

W-16448626 write help for new "data search" command#1026

Merged
WillieRuemmele merged 3 commits intowr/soslfrom
js/help-messages
Aug 9, 2024
Merged

W-16448626 write help for new "data search" command#1026
WillieRuemmele merged 3 commits intowr/soslfrom
js/help-messages

Conversation

@jshackell-sfdc
Copy link
Copy Markdown
Contributor

What does this PR do?

Embellishes the skeleton --help for the new "data search" command.

What issues does this PR fix or reference?

@W-16448626@

@jshackell-sfdc jshackell-sfdc requested a review from a team as a code owner August 8, 2024 23:18
@jshackell-sfdc
Copy link
Copy Markdown
Contributor Author

@WillieRuemmele , note that the --result-format csv flag writes the results to a file, its name based on the object that's being queried. This behavior differs from data query --result-format csv which just displays the results to the terminal, but in comma-separated value format.

I assume that you'll change the behavior of data search to match the behavior of data query. If, however, you don't, please let me know so I can change the example and the help for the flag! Cheers.

@WillieRuemmele WillieRuemmele merged commit 100d4a9 into wr/sosl Aug 9, 2024
@WillieRuemmele WillieRuemmele deleted the js/help-messages branch August 9, 2024 20:27
WillieRuemmele added a commit that referenced this pull request Aug 13, 2024
* feat: add data search command

* chore: multiple object result

* chore: consolidate reporter classes

* test: add NUTs

* chore: gen snapshot

* refactor: move formatters to dirs, add UTs

* docs: provide way to override result-format summary

* write help for new "data search" command (#1026)

* fix: write the help for new command

* fix: add info about --result-format behavior

* chore: review reqs

* fix: write the help for new command

* fix: add info about --result-format behavior

* refactor: type-fix-for-result-format (#1033)

* refactor: use oclif custom flag

* refactor: exclusive json

* style: remove the word "results" from table heads

* test: no "Results" in test assertions

* test: fix NUT assertion

* chore: fix NUT

---------

Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com>
Co-authored-by: Juliet Shackell <juliet.shackell@salesforce.com>
Co-authored-by: mshanemc <shane.mclaughlin@salesforce.com>
@iowillhoit iowillhoit changed the title write help for new "data search" command W-16448626 write help for new "data search" command Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants