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

Enable the rename plugin on single component projects #2804

Closed
pepeiborra opened this issue Mar 27, 2022 · 5 comments · Fixed by #2809
Closed

Enable the rename plugin on single component projects #2804

pepeiborra opened this issue Mar 27, 2022 · 5 comments · Fixed by #2809

Comments

@pepeiborra
Copy link
Collaborator

Currently the rename plugin is disabled (and hence, not linked to the distributed binary) because it doesn't work reliably on multi-component projects (this is not the plugin's fault, but rather HLS / hie-bios).

While there is work being done to address this, it's been almost a year since the plugin was contributed, and we regularly get requests for the functionality. So it would be nice to enable the plugin at least in single component projects.

@pepeiborra
Copy link
Collaborator Author

/cc @OliverMadine

@OliverMadine
Copy link
Collaborator

OliverMadine commented Mar 27, 2022

I think this is reasonable. The issue is that the plugin currently partially performs renames for multi-component projects. If we enable it for single component projects, I think we need either:

  1. a good way of letting the user know of this limitation (maybe in settings when they enable it).
  2. to restrict the renames to a single component (for consistent partial behaviour).
  3. to block renaming entirely if the user is working within a multi-component project (do we have reliable way of knowing this?)

@michaelpj
Copy link
Collaborator

Yeah, I think if we could just fail informatively in the unsupported setting, that might be fine.

@michaelpj
Copy link
Collaborator

Although, to be clear, a package with a test suite is a "multi-component project", right? So would this in practice rule out essentially all users?

@OliverMadine
Copy link
Collaborator

Although, to be clear, a package with a test suite is a "multi-component project", right? So would this in practice rule out essentially all users?

Yes, I think the second option that I listed would be the preferred behaviour then?

In the case of a package with a test suite, we would perform the rename within the single-component (i.e. excluding the test suite). We could also warn the user that the rename was only performed across one component (if they are in a multi-component project).

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 a pull request may close this issue.

3 participants