-
Notifications
You must be signed in to change notification settings - Fork 0
Codama Dart Renderer: Docs, E2E Testing, #5
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
Open
ERoydev
wants to merge
35
commits into
dev
Choose a base branch
from
fix/array-borsh-length
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…lds for template rendering
…o handle fixed arrays
…x value). Now there are separate functions for fixed and prefixed arrays.
…/codama-dart into fix/array-borsh-length
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces comprehensive improvements to the Codama Dart renderer project, focusing on documentation, end-to-end (e2e) testing infrastructure, Dart code generation templates, and code quality tooling. The main changes include a new and detailed
README.md
, the addition of e2e testing scripts and Dart project setups, the introduction of Dart code generation templates using Nunjucks, and the setup of a TypeScript ESLint configuration.Summary of most important changes:
Documentation:
README.md
to provide clear installation, usage, example code, directory structure, and limitations for the Codama Dart renderer. This greatly improves onboarding and user understanding.End-to-End Testing Infrastructure:
pubspec.yaml
) for multiple test projects (dummy
,system
,memo
,meteora
,anchor
) to facilitate generated code validation. [1] [2] [3] [4] [5]generate.cjs
,generate-anchor.cjs
) for running codegen against specified projects, and atest.sh
script to automate code generation and static analysis, reporting errors in a user-friendly way. [1] [2] [3]Code Generation Templates:
layout.njk
), macros for Dart code patterns (macros.njk
), and account module exports (pages/accountsMod.njk
). These templates enable structured and maintainable Dart code output from IDL files. [1] [2] [3]Code Quality Tooling:
eslint.config.cjs
) with sensible rules for code consistency and error prevention in the codebase.