Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readline,repl: add substring history search #31112

Closed
wants to merge 14 commits into from
Closed

readline,repl: add substring history search #31112

wants to merge 14 commits into from
+587 −301

Conversation

BridgeAR
Copy link
Member

@BridgeAR BridgeAR commented Dec 27, 2019 •
edited
Loading

Please see the individual commit messages for details.

Fixes: #28437
Fixes: #25272

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added readline Issues and PRs related to the built-in readline module. repl Issues and PRs related to the REPL subsystem. labels Dec 27, 2019
@BridgeAR BridgeAR force-pushed the 2019-12-27-repl-substring-history-search branch 2 times, most recently from 5b21b6c to a36f1a8 Compare January 4, 2020 08:44
@BridgeAR BridgeAR marked this pull request as ready for review January 4, 2020 11:14
@BridgeAR
Copy link
Member Author

BridgeAR commented Jan 4, 2020

@nodejs/repl @nodejs/readline PTAL. I included a couple of smaller things that are all somewhat connected. I can split this into multiple PRs if requested.

This

  • adds substring history search,
  • improves unicode support,
  • adds support for tabs,
  • improves previews of very long input,
  • refactors code for simplicity and
  • improves the performance of the GetColumnWidth function for some inputs.

@nodejs-github-bot

This comment has been minimized.

Sign in to view
addaleax
addaleax reviewed Jan 5, 2020
View reviewed changes
doc/api/repl.md Outdated Show resolved Hide resolved
doc/api/repl.md Outdated Show resolved Hide resolved
lib/internal/repl/utils.js Outdated Show resolved Hide resolved
src/node_i18n.cc Show resolved Hide resolved
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@BridgeAR BridgeAR force-pushed the 2019-12-27-repl-substring-history-search branch from 97ecd26 to 6c73393 Compare January 8, 2020 09:57
@BridgeAR
repl: improve preview length calculation
05c19bd 
The preview had an off by one error in case colors where deactivated
and did not take fullwidth unicode characters into account when
displaying the preview.
@BridgeAR
readline,repl: add substring based history search
470e87f 
This improves the current history search feature by adding substring
based history search similar to ZSH. In case the `UP` or `DOWN`
buttons are pressed after writing a few characters, the start string
up to the current cursor is used to search the history.

All other history features work exactly as they used to.

Fixes: nodejs#28437
@BridgeAR
readline,repl: skip history entries identical to the current line
6efc2b9 
Skip history entries that are identical to the currently visible line
to improve the user experience.
@BridgeAR
readline,repl: improve history up/previous
5a213fe 
Reaching the history end caused the last entry to be persistent.
That way there's no actualy feedback to the user that the history
end is reached. Instead, visualize the original input line and keep
the history index at the history end in case the user wants to go
back again.
@BridgeAR BridgeAR force-pushed the 2019-12-27-repl-substring-history-search branch from 6c73393 to 9e958f3 Compare January 8, 2020 11:00
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@BridgeAR
readline: simplify getStringWidth()
3b8315c 
Simplify getStringWidth by removing dead code (the options were
unused) and by refactoring the logic.
@BridgeAR
readline: move charLengthLeft() and charLengthAt()
d6b1bac 
This moves the charLengthLeft() and charLengthAt() into the internal
readline file. This allows sharing the functions internally with
other code.
@BridgeAR
src: improve GetColumnWidth performance
9f7730e 
This improves the performance in GetColumnWidth for full width
characters.
@BridgeAR
src: change GetStringWidth's expand_emoji_sequence option default
e9bc956 
The option is now set to true by default. Most terminals do not have
full emoji support and visualize emojis with zero width joiners as
individual emojis.
Also verify that at least one argument is always passed through to the
function and remove support for passing through code points. Only
accept strings from now on to simplify the API.
@BridgeAR
readline,repl: support tabs properly
6dd223b 
Fixes: nodejs#25272
@BridgeAR
repl: activate previews for lines exceeding the terminal columns
26d4643 
This improves the completion previews by activating them for lines
that exceed the current terminal columns.
As a drive-by fix it also simplifies some statements.
@BridgeAR
test: add repl tests to verify unicode support in previews
387a327 
This also adds a test to verify that changed writer options also
change the preview output depending on the options.
@BridgeAR
util: add todo comments for inspect to add unicode support
9f5aa54
@targos targos added semver-minor PRs that contain new features and should be released in the next minor version. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backport-requested-v12.x labels Apr 25, 2020
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
repl: improve preview length calculation
f66bcda 
The preview had an off by one error in case colors where deactivated
and did not take fullwidth unicode characters into account when
displaying the preview.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
readline,repl: add substring based history search
bf62a83 
This improves the current history search feature by adding substring
based history search similar to ZSH. In case the `UP` or `DOWN`
buttons are pressed after writing a few characters, the start string
up to the current cursor is used to search the history.

All other history features work exactly as they used to.

PR-URL: nodejs#31112
Fixes: nodejs#28437
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
readline,repl: skip history entries identical to the current line
cb0a321 
Skip history entries that are identical to the currently visible line
to improve the user experience.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
readline,repl: improve history up/previous
fde18ac 
Reaching the history end caused the last entry to be persistent.
That way there's no actualy feedback to the user that the history
end is reached. Instead, visualize the original input line and keep
the history index at the history end in case the user wants to go
back again.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
readline: improve getStringWidth()
7163b1e 
1. Simplify the getStringWidth function used by Intl builds by removing
   dead code (the options were unused) and by refactoring the logic.
2. Improve the getStringWidth unicode handling used by non-Intl builds.
   The getStringWidth function returned the wrong width for multiple
   inputs. It's now improved by supporting various zero width characters
   and more full width characters.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
readline: move charLengthLeft() and charLengthAt()
1818611 
This moves the charLengthLeft() and charLengthAt() into the internal
readline file. This allows sharing the functions internally with
other code.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
src: improve GetColumnWidth performance
e4b5719 
This improves the performance in GetColumnWidth for full width
characters.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
src: change GetStringWidth's expand_emoji_sequence option default
689bcd1 
The option is now set to true by default. Most terminals do not have
full emoji support and visualize emojis with zero width joiners as
individual emojis.
Also verify that at least one argument is always passed through to the
function and remove support for passing through code points. Only
accept strings from now on to simplify the API.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
readline,repl: support tabs properly
50a16ed 
PR-URL: nodejs#31112
Fixes: nodejs#25272
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
repl: activate previews for lines exceeding the terminal columns
bdaf197 
This improves the completion previews by activating them for lines
that exceed the current terminal columns.
As a drive-by fix it also simplifies some statements.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
test: add repl tests to verify unicode support in previews
bc731a8 
This also adds a test to verify that changed writer options also
change the preview output depending on the options.

PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@BridgeAR @targos
util: add todo comments for inspect to add unicode support
5d8ae61 
PR-URL: nodejs#31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
repl: improve preview length calculation
a892b4d 
The preview had an off by one error in case colors where deactivated
and did not take fullwidth unicode characters into account when
displaying the preview.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
readline,repl: add substring based history search
d7e153b 
This improves the current history search feature by adding substring
based history search similar to ZSH. In case the `UP` or `DOWN`
buttons are pressed after writing a few characters, the start string
up to the current cursor is used to search the history.

All other history features work exactly as they used to.

PR-URL: #31112
Fixes: #28437
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
readline,repl: skip history entries identical to the current line
a0eb3e4 
Skip history entries that are identical to the currently visible line
to improve the user experience.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
readline,repl: improve history up/previous
cf28afe 
Reaching the history end caused the last entry to be persistent.
That way there's no actualy feedback to the user that the history
end is reached. Instead, visualize the original input line and keep
the history index at the history end in case the user wants to go
back again.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
readline: improve getStringWidth()
03efa71 
1. Simplify the getStringWidth function used by Intl builds by removing
   dead code (the options were unused) and by refactoring the logic.
2. Improve the getStringWidth unicode handling used by non-Intl builds.
   The getStringWidth function returned the wrong width for multiple
   inputs. It's now improved by supporting various zero width characters
   and more full width characters.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
readline: move charLengthLeft() and charLengthAt()
5231c84 
This moves the charLengthLeft() and charLengthAt() into the internal
readline file. This allows sharing the functions internally with
other code.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
src: improve GetColumnWidth performance
4f6300f 
This improves the performance in GetColumnWidth for full width
characters.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
src: change GetStringWidth's expand_emoji_sequence option default
f3fb6a1 
The option is now set to true by default. Most terminals do not have
full emoji support and visualize emojis with zero width joiners as
individual emojis.
Also verify that at least one argument is always passed through to the
function and remove support for passing through code points. Only
accept strings from now on to simplify the API.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
readline,repl: support tabs properly
4e9e440 
PR-URL: #31112
Fixes: #25272
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
repl: activate previews for lines exceeding the terminal columns
a4ca378 
This improves the completion previews by activating them for lines
that exceed the current terminal columns.
As a drive-by fix it also simplifies some statements.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
test: add repl tests to verify unicode support in previews
5e5d053 
This also adds a test to verify that changed writer options also
change the preview output depending on the options.

PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 28, 2020
@BridgeAR @targos
util: add todo comments for inspect to add unicode support
a0b1a06 
PR-URL: #31112
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@targos targos mentioned this pull request May 2, 2020
Merged
@todo todo bot mentioned this pull request May 26, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@targos targos targos approved these changes

@jasnell jasnell jasnell approved these changes

@Trott Trott Awaiting requested review from Trott

@benjamingr benjamingr Awaiting requested review from benjamingr

@srl295 srl295 Awaiting requested review from srl295

@addaleax addaleax Awaiting requested review from addaleax

Assignees
No one assigned
Labels
readline Issues and PRs related to the built-in readline module. repl Issues and PRs related to the REPL subsystem. semver-minor PRs that contain new features and should be released in the next minor version.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

repl: substring based search history Tabs in the repl cause display issues
6 participants
@BridgeAR @nodejs-github-bot @targos @codebytere @jasnell @addaleax