stdlib-js / stdlib-js/stdlib

[RFC]: add support for signature argument hints in the REPL

Open
#2,065 0 comments 0 reactions 0 assignees View on GitHub
difficulty: 3 Enhancement JavaScript Needs Discussion priority: Normal REPL RFC
Dominant language
JavaScript
Stars
6k
Forks
1.3k
Avg merge
1d 3h
Merged PRs (30d)
611

Description

### Description

This RFC proposes adding support for signature argument hints in the REPL. The idea is to extend the preview completion functionality introduced in https://github.com/stdlib-js/stdlib/pull/1832 to display function and method signatures (i.e., parameter lists), similar to what modern IDEs support when leveraging TypeScript declarations and JSDoc comments.

Once a user types `foo(`, modern IDEs can read, e.g., TypeScript overloads to display parameter hints (e.g., `foo(<|> beep: string, boop?: number )`, where `<|>` indicates the cursor. In this RFC, the proposal is that we should add similar support to the REPL where everything after the cursor would be greyed out text, similar to preview completions introduced in https://github.com/stdlib-js/stdlib/pull/1832. However, one key difference is that the signatures are purely to serve as hints; once a user begins typing a literal or identifier for a parameter, the hint for that parameter should disappear and normal TAB completion should be possible. After a user has finished and typed `,` in the example above, we'd display another hint for the second parameter.

We already have a database of signatures, as derived from TypeScript declarations (see https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/repl/signature). Currently, you can only see these signatures using the `info` command. In the REPL,

```
In [1]: info( typedarray )
```

will display a list of overloads and one line descriptions. We could potentially leverage the database to support signature argument hints.

### Related Issues

- https://github.com/stdlib-js/stdlib/pull/1832

### Questions

No.

### Other

No.

### Checklist

- [X] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [X] Searched for existing issues and pull requests.
- [X] The issue name begins with `RFC:`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.