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.

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

Build refactor #1546

Open
verytactical opened this issue Jan 23, 2025 · 2 comments · May be fixed by #1363
Open

Build refactor #1546

verytactical opened this issue Jan 23, 2025 · 2 comments · May be fixed by #1363
Labels
kind: refactoring Improve code readability misc: ecosystem Blueprint, Misti, Verifier, Web IDE, VSCode plugin scope: pipeline Stages of Tact compiler: parsing, ..., typechecking, codegen, etc. (src/pipeline)

Comments

@verytactical
Copy link
Contributor

verytactical commented Jan 23, 2025

@byakuren-hijiri: Document and refactor the frontend pipeline. Currently, the way the compiler prepares to calling the precompile function is quite convoluted. All the arguments of the functions used before precompile should be documented, we should extract small methods when possible, and document them, to make that API more useful for third-parties.

@byakuren-hijiri: Extract methods from the build function (src/pipeline/build.ts) to make it more modular. We need to separate the build functionality from CLI parsing and use different methods to create context, compile, and precompile. This is important to implement in order to enable third-party tools to hook into the compilation pipeline in the most flexible way. Perhaps, the best way to achieve this functionality is to create the Builder class with public methods defining the pipeline.

@verytactical verytactical added kind: refactoring Improve code readability misc: ecosystem Blueprint, Misti, Verifier, Web IDE, VSCode plugin scope: pipeline Stages of Tact compiler: parsing, ..., typechecking, codegen, etc. (src/pipeline) labels Jan 23, 2025
@novusnota
Copy link
Member

novusnota commented Jan 23, 2025

Great suggestion from the past, and it's already addressed here!

@verytactical verytactical linked a pull request Jan 23, 2025 that will close this issue
4 tasks
@verytactical
Copy link
Contributor Author

Thanks, I forgot to link it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: refactoring Improve code readability misc: ecosystem Blueprint, Misti, Verifier, Web IDE, VSCode plugin scope: pipeline Stages of Tact compiler: parsing, ..., typechecking, codegen, etc. (src/pipeline)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants