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

Bindings API review and pending issues #1109

Open
8 tasks
ggiraldez opened this issue Sep 26, 2024 · 0 comments
Open
8 tasks

Bindings API review and pending issues #1109

ggiraldez opened this issue Sep 26, 2024 · 0 comments
Assignees

Comments

@ggiraldez
Copy link
Collaborator

ggiraldez commented Sep 26, 2024

We have some small pending tasks related to the Bindings API.

  • Make sure that any Bindings internal context/data is updated whenever a new file is added.
    • @OmarTawfik: assuming this has a perf impact, our latest v1 design can also make sure all files are loaded first THEN create Bindings once and for all, so we don't need to recalculate this multiple times.
  • Document new graph attributes and their usage
  • Move lookup_definition_by_name to the test modules
  • Rename jump_to_definition to resolve_definition (or resolve_reference?)
    • @OmarTawfik: my 2c: I suggest resolve_definition() or get_definition(), as it is a function of the reference, which the user already has/already resolved. What is yet to be resolved/retrieved is the definition.
  • Cache pre-parsed bindings rules and built-ins per language version
  • Output Mermaid and/or Graphviz .dot generated files under the target directory (rationale: they're only generated locally and for debugging purpose and are not tracked by Git, which may cause compilation failures when switching branches)
    • @OmarTawfik: assuming they have a perf impact on test execution, I suggest only generating them if a certain env variable was set, so that they don't affect us in 99% of the times the tests run...
  • disable collecting "debugging information" when building the graph, unless an env var is explicitly provided. We can set locally for debugging.
  • Add a few tests to make sure bindings are still calculated successfully in the presence of syntax errors/partial input.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ⏳ Todo
Development

No branches or pull requests

1 participant