Skip to content

Conversation

@Process-ing
Copy link
Contributor

Description

This PR adds instructions to the README to run the package in a development environment, complementing the current one for Clava-JS.

@Process-ing Process-ing changed the title Add development environment setup Add Development Environment Setup Feb 17, 2025
{
"type": "module",
"workspaces": [
"clava/Clava-JS",
Copy link
Member

Choose a reason for hiding this comment

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

Wondering if we need Clava-JS in development mode, or if we could just use a version in NPM. Was this on purpose?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that it should be possible. I included this approach because the developer will also probably work with the standard LARA and Clava repositories, but this shouldn't be a limitation. Do you think I should also include a section for working with the NPM packages of Clava-JS?

Copy link
Member

Choose a reason for hiding this comment

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

In the best case scenario, this is a standalone library that does not need to change the internals of Clava or LARA. However, this library in particuly might be dependant of Clava's internals, how was your experience developing the library, do you find it useful to have the source code of both Clava and LARA?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In my case, I only used the LARA and Clava repositories to get a closer notion of the API, I did not strictly need to change anything in their code. However, I don't think this will be the general case, as most people will probably use the visualization tool when working with the other repositories.
Nonetheless, it can be useful for some that are making other changes for this tool only, so I will try to add this setup option in this guide (if possible).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants