Add generate templates command #1242

chasefleming · 2023-10-24T18:35:42Z

Closes #1233

For contributor use:

Targeted PR against master branch
Linked to Github issue with discussion and accepted design OR link to spec that describes this work
Code follows the standards mentioned here
Updated relevant documentation
Re-reviewed Files changed in the Github PR explorer
Added appropriate labels

gregsantos

@jribbink can check the go code

README.md

internal/super/generate.go

internal/super/generate_test.go

internal/super/generate.go

Co-authored-by: Greg Santos <[email protected]>

Co-authored-by: Jordan Ribbink <[email protected]>

Co-authored-by: Bjarte S. Karlsen <[email protected]>

Co-authored-by: Jordan Ribbink <[email protected]>

Co-authored-by: Bjarte S. Karlsen <[email protected]>

codecov-commenter · 2023-10-25T20:13:49Z

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (670fac7) 40.30% compared to head (2adf137) 41.19%.
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1242      +/-   ##
==========================================
+ Coverage   40.30%   41.19%   +0.89%     
==========================================
  Files          38       39       +1     
  Lines        2007     2068      +61     
==========================================
+ Hits          809      852      +43     
- Misses       1109     1123      +14     
- Partials       89       93       +4

Flag	Coverage Δ
unittests	`41.19% <70.49%> (+0.89%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
internal/super/generate.go	`70.49% <70.49%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jribbink

lgtm

internal/super/generate.go

internal/super/generate_test.go

Co-authored-by: Jordan Ribbink <[email protected]>

Addressed feedback

bjartek · 2023-10-26T14:41:38Z

internal/super/generate.go

+
+	filenameWithBasePath := filepath.Join(basePath, filename)
+
+	if _, err := os.Stat(filenameWithBasePath); err == nil {


flow-cli has the --save -s flag to save the output of a command to a file, do we need to have this logic here or can we just return the output and rely on that logic?

also state has a ReaderWriter that is used to save files and that is used elsewhere instead of os functions.

Hmm yeah I guess that means that you always have to provide --save. I was hoping to just always generate them to the correct folders unless specified otherwise. But it makes sense to keep the same pattern. Just really verbose now. Writing flow generate contract woohoo --save cadence/contracts/whoohoo.cdc is so long that I'd almost rather just write the cadence instead of use this command. Makes me want to kill this PR.

Imo just skip the pattern/flag here. I think think it's pretty obvious that this will be saving a file and using a flag for this is just redundant & a command like this is for ease of use so should be as shorthand as possible. I think the only purpose --save potentially has in this is as an override to the output path.

I'm fully in support for super short aliases here as well (i.e. flow g c FooBar)

Feel free to not use --save. But using ReaderWriter is recommended. I think it also creates required directories.

Yeah ReaderWriter is no problem. Good catch. Will change that @bjartek

jribbink · 2023-10-26T23:33:02Z

Also I think it would be cool if flow generate contract added a contract to flow.json automatically. It would make this tool super useful as it saves a bunch of steps making a new contract and significantly speeds up the time scaffolding a new project.

Additionally, there won't be any confusion about imports not being resolved when these contracts are referenced since they are automatically in the flow.json

bjartek · 2023-10-27T06:04:13Z

Totally agree on this. Would it be possible to optionally have it added to deployment section?

One pattern i use in flow.json is that my accounts are named on the form of network-role

So emulator-find, testnet-find, mainnet-find.

chasefleming · 2023-10-27T18:26:03Z

So here's what I think is a good route based on what you all said. Tell me if you agree @bjartek @jribbink :

Switch to ReaderWriter.
This feels like a slightly separate pattern and is meant for convenience so I think not using --save to avoid redundancy is fine here since the output is always to create a new file.
Let's not use flow g c Foo but I think the alias for generate is fine. I think flow gen contract Foo or flow g contract Foo might be nice.
Add the contract to flow.json upon creation.
Deployments sounds like a rabbit hole. Like if accounts for each network don't exist are we supposed to create the accounts as well? We already have flow config add deployment which has a nice interactive way of adding deployments to what networks and what accounts. How about we add a message at the end promoting that command and say use it to add deployments.

Thoughts?

bjartek · 2023-10-27T18:34:08Z

That works. It is always podsible to expand later.

chasefleming · 2023-10-27T21:35:22Z

@jribbink @bjartek I updated the PR to have the "g" alias and to save the contract to flow.json. I'm having some issues with the ReaderWriter. It doesn't actually create the directory on WriteFile so most of the code still needs to be there. And then the tests with it become tricky if I'm trying to check the directory actually have the file created. There are mocks but I'm still figuring out if it's possible to test that with the mocks.

bjartek · 2023-10-27T22:43:49Z

Ammend the code in ReaderWriter then?

chasefleming · 2023-10-28T17:30:36Z

@bjartek yep working on that next

bjartek

LGTM

chasefleming added 3 commits October 23, 2023 16:47

Add generate setup for templates

8bf521e

Add script and tx templates

d6a51ba

Generate at file path and add tests

86d6ea7

chasefleming added the Feature A new user feature or a new package API label Oct 24, 2023

chasefleming requested review from Kay-Zee, janezpodhostnik, sideninja, nvdtf and jribbink as code owners October 24, 2023 18:35

Update readme

9e8d8e7

gregsantos reviewed Oct 24, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Show resolved Hide resolved

bjartek requested changes Oct 24, 2023

View reviewed changes

jribbink reviewed Oct 24, 2023

View reviewed changes

internal/super/generate.go Outdated Show resolved Hide resolved

jribbink reviewed Oct 24, 2023

View reviewed changes

internal/super/generate.go Outdated Show resolved Hide resolved

internal/super/generate.go Outdated Show resolved Hide resolved

internal/super/generate.go Outdated Show resolved Hide resolved

bjartek requested changes Oct 25, 2023

View reviewed changes

internal/super/generate_test.go Show resolved Hide resolved

bjartek requested changes Oct 25, 2023

View reviewed changes

internal/super/generate.go Outdated Show resolved Hide resolved

bjartek previously requested changes Oct 25, 2023

View reviewed changes

internal/super/generate.go Outdated Show resolved Hide resolved

chasefleming and others added 8 commits October 25, 2023 10:05

Update README.md

54e52d6

Co-authored-by: Greg Santos <[email protected]>

Update internal/super/generate.go

8efa0c7

Co-authored-by: Jordan Ribbink <[email protected]>

Update internal/super/generate.go

06433cf

Co-authored-by: Jordan Ribbink <[email protected]>

Update internal/super/generate.go

d4aa5e5

Co-authored-by: Bjarte S. Karlsen <[email protected]>

Update internal/super/generate.go

f231c5e

Co-authored-by: Jordan Ribbink <[email protected]>

Update internal/super/generate_test.go

be0ae7d

Co-authored-by: Bjarte S. Karlsen <[email protected]>

Update internal/super/generate.go

d8df7a6

Co-authored-by: Bjarte S. Karlsen <[email protected]>

Add filepath import

a8cf73f

chasefleming requested a review from bluesign as a code owner October 25, 2023 17:10

chasefleming added 2 commits October 25, 2023 13:08

Fix test for tx gen

44ceeb8

Add init to contract template

0d4e0ec

Allow user to define directory for template gen

106ef48

chasefleming requested review from bjartek, jribbink and gregsantos October 25, 2023 21:11

jribbink approved these changes Oct 25, 2023

View reviewed changes

internal/super/generate.go Outdated Show resolved Hide resolved

internal/super/generate_test.go Outdated Show resolved Hide resolved

internal/super/generate_test.go Outdated Show resolved Hide resolved

internal/super/generate_test.go Outdated Show resolved Hide resolved

chasefleming and others added 4 commits October 25, 2023 14:26

Update internal/super/generate.go

3ce0087

Co-authored-by: Jordan Ribbink <[email protected]>

Update internal/super/generate_test.go

cff1357

Co-authored-by: Jordan Ribbink <[email protected]>

Update internal/super/generate_test.go

deb8540

Co-authored-by: Jordan Ribbink <[email protected]>

fix tests

d5f20ea

gregsantos approved these changes Oct 25, 2023

View reviewed changes

chasefleming added 2 commits October 25, 2023 16:30

Run goimports

3a2eec6

Fix golint error for Chdir

4dd7808

bjartek requested changes Oct 26, 2023

View reviewed changes

chasefleming added 3 commits October 27, 2023 14:19

Add alias

7b48f13

Save contract to flow.json

020da9f

Fix tests

d8ecd49

chasefleming added 3 commits October 30, 2023 11:57

Use readerwriter

5b076c4

Merge branch 'master' into chasefleming/generate-templates

19608ba

Add MkDirAll

2adf137

chasefleming requested a review from bjartek October 30, 2023 19:47

bjartek approved these changes Oct 30, 2023

View reviewed changes

chasefleming merged commit 800fb88 into master Oct 30, 2023
6 checks passed

chasefleming deleted the chasefleming/generate-templates branch October 30, 2023 21:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add generate templates command #1242

Add generate templates command #1242

chasefleming commented Oct 24, 2023 •

edited

Loading

gregsantos left a comment

codecov-commenter commented Oct 25, 2023 •

edited

Loading

jribbink left a comment

bjartek Oct 26, 2023

chasefleming Oct 26, 2023 •

edited

Loading

jribbink Oct 26, 2023

jribbink Oct 26, 2023

bjartek Oct 27, 2023

chasefleming Oct 27, 2023

jribbink commented Oct 26, 2023

bjartek commented Oct 27, 2023 •

edited

Loading

chasefleming commented Oct 27, 2023

bjartek commented Oct 27, 2023

chasefleming commented Oct 27, 2023

bjartek commented Oct 27, 2023

chasefleming commented Oct 28, 2023

bjartek left a comment


		filenameWithBasePath := filepath.Join(basePath, filename)

		if _, err := os.Stat(filenameWithBasePath); err == nil {

Add generate templates command #1242

Add generate templates command #1242

Conversation

chasefleming commented Oct 24, 2023 • edited Loading

gregsantos left a comment

Choose a reason for hiding this comment

codecov-commenter commented Oct 25, 2023 • edited Loading

Codecov Report

jribbink left a comment

Choose a reason for hiding this comment

bjartek Oct 26, 2023

Choose a reason for hiding this comment

chasefleming Oct 26, 2023 • edited Loading

Choose a reason for hiding this comment

jribbink Oct 26, 2023

Choose a reason for hiding this comment

jribbink Oct 26, 2023

Choose a reason for hiding this comment

bjartek Oct 27, 2023

Choose a reason for hiding this comment

chasefleming Oct 27, 2023

Choose a reason for hiding this comment

jribbink commented Oct 26, 2023

bjartek commented Oct 27, 2023 • edited Loading

chasefleming commented Oct 27, 2023

bjartek commented Oct 27, 2023

chasefleming commented Oct 27, 2023

bjartek commented Oct 27, 2023

chasefleming commented Oct 28, 2023

bjartek left a comment

Choose a reason for hiding this comment

chasefleming commented Oct 24, 2023 •

edited

Loading

codecov-commenter commented Oct 25, 2023 •

edited

Loading

chasefleming Oct 26, 2023 •

edited

Loading

bjartek commented Oct 27, 2023 •

edited

Loading