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

[Major] UI Enhancements #1321

Merged
merged 19 commits into from
Apr 14, 2022
Merged

[Major] UI Enhancements #1321

merged 19 commits into from
Apr 14, 2022

Conversation

isidentical
Copy link
Contributor

@isidentical isidentical commented Mar 11, 2022 •
edited
Loading

This PR consists from multiple individual parts that aim to improve the UI of HTTPie.

Tasks:

  • Test system refactor (to use text-based streams)
  • Rich integration (to our context.Environment)
  • --help improvements (with shorter help messages)
  • Addition of --manual for displaying full manual
  • Man page generation
  • Packaging man pages (seems a bit tricky, since pip does not officialy support it. Deferring)
  • Rich progress bars for downloads

@codecov-commenter
Copy link

codecov-commenter commented Mar 11, 2022 •
edited
Loading

Codecov Report

Merging #1321 (14432c0) into master (4d7d6b6) will decrease coverage by 1.50%.
The diff coverage is 94.38%.

@@            Coverage Diff             @@
##           master    #1321      +/-   ##
==========================================
- Coverage   97.28%   95.77%   -1.51%     
==========================================
  Files          67      101      +34     
  Lines        4235     7108    +2873     
==========================================
+ Hits         4120     6808    +2688     
- Misses        115      300     +185
Impacted Files Coverage Δ
httpie/output/ui/man_pages.py 0.00% <0.00%> (ø)
httpie/output/ui/rich_utils.py 0.00% <0.00%> (ø)
tests/test_binary.py 100.00% <ø> (ø)
httpie/compat.py 31.11% <27.90%> (-68.89%) ⬇️
tests/conftest.py 77.14% <61.53%> (-9.82%) ⬇️
httpie/output/ui/rich_progress.py 75.80% <75.80%> (ø)
httpie/manager/__main__.py 82.35% <82.35%> (ø)
httpie/output/lexers/metadata.py 82.35% <82.35%> (ø)
httpie/cli/argparser.py 92.81% <84.88%> (-3.55%) ⬇️
httpie/output/lexers/http.py 86.36% <86.36%> (ø)
... and 86 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d03e3f4...14432c0. Read the comment docs.

@isidentical isidentical marked this pull request as ready for review March 16, 2022 10:01
jkbrzt
jkbrzt requested changes Apr 3, 2022
View reviewed changes
Copy link
Member

@jkbrzt jkbrzt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Failing tests/conflicts

@isidentical
Refactor tests to use a text-based standard output. (#1318)
6b97a71
@isidentical
Implement new style --help (#1316)
42ea888
@isidentical
Implement man page generation (#1317)
a978ac8
@isidentical
Implement rich progress bars. (#1324)
e5e2914
@isidentical
Man page deployment & isolation. (#1325)
884e86e 
* Remove all unsorted usages in the CLI docs

* Implement isolated mode for man page generation

* Add a CI job for autogenerated files

* Distribute man pages through PyPI
@isidentical
Pin the date for man pages. (#1326)
81dc647
@isidentical
Hide suppressed arguments from --help/man pages (#1329)
2769320
@isidentical
Change download spinner to line (#1328)
dde5222
@isidentical
Regenerate autogenerated files when pushed against to master. (#1339)
b45392f
@isidentical
Highlight options (#1340)
ed21c43
@isidentical
Additional man page enhancements (#1341)
c0c3e00 
* Group options by the parent category & highlight -o/--o

* Display (and underline) the METAVAR on man pages.
@isidentical
Make help message processing more robust (#1342)
8147bbe 
* Inherit `help` from `short_help`

* Don't mirror short_help directly.

* Fixup the serialization
@isidentical
Use pager and man on --manual when applicable (#1343)
ade5055 
* Run `man $program` on --manual

* Page the output of `--manual` for systems that lack man pages
@isidentical isidentical requested a review from jkbrzt April 4, 2022 15:53
@isidentical
Generate CLI spec from HTTPie & Man Page Hook (#1354)
14432c0 
* Generate CLI spec from HTTPie & add man page hook

* Use the full command space for the option headers
@jkbrzt jkbrzt merged commit ff6f188 into master Apr 14, 2022
@jkbrzt jkbrzt deleted the feature/ui-enhancements branch April 14, 2022 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkbrzt jkbrzt Awaiting requested review from jkbrzt

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@isidentical @codecov-commenter @jkbrzt