Proposal to deprecate prototype features
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reviewing the implementations and usage of the prototype rb, rbi, and runtime features, along with the referenced issues and pull request. Check how Ripper, RubyVM::AbstractSyntaxTree, and rbs-inline relate to these features. Done means an agreed deprecation warning plan for rbs v4 and removal plan for v5, while deciding whether runtime remains for internal core and stdlib use.
Written by the indexing model from the issue text.
Description
RBS has 3 prototype features. I propose to stop maintaining all of them and eventually deprecate them.
Issues
Implementation as Experimental Features
All three prototypes (rb, rbi, runtime) use Ripper or RubyVM::AbstractSyntaxTree.
Both Ripper and RubyVM::AbstractSyntaxTree are experimental features, and their deprecation has also been proposed.
Decreasing Use Cases
rb
The rbs-inline gem almost entirely covers the prototype rb functionality and is planned to be integrated into the rbs repo in rbs v4. It is expected that prototype rb will no longer be used.
rbi
The rbi feature has served its purpose and is likely no longer in use.
runtime
The runtime feature lacks sufficient functionality for use in large-scale codebases like applications, and for simple use cases, rbs-inline is often sufficient.
Deprecation Method
I propose to issue a warning for prototype features starting with rbs v4, indicating they are slated for deprecation, and to completely remove them in v5.
The runtime feature may still have uses for expanding type definitions in core and stdlib, so it is highly likely to remain for internal use within the rbs repository.
Refs
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 263
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 64
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from ruby/rbs
-
InlineParser: `@rbs @ivar` annotation is reported as unused unless it is the first thing in the class bodyPossibly taken @ksss claimed this 50 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
Maintainers usually reply within 1 day
Similar issues
-
needs verification
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 13 days
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
betagouv/conseillers-entreprises#4808 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
yosiat/panko_serializer#250 ·