developing extension(part 1)

[technophile-04]

Developer extension flow:

1. Developer clones the create-eth repo
   1.5) run yarn build:dev => (this scripts create cli.js and create-extension.js ins dist dir)
2. Run yarn cli => (runs dist/cli.js)
   • The project path base name which developer mentions will be the extension name
   • example: ../my-instance => extension name will be "my-instance"
3. Developer starts adding stuff to "my-instance" for example:
   • create a new page my-instance/packages/nextjs/app/my-page/page.tsx
   • commits that changes in "my-instance" repo
4. Now to create extension, developer need to run yarn create-extension ${instancePath} => runs dist/create-extension
   • Example: yarn create-extension ../my-instance
   • The above commands gets all the file changed/added in my-instance repo and create extension
     in create-eth/externalExtensions/${extensionName} following same hierarchy compliant with external extensions
5. If the developer does some changes to files which are templates(for example Header.tsx), we log him warning that he needs to create corresponding Header.tsx.args.mjs manually in extenalExtensions
   • Regarding package.json we will be copying them completely if changed, since package.json are merged so common fields will be managed and new added package will also be added(the extension package.json will replace the version if it clashes with base)
6. Developer repeats 4th step in cycle, commits in extension instance and then yarn create-extension ${instancePath}
7. To do actual test with his extension, he will do phase 2 of Developing external extensions (v0.1) #57 (comment)
8. Once user is satisfied he cd's into his created extension dir for example externalExtensions/${extensionName} and push that repo to github, which then can be used by others

[rin-st]

Thanks Shiv! Great changes! 👍 It makes developing of extension much easier! I left some comments, and also

• Regarding package.json we will be copying them completely if changed, since package.json are merged so common fields will be managed and new added package will also be added(the extension package.json will replace the version if it clashes with base)

I think it's not good since in create-eth we will update packages, but not sure about all the extensions. So if extension is old, it will overwrite newest packages of create-eth. So I think it's better to skip package.json too and write to console that package.json should be also written manually with only additional libs

8. Once user is satisfied he cd's into his created extension dir for example externalExtensions/${extensionName} and push that repo to github, which then can be used by others

You mean push that folder to github? Since there is no repo there

[damianmarti]

Great work @technophile-04 !! And good comments from @rin-st!

I'm working on the Ponder extension, so I will test this with that, and get back to you with comments and feedback!

[technophile-04]

So if extension is old, it will overwrite newest packages of create-eth. So I think it's better to skip package.json too and write to console that package.json should be also written manually with only additional libs

Yeah agree, pushed some changes to handle this. So currently if the package.json overlaps Solidity-frameworks package.json OR root package.json OR nextjs package.json we don't copy them and print info warning, But if the users want to add new package to monorepo(for example subgraph) then I we should copy it completely

You mean push that folder to github? Since there is no repo there

yes

[rin-st]

Thank you for updates! Great job!

[carletex]

This is looking great!!! Thanks Shiv + Rinat for the review!

As Damu, I'll also be testing this during the week

[technophile-04]

coreFiles: Files which belong to solidity frameworks OR base dir. Something we should be clear about in docs.

Was discussing with Carlos about it and found a bug where we were copying coreFiles as well. Just pushed a commit at f2cf80c which avoids it and log an warning regarding it.

[damianmarti]

@technophile-04 I was able to create the Ponder extension following the directions from this PR and #57 and everything worked great!!!

https://github.com/damianmarti/ponder-se2-extension This is the extension created, I have to add the READMEs, I will do it on Monday.

I have only two comments:

Maybe it will be useful to be able to add items to scaffoldConfig. I wanted to add a ponderURL there and ended up using a process.env var directly, but I think it's better if we can have all this kind of config on the scaffoldConfig file.

At first, I got some errors when I ran yarn cli (issues with my extension code), and the application was created anyway. And then I have to delete the folder to be able to run it again. Maybe, the cli can delete the created app folder if there is any error.

Awesome job!!!

[carletex]

This is looking great @technophile-04

Thank you for tackling all open "issues" that we discussed.

[carletex]

Should we merge this?

[technophile-04]

Ohh actually we thought merging the doc too in this PR #84 (comment)

But maybe we can merge and iterate more on doc in that PR?

[carletex]

Ok sure! In my head we could merge this since it doesn't affect users... but both things work for me!

[technophile-04]

In my head we could merge this since it doesn't affect users... but both things work for me!

Yup merging this, we could also play around with this more and update #84