repl: add help() function for interactive introspection#64479
Open
hemanth wants to merge 2 commits into
Open
Conversation
Add a built-in help() function to the REPL context that provides
Python-like interactive introspection:
- help() Show REPL commands, shortcuts, and usage guide
- help(fn) Show function kind, name, parameters, arity, and
prototype methods for classes
- help(obj) Categorize object's own properties into Methods,
Accessors, and Properties with prototype chain info
- help(value) Show type and value for primitives, null, undefined
The function uses util.styleText for colorized output (respects
NO_COLOR and terminal capabilities). Typing 'help' without parens
shows a custom inspect hint.
The help function is added as a non-enumerable property on the REPL
context so it doesn't pollute tab-completion of user variables.
It survives .clear (context reset).
Refs: nodejs#51763
Signed-off-by: hemanth <hemanth.hm@gmail.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #64479 +/- ##
==========================================
- Coverage 90.24% 90.24% -0.01%
==========================================
Files 741 741
Lines 241665 241927 +262
Branches 45543 45600 +57
==========================================
+ Hits 218092 218320 +228
- Misses 15105 15129 +24
- Partials 8468 8478 +10
🚀 New features to boost your workflow:
|
Add test cases for uncovered branches: - GeneratorFunction and AsyncGeneratorFunction kinds - Anonymous functions (no .name) - Arrow functions (no .prototype) - Objects with getter/setter accessors - Prototype chain display for subclassed instances - Error handling for objects that throw on property access - useColors=true path exercising styleText
bbcbd69 to
8d989cb
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a built-in
help()function to the REPL context that provides Python-like interactive introspection.Usage
Implementation Details
help()— Shows all REPL commands, keyboard shortcuts, and usage hintshelp(fn)— Shows function kind (Function/AsyncFunction/GeneratorFunction/Class), name, parameters, arity, and prototype methodshelp(obj)— Categorizes own properties into Methods, Accessors, and Properties; shows prototype chainhelp(value)— Shows type + value for primitives, null, undefinedutil.styleTextfor colorized output (respectsNO_COLOR)helpwithout parens shows a custom inspect hint.clear(context reset)Refs: #51763