feat: propagate doc comments on flags and arguments to `--help/-h` + structs derive refactor #26

dj8yfo · 2024-12-12T22:36:54Z

the crux of the pr is 0c3ce3a
and 912744d

the rest is some refactoring and splitting big chunks of code into smaller and nested modules/functions

the changes to the logic of derives aren't many and are well summarised by
the following list of commits with snapshot differences
from the same tests as added to master branch in
https://github.com/dj8yfo/interactive-clap/commits/backporting_tests_into_master/ branch:

test_simple_struct => eb4b124 (fragments reorder)
test_simple_struct_with_named_arg => ddb3891 (fragments reorder)
test_doc_comments_propagate => 6461299 (doc comments propagated, clap(verbatim_doc_comment) propagated, fragments reordered)
test_simple_enum => no change
test_simple_enum_with_strum_discriminants => no change
also a bug was found when integrating new functionality:
- new test
- snapshot change in InteractiveClap derive, test passing
- input change for 2nd stage derive of ToCliArgs resulted in test failing

second (or 3rd) sub-summary mentions 2 commits 382cc33, 3db17e1 which made
a testing step automatic and not requiring to manually copy-paste a fragment
from snapshot generated with first test assertion.
No snapshots changed as result of these latter 2 commits.

dj8yfo · 2024-12-12T22:50:54Z

introspect feature can be used to debug how derive proc macros work similar to the following:

# interactive-clap-derive folder
cargo test test_doc_comments_propagate --features introspect -- --nocapture 
# from repo root
cargo run --example struct_with_subargs --features interactive-clap-derive/introspect

…nd `long_help` Add this functionality in commented form

dj8yfo · 2025-01-06T20:09:29Z

this is still draft, pending some small work on top of it

…ntributor)

…nt_of_to_cli_trait module

… to derives::interactive_clap::structs::cli_variant_of_to_cli_trait::field

…ant_of_to_cli_trait`

…riminants from `master`

…n tests

dj8yfo · 2025-02-06T23:05:01Z

@race-of-sloths include

race-of-sloths · 2025-02-06T23:05:35Z

@dj8yfo Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
Do you want to apply for monthly streak? Get 8+ score for a single PR this month and receive boost for race-of-sloths!

Current status: executed

Reviewer	Score
@akorchyn	13

Your contribution is much appreciated with a final score of 13!
You have received 288 (130 base + 120 monthly bonus + 15% lifetime bonus) Sloth points for this contribution

@akorchyn received 25 Sloth Points for reviewing and scoring this pull request.

Congratulations @dj8yfo! Your PR was highly scored and you completed another monthly streak! To keep your monthly streak make another pull request next month and get 8+ score for it

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

Tag @race-of-sloths inside your pull requests
Wait for the maintainer to review and score your pull request
Check out your position in the Leaderboard
Keep weekly and monthly streaks to reach higher positions
Boast your contributions with a dynamic picture of your Profile

For maintainers:

Score pull requests that participate in the Race of Sloths and receive a reward
Engage contributors with fair scoring and fast responses so they keep their streaks
Promote the Race to the point where the Race starts promoting you
Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands

For contributors
- Include a PR: @race-of-sloths include to enter the Race with your PR
For maintainers:
- Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
- Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
- Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
- Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

akorchyn

I'll return back to it a bit later. Hard to keep up :)

interactive-clap-derive/src/debug.rs

interactive-clap-derive/src/derives/interactive_clap/common_methods/choose_variant.rs

interactive-clap-derive/src/derives/interactive_clap/mod.rs

interactive-clap-derive/docs/clap_enum_for_named_arg_docstring.md

interactive-clap-derive/src/derives/interactive_clap/structs/clap_for_named_arg_enum.rs

...ap-derive/src/derives/interactive_clap/structs/to_cli_trait/clap_parser_trait_adapter/mod.rs

akorchyn · 2025-02-07T14:02:56Z

Can you create a patch for near-cli-rs and check that it's starting speed is sufficient and not struggle as Vlad described on a call?

dj8yfo · 2025-02-07T14:34:46Z

@akorchyn patch was created near/near-cli-rs#444 , the starting lag is (visually) the same as in main

src/lib.rs

examples/struct_with_subargs.rs

...rc/tests/snapshots/interactive_clap_derive__tests__test_simple_struct__vec_multiple_opt.snap

Co-authored-by: Artur Yurii Korchynskyi <42449190+akorchyn@users.noreply.github.com>

(2) near-cli-rs#26 (comment) (3) near-cli-rs#26 (comment)

akorchyn

Small nit. Feel free to ignore.

I think, we should avoid to make refactoring and feature addition in the same PR, but I also tend to do the same.

@race-of-sloths score 13

akorchyn · 2025-02-11T10:16:30Z

interactive-clap-derive/src/derives/interactive_clap/common_methods/choose_variant.rs

@@ -19,7 +20,8 @@ pub fn fn_choose_variant(
    let mut ast_attrs: Vec<&str> = std::vec::Vec::new();

    if !ast.attrs.is_empty() {
-        for attr in ast.attrs.clone() {
+        for (_index, attr) in ast.attrs.clone().into_iter().enumerate() {


can be used already as index, but doesn't matter (without _)

## 🤖 New release * `interactive-clap-derive`: 0.3.1 -> 0.3.2 * `interactive-clap`: 0.3.1 -> 0.3.2 (✓ API compatible changes) <details><summary>Changelog</summary> ## `interactive-clap-derive` <blockquote> ## [0.3.2](interactive-clap-derive-v0.3.1...interactive-clap-derive-v0.3.2) - 2025-02-11 ### Added - propagate doc comments on flags and arguments to `--help/-h` + structs derive refactor (#26) ### Other - Added code style check (#29) </blockquote> ## `interactive-clap` <blockquote> ## [0.3.2](interactive-clap-v0.3.1...interactive-clap-v0.3.2) - 2025-02-11 ### Added - propagate doc comments on flags and arguments to `--help/-h` + structs derive refactor (#26) ### Other - Added "cargo test" command (#33) - Added clippy to examples (#31) - Added code style check (#29) - add CODEOWNERS (#27) - Added a demo image to README (#24) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

this resolves ![2025-02-05_21-15](https://github.com/user-attachments/assets/1c150f4e-9e27-4fa4-8da4-1eb128cb606f) from within the tool itself depends on near-cli-rs/interactive-clap#26, so that would have to be merged+released first --------- Co-authored-by: dj8yf0μl <noreply@nowhere.org>

dj8yfo marked this pull request as ready for review December 13, 2024 18:17

frol requested a review from FroVolod December 22, 2024 19:29

dj8yf0μl added 5 commits January 6, 2025 22:05

commented: add propagate doc attributes for clap's derive of help a…

251dfce

…nd `long_help` Add this functionality in commented form

test: add test_doc_comments_propagate

ae76568

uncomment: propagating doc comments attributes

0c3ce3a

chore: add dbg_cond! macro

e02529d

chore: add passthrough of verbatim_doc_comment attribute to clap

912744d

dj8yfo marked this pull request as draft January 6, 2025 20:07

merge: master into this

1d16e9b

dj8yfo force-pushed the propagate_doc_comments_on_flags branch from a6406da to 1d16e9b Compare January 6, 2025 20:30

dj8yf0μl added 11 commits January 6, 2025 22:41

ci: fix clippy

451e7e3

Merge branch 'master' into propagate_doc_comments_on_flags

d1d8e06

Merge branch 'master' into propagate_doc_comments_on_flags

7ef647b

test: add 2 simple tests for enums

19c9d77

test: add strum_discriminants(strum attributes to enum test

15bc985

test: add doc comment over enum for test with strum-messages

9de4082

doc: check nice publish with private items

e28aee7

doc: add doc-string about dbg_cond! macro

b831cbc

ci: resolve near-cli-rs#34

1344f02

chore: add rust-toolchain.toml (autoinstalls rust-analyzer for any co…

222ee83

…ntributor)

chore: extract logic to derives::interactive_clap::structs::cli_varia…

709e4bc

…nt_of_to_cli_trait module

dj8yfo mentioned this pull request Jan 9, 2025

ci: add cargo doc job #34

Closed

dj8yf0μl added 5 commits January 9, 2025 16:35

chore: move derives::interactive_clap::methods::cli_field_type module…

13e6f2a

… to derives::interactive_clap::structs::cli_variant_of_to_cli_trait::field

chore: change field_type return type from TokenStream -> syn::Type

63dea02

chore: group together derive items, that belong to `structs::cli_vari…

18ae13e

…ant_of_to_cli_trait`

chore: move impl From<#name> for #cli_name derive into submodule

99d1c65

chore: move impl #name (clap::Parser adapter block) into submodule

4d84f7c

dj8yfo force-pushed the propagate_doc_comments_on_flags branch from 2008066 to f1ad05f Compare January 24, 2025 18:09

dj8yf0μl added 4 commits February 5, 2025 01:16

test: forwardport test+snapshots for test_simple_enum_with_strum_disc…

d87ee59

…riminants from `master`

test: unify 2-step variables names in derive tests

985a465

chore: extract cli_variant_struct derive module for reusability in tests

382cc33

test: add to_cli_args_structs_test_bridge module for automatic step i…

3db17e1

…n tests

dj8yfo mentioned this pull request Feb 5, 2025

feat: embed docs for flags/arguments for -h/--help near/cargo-near#304

Merged

dj8yfo marked this pull request as ready for review February 6, 2025 23:02

dj8yfo requested review from akorchyn and PolyProgrammist as code owners February 6, 2025 23:02

akorchyn requested changes Feb 7, 2025

View reviewed changes

akorchyn reviewed Feb 7, 2025

View reviewed changes

src/lib.rs Outdated Show resolved Hide resolved

examples/struct_with_subargs.rs Show resolved Hide resolved

...rc/tests/snapshots/interactive_clap_derive__tests__test_simple_struct__vec_multiple_opt.snap Show resolved Hide resolved

suggestion ui: Update src/lib.rs

f85e437

Co-authored-by: Artur Yurii Korchynskyi <42449190+akorchyn@users.noreply.github.com>

dj8yfo marked this pull request as draft February 10, 2025 15:33

dj8yf0μl added 5 commits February 10, 2025 19:18

review: addresses near-cli-rs#26 (comment)

87848e4

review: silence a clippy lint too near-cli-rs#26 (comment)

bc0a363

review: resolves (1) near-cli-rs#26 (comment)

aad7bda

(2) near-cli-rs#26 (comment) (3) near-cli-rs#26 (comment)

review: addresses near-cli-rs#26 (comment)

9bedd97

review: addresses near-cli-rs#26 (comment)

804e120

dj8yfo pushed a commit to dj8yfo/interactive-clap that referenced this pull request Feb 10, 2025

review: addresses near-cli-rs#26 (comment)

793bc83

review: addresses near-cli-rs#26 (comment)

c9cce06

dj8yfo force-pushed the propagate_doc_comments_on_flags branch from 793bc83 to c9cce06 Compare February 10, 2025 21:39

dj8yfo marked this pull request as ready for review February 10, 2025 21:50

akorchyn approved these changes Feb 11, 2025

View reviewed changes

dj8yfo merged commit 962ddb9 into near-cli-rs:master Feb 11, 2025
3 checks passed

frol mentioned this pull request Jan 7, 2025

chore: release v0.3.2 #25

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: propagate doc comments on flags and arguments to `--help/-h` + structs derive refactor #26

feat: propagate doc comments on flags and arguments to `--help/-h` + structs derive refactor #26

dj8yfo commented Dec 12, 2024 •

edited

Loading

dj8yfo commented Dec 12, 2024

dj8yfo commented Jan 6, 2025

dj8yfo commented Feb 6, 2025

race-of-sloths commented Feb 6, 2025 •

edited

Loading

akorchyn left a comment

akorchyn commented Feb 7, 2025 •

edited

Loading

dj8yfo commented Feb 7, 2025

akorchyn left a comment

akorchyn Feb 11, 2025 •

edited

Loading

feat: propagate doc comments on flags and arguments to --help/-h + structs derive refactor #26

feat: propagate doc comments on flags and arguments to --help/-h + structs derive refactor #26

Conversation

dj8yfo commented Dec 12, 2024 • edited Loading

dj8yfo commented Dec 12, 2024

dj8yfo commented Jan 6, 2025

dj8yfo commented Feb 6, 2025

race-of-sloths commented Feb 6, 2025 • edited Loading

akorchyn left a comment

Choose a reason for hiding this comment

akorchyn commented Feb 7, 2025 • edited Loading

dj8yfo commented Feb 7, 2025

akorchyn left a comment

Choose a reason for hiding this comment

akorchyn Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

feat: propagate doc comments on flags and arguments to `--help/-h` + structs derive refactor #26

feat: propagate doc comments on flags and arguments to `--help/-h` + structs derive refactor #26

dj8yfo commented Dec 12, 2024 •

edited

Loading

race-of-sloths commented Feb 6, 2025 •

edited

Loading

akorchyn commented Feb 7, 2025 •

edited

Loading

akorchyn Feb 11, 2025 •

edited

Loading