vert-x3 / vert-x3/vertx-shell

Add a way to enable/disable echo in TermImpl echoHandler

Open
#60 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
39
Forks
19
PR merge metrics
No merged PRs in 30d

Description

Read me

Read this first before creating an issue:

  • do not use this issue tracker to ask questions, instead use one of these channels. Questions will likely be closed without notice.
  • you shall create a feature request only when it is general purpose enough.
  • make sure that the feature is not already
Describe the feature

Allow enable/disable echoing input characters back to the remote client.

Use cases

This allows temporarily disabling echo, for example to input a password, without replacing echoHandler and losing built-in readline functionality.

Contribution

Proposed implementation in TermImpl.java:

  • Add a new class field:
  private boolean echoOn = true;
  • Add an if block in the constructor:
    echoHandler = codePoints -> {
      // Echo
      if (echoOn) {
        echo(codePoints);
      }
      readline.queueEvent(codePoints);
    };
  • Add a setter:
  public void setEchoOn(boolean echoOn) {
    this.echoOn = echoOn;
  }

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 in TermImpl.java and inspect the echoHandler in its constructor. Add a way to toggle echoing without replacing the handler, while preserving readline event queuing. Done means input echo can be enabled or disabled for cases such as password entry.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.