rescript-lang / rescript-lang/rescript

@deprecated decorator does only fully work in interfaces

Open
#5,335 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
OCaml
Stars
7.5k
Forks
485
Avg merge
1d 2h
Merged PRs (30d)
55

Description

See playground Link

@deprecated does only seem to work for types in .res files. Only in an interface it also works for functions and modules.

This example suggests otherwise: https://rescript-lang.org/syntax-lookup#expression-deprecated-decorator

As a bindings library author it would make sense to support it in .res files as well, since bindings tend to look nearly identical in .res and .resi.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked playground example and compare @deprecated behavior for types, functions, and modules in .res files versus .resi interfaces. Read the syntax-lookup entry for the expression deprecated decorator. Done means the decorator works consistently for the relevant declarations in .res files, matching the documented behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
compilers
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.