Feat: implement --verbose flag on `ion template inspect` cmd #21

diversable · 2023-02-18T02:46:58Z

I had a little extra time over the last couple of days, so I thought I'd finish this off.

I also included an update to the README / docs, just to flesh it out a bit until you have the time to fill out the Readme a little more with your own words.

diversable · 2023-02-18T18:49:37Z

This commit should fully resolve issue: #9 (comment)

…plate

modified grcov action by commenting out `actions-rs/install` - as the doc comment suggests

remove rust-flags which are causing compilation of Ion-derive to fail building

Roger-luo · 2023-02-19T03:31:13Z

thanks, I'm trying to add codecov to the CI so probably need to wait for me a bit on fixing the CI before merging this PR then we will have a code coverage report on the unit tests.

Roger-luo · 2023-02-20T00:43:26Z

The CI should be fixed now, could you merge main branch to your PR? Thanks

diversable · 2023-02-20T01:01:05Z

The CI should be fixed now, could you merge main branch to your PR? Thanks

Working on it now - just be a few minutes...

codecov · 2023-02-20T01:22:28Z

Codecov Report

Base: 55.24% // Head: 55.45% // Increases project coverage by +0.21% 🎉

Coverage data is based on head (1bedf44) compared to base (d7826f5).
Patch coverage: 93.47% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #21      +/-   ##
==========================================
+ Coverage   55.24%   55.45%   +0.21%     
==========================================
  Files          74       74              
  Lines        4502     4526      +24     
==========================================
+ Hits         2487     2510      +23     
- Misses       2015     2016       +1

Impacted Files	Coverage Δ
src/ion/blueprints/components/documenter.rs	`82.60% <ø> (ø)`
src/ion/blueprints/components/license.rs	`96.87% <ø> (ø)`
src/ion/blueprints/components/project_file.rs	`93.18% <ø> (ø)`
src/ion/blueprints/template.rs	`100.00% <ø> (ø)`
src/ion/blueprints/utils.rs	`60.18% <91.42%> (+2.67%)`	⬆️
ion_derive/src/template.rs	`100.00% <100.00%> (ø)`
src/bin/ion/commands/template.rs	`86.36% <100.00%> (+3.86%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

.github/workflows/grcov.yml

Roger-luo · 2023-02-20T01:47:37Z

README.md

@@ -15,12 +15,291 @@ Download tarball in the release page and extract it to your `$HOME/.julia` direc

 ### build from source


it'd be nice if this can be in a separate PR, I probably will put up the website soon, so we can decide whether to have this in a different PR

Roger-luo · 2023-02-20T01:49:19Z

src/ion/blueprints/template.rs

@@ -22,3 +24,80 @@ pub struct Template {
    pub coveralls: Option<Coveralls>,
    pub github: Option<GitHub>,
 }
+
+impl fmt::Display for Template {


this should be in derive macro for Template, so things can be kept extensible

Thanks for the help!

The latest commit should resolve these issues, I believe.

Roger-luo · 2023-02-20T04:40:51Z

ion_derive/src/template.rs

+                self.name, self.description
+            )?;
+
+            if let Some(repo) = &self.repo {


you need to generate the names instead of manually writing them, like how I generate other methods

this one might take a little while -- I have zero experience writing Rust macros (I know how to use them, just not how to write them).

But I'm reading up on it. The resources are a little thin, but I'll get it eventually...

Yeah, perhaps we should just do the debug printing, so that you don't need to implement this now

Roger-luo · 2023-02-20T04:41:50Z

actually, why don't we just use the debug print? It seems you are implementing something similar anyway?

diversable · 2023-02-20T18:56:11Z

If you prefer the debug print output, I can certainly do it that way. However, I did actually try the straight debug print option first, before the current implementation, and found that I didn't have enough context to understand what that debug output actually meant.

I realize that improvements to the display output could be made -- maybe printing out the info in tabular form would be better, or something like that? -- I just don't have enough experience with the templating sub-system right now to be able to design a better output.

That's one of the reasons I listed some issues on the templates repo: I think once I make 1 or 2 of my own templates, I think I'll have a better handle on what needs to be displayed to make the output truly informative for future users. Then I can come back around and redesign this output (or at least add color / additional structure).

Thoughts?

Would you prefer just to do the debug output right now? Or are there other recommendations you have for improving the intelligibility of the output?

Thx.

Roger-luo · 2023-02-21T01:55:34Z

Would you prefer just to do the debug output right now? Or are there other recommendations you have for improving the intelligibility of the output?

Yeah I think maybe let's just do the debug print for now since it's way more simpler and also verbose enough, especially it doesn't require us changing the procedure macro, we can think better printings in the future.

diversable · 2023-02-22T00:34:51Z

Would you prefer just to do the debug output right now? Or are there other recommendations you have for improving the intelligibility of the output?

Yeah I think maybe let's just do the debug print for now since it's way more simpler and also verbose enough, especially it doesn't require us changing the procedure macro, we can think better printings in the future.

So, I've changed to debug printing as requested, though I've left the basic code for re-implementing the Display trait on the Template and all its related sub-structs in place if we want to customize in the future.
Did you want me to get rid of that code as well, since its vestigial atm?

diversable · 2023-02-22T18:44:49Z

Would you prefer just to do the debug output right now? Or are there other recommendations you have for improving the intelligibility of the output?

Yeah I think maybe let's just do the debug print for now since it's way more simpler and also verbose enough, especially it doesn't require us changing the procedure macro, we can think better printings in the future.

So, I've changed to debug printing as requested, though I've left the basic code for re-implementing the Display trait on the Template and all its related sub-structs in place if we want to customize in the future. Did you want me to get rid of that code as well, since its vestigial atm?

The impl Display stubs have been removed.

Roger-luo · 2023-02-22T21:13:03Z

Yeah I think current one looks pretty good to me! Thanks!

diversable and others added 16 commits February 14, 2023 16:10

feat: add ion template inspect cmd

348dc92

bump patch release

d142870

fix: ion template inspect; add more tests

be88ce3

update tests

24ec3df

fix: inspect template implementation

b4f161c

reverse bump version

7ecda5a

Merge branch 'Roger-luo:main' into main

f6956df

test: update template tests

64280da

Merge branch 'Roger-luo:main' into main

a8802fb

Fix test: template

cf02c96

Merge branch 'Roger-luo:main' into main

31f29f2

feat: add --verbose flag to ion template inspect

8c83346

fix: refactor

dbedb17

Merge branch 'Roger-luo:main' into main

2f23481

fix: update tmpl inspect -v --all combination

a44b8a4

Merge branch 'main' into template

840f6b0

diversable and others added 9 commits February 18, 2023 10:59

fix: tests

70f7ca1

Fix: tests

4b8d890

Merge branch 'template' of https://github.com/diversable/Ion into tem…

3a18aa7

…plate

fix: clippy

b2771fc

fix: fmt

5ba05ca

Update grcov.yml

e43a945

update readme: add link to template repo

75ad65e

Update grcov.yml

73ce742

modified grcov action by commenting out `actions-rs/install` - as the doc comment suggests

Update grcov.yml

5a913ce

remove rust-flags which are causing compilation of Ion-derive to fail building

update

ec6474f

Merge branch 'main'

995583b

diversable and others added 3 commits February 19, 2023 17:10

Merge branch 'main' into template

0f1ca84

fix: tests

636e44e

fmt

f4e6be2

Merge branch 'main' into template

83e4181

Roger-luo requested changes Feb 20, 2023

View reviewed changes

ion requested updates

4226e38

Roger-luo reviewed Feb 20, 2023

View reviewed changes

diversable and others added 2 commits February 20, 2023 13:15

template macro minor update..

d82409d

Merge branch 'Roger-luo:main' into template

10ed0bb

diversable and others added 4 commits February 21, 2023 13:17

Merge branch 'Roger-luo:main' into template

64ec29a

request: update to debug printing

bad6c7d

rm comment

4494d14

remove dependence on impl Display

bbd6a1f

remove impl Display stubs

653c0f6

diversable added 2 commits February 22, 2023 10:45

finish removing display

17a8b98

cleanup

1bedf44

Roger-luo merged commit c6e0e1c into Roger-luo:main Feb 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: implement --verbose flag on `ion template inspect` cmd #21

Feat: implement --verbose flag on `ion template inspect` cmd #21

diversable commented Feb 18, 2023

diversable commented Feb 18, 2023

Roger-luo commented Feb 19, 2023

Roger-luo commented Feb 20, 2023

diversable commented Feb 20, 2023

codecov bot commented Feb 20, 2023 •

edited

Loading

Roger-luo Feb 20, 2023

Roger-luo Feb 20, 2023

diversable Feb 20, 2023

Roger-luo Feb 20, 2023

diversable Feb 20, 2023 •

edited

Loading

Roger-luo Feb 21, 2023

Roger-luo commented Feb 20, 2023

diversable commented Feb 20, 2023 •

edited

Loading

Roger-luo commented Feb 21, 2023

diversable commented Feb 22, 2023

diversable commented Feb 22, 2023

Roger-luo commented Feb 22, 2023

		@@ -15,12 +15,291 @@ Download tarball in the release page and extract it to your `$HOME/.julia` direc

		### build from source

Feat: implement --verbose flag on ion template inspect cmd #21

Feat: implement --verbose flag on ion template inspect cmd #21

Conversation

diversable commented Feb 18, 2023

diversable commented Feb 18, 2023

Roger-luo commented Feb 19, 2023

Roger-luo commented Feb 20, 2023

diversable commented Feb 20, 2023

codecov bot commented Feb 20, 2023 • edited Loading

Codecov Report

Roger-luo Feb 20, 2023

Choose a reason for hiding this comment

Roger-luo Feb 20, 2023

Choose a reason for hiding this comment

diversable Feb 20, 2023

Choose a reason for hiding this comment

Roger-luo Feb 20, 2023

Choose a reason for hiding this comment

diversable Feb 20, 2023 • edited Loading

Choose a reason for hiding this comment

Roger-luo Feb 21, 2023

Choose a reason for hiding this comment

Roger-luo commented Feb 20, 2023

diversable commented Feb 20, 2023 • edited Loading

Roger-luo commented Feb 21, 2023

diversable commented Feb 22, 2023

diversable commented Feb 22, 2023

Roger-luo commented Feb 22, 2023

Feat: implement --verbose flag on `ion template inspect` cmd #21

Feat: implement --verbose flag on `ion template inspect` cmd #21

codecov bot commented Feb 20, 2023 •

edited

Loading

diversable Feb 20, 2023 •

edited

Loading

diversable commented Feb 20, 2023 •

edited

Loading