eclipse-xtext / eclipse-xtext/xtext
Deprecate the AbstractDeclarativeScopeProvider class
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 831
- Forks
- 330
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 12
Description
The usage of the org.eclipse.xtext.scoping.impl.AbstractDeclarativeScopeProvider class is discouraged, as stated out by @szarnekow in the EclipseCon France talk in 2017.
That's why the AbstractDeclarativeScopeProvider class should be deprecated in favor of the org.eclipse.xtext.scoping.impl.DelegatingScopeProvider class to encourage the users still using the "old way" to reimplement their scope provider.
That would bring the following benefits to the clients:
- It will be easier to debug, easier to understand, and depending on the language, it may gain performance improvements.
- Moreover it will also fix SonarQube issues in the custom ScopeProvider class: "Rename this method name to match the regular expression '^[a-z][a-zA-Z0-9]*, since the scoping methods do not need will not contain _ anymore.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked AbstractDeclarativeScopeProvider.java and DelegatingScopeProvider.java files, then search the repository for usages of AbstractDeclarativeScopeProvider. Review existing API compatibility and test conventions before making the deprecation change; done means the old class is clearly marked as deprecated in favor of DelegatingScopeProvider and the relevant Java tests or build checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- compilers
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100