stdlib-js / stdlib-js/stdlib

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

Offen
#2,065 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
difficulty: 3 Enhancement JavaScript Needs Discussion priority: Normal REPL RFC
Vorherrschende Sprache
JavaScript
Sterne
6k
Forks
1.3k
Ø Merge
1 T. 3 Std.
Gemergte PRs (30 T.)
611

Beschreibung

### 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:`.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.