Skip to content

Initial architecture documentation for bytecompiler module #4757

Open
JkrishnaD wants to merge 1 commit intoboa-dev:mainfrom
JkrishnaD:docs/bytecompiler
Open

Initial architecture documentation for bytecompiler module #4757
JkrishnaD wants to merge 1 commit intoboa-dev:mainfrom
JkrishnaD:docs/bytecompiler

Conversation

@JkrishnaD
Copy link
Contributor

This Pull Request fixes/closes #1608 .

This PR adds initial high-level module documentation for the bytecompiler,
which mainly focusing on:

  • Overall compilation architecture
  • Module organization
  • Relationship to the VM

This is intended as a starting point to discuss structure and scope for further documentation improvements.

@JkrishnaD JkrishnaD requested a review from a team as a code owner February 28, 2026 11:52
@JkrishnaD
Copy link
Contributor Author

@jedel1043 as we discussed in issue #1608. I've made a pr with initial documentation for the bytecompiler.

Let me know that if there any changes needed here. so that we can move forward from there

@github-actions
Copy link

Test262 conformance changes

Test result main count PR count difference
Total 52,862 52,862 0
Passed 49,505 49,505 0
Ignored 2,261 2,261 0
Failed 1,096 1,096 0
Panics 0 0 0
Conformance 93.65% 93.65% 0.00%

@codecov
Copy link

codecov bot commented Feb 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.05%. Comparing base (6ddc2b4) to head (93bbd90).
⚠️ Report is 704 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4757      +/-   ##
==========================================
+ Coverage   47.24%   57.05%   +9.81%     
==========================================
  Files         476      552      +76     
  Lines       46892    60568   +13676     
==========================================
+ Hits        22154    34559   +12405     
- Misses      24738    26009    +1271     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@jedel1043 jedel1043 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs are looking great! It might just need a bit more detail

Copy link
Member

@jedel1043 jedel1043 Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good so far, but you only mentioned what the bytecompiler does, not how it does it.

  • Is it register based, stack based or other type?
  • Does it use a string interner?
  • How does it resolve bindings and environments?
  • What about async? Does it lower async/generators to state machines or to some other execution model?
  • etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah sure i'll add about all these

@jedel1043 jedel1043 added documentation update documentation vm Issues and PRs related to the Boa Virtual Machine. waiting-on-author Waiting on PR changes from the author labels Feb 28, 2026
@jedel1043 jedel1043 added this to the v1.0.0 milestone Feb 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation update documentation vm Issues and PRs related to the Boa Virtual Machine. waiting-on-author Waiting on PR changes from the author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Bytecompiler

2 participants