8000 Tabular Outputs - Expand support for "all columns" (and other shortcuts) by totten · Pull Request #213 · civicrm/cv · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Tabular Outputs - Expand support for "all columns" (and other shortcuts) #213

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
Merged
merged 12 commits into from
Sep 11, 2024
Merged

Tabular Outputs - Expand support for "all columns" (and other shortcuts) #213

merged 12 commits into from
Sep 11, 2024

Conversation

totten
Copy link
Member
@totten totten commented Sep 11, 2024

Synopsis

Many subcommands produce some kind of tabular data-set for output. The default tables are designed to be generally useful. But for more advanced cases, the output can be customized to use particular columns and output-formats.

This branches provides more options to help with those advanced. In particular, the option -a (--all-columns) can help inspect output. Additionally, it reduces some duplicate code to further standardize behavior of more commands.

## Print summary of extensions; then all details; then custom listings
cv ext:list
cv ext:list -a | less
cv ext:list --out=csv --columns=key,version
cv ext:list -R -I --columns=downloadUrl | grep githu

## Print summary of settings; then all details; then custom listings
cv vget
cv vget -a | less
cv vget --out=csv --columns=key,value,meta.default

(Note that -a is a bit different from -v. "Verbose" output enables more logging throughout the execution of the job. "All Columns" enables a full view of the final result-set.)

Technical Details

This includes some work on extractions, refactorings, helpers. The big one is sendStandardTable(). This is like sendTable() used here-to-fore, but it enforces some standardized behaviors for column-selection and sorting.

totten added 12 commits September 11, 2024 02:37
@totten
(REF) ArrayUtil - Extract resolveColumns(), sortColumns()
b3c887c
@totten
ArrayUtil - Add more map helpers
211eaec
@totten
StructuredOutputTrait - Define option --all-columns. Reorganize list …
a482e68 
…of shortcuts.
@totten
ang:html:list - Enable all shortcuts
df720c1
@totten
ext:list - Enable all shortcuts
21062e7
@totten
ang:module:list - Enable all shortcuts
adabf8e
@totten
api, api4 - Enable the -J alias
23d446d 
This is a little redundant because json-pretty is the default anyway.
However, if we support -J in other commands, then it may be confusing if
api/api4 don't accept it.
@totten
check-req - Enable all shortcuts
952e34e
@totten
StructuredOutputTrait - Add helper sendStandardTable
f9e8837
@totten
service (list) - Enable sorting and output shortcuts
0a1575b
@totten
(REF) Switch various commands to use sendStandardTable
9d21af0
@totten
setting:* - Use sendStandardTable() with all shortcuts
16ac4fc
@totten totten merged commit a5e6a41 into civicrm:master Sep 11, 2024
1 check passed
@totten totten deleted the master-shortcuts branch September 11, 2024 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@totten
0