dspace-angular icon indicating copy to clipboard operation
dspace-angular copied to clipboard

Custom ESLint: Keep themed component registry up to date when running in an IDE

Open ybnd opened this issue 1 year ago • 2 comments

TODO

  • [ ] Solve Error: The operation was canceled. issue in CI
  • [ ] Test with VSCode
  • [ ] Write unit tests (if possible?)
  • [ ] Resolve overlap with oter recent ESLint PRs (if applicable)
  • [ ] Complete PR

References

Add references/links to any related issues or PRs

Description

When the ESLint runs in an IDE service, registries used to remain fixed and rules could not respond to changes (e.g. if a new component is made themeable) until the IDE is restarted.

This PR introduces a file watcher to register/unregister components on the fly.

Every time you edit an existing Themed*Component or create/delete one, the registry will be updated, which will have an immediate effect on ESLint warnings.

https://github.com/user-attachments/assets/91fc4115-c7de-4c46-958f-89f8378d8f5f

Instructions for Reviewers

Please add a more detailed description of the changes made by your PR

Include guidance for how to test or review your PR.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome). However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • [ ] My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • [ ] My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • [ ] My PR passes ESLint validation using npm run lint
  • [ ] My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • [ ] My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • [ ] My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • [ ] My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • [ ] My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • [ ] My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • [ ] If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • [ ] If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • [ ] If my PR fixes an issue ticket, I've linked them together.

ybnd avatar Oct 11 '24 10:10 ybnd

Hi @ybnd, Conflicts have been detected against the base branch. Please resolve these conflicts as soon as you can. Thanks!

github-actions[bot] avatar Oct 16 '24 16:10 github-actions[bot]

Hi @ybnd, Conflicts have been detected against the base branch. Please resolve these conflicts as soon as you can. Thanks!

github-actions[bot] avatar Oct 24 '24 20:10 github-actions[bot]